onfido 2.8.0 → 3.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (377) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +15 -4
  3. data/Gemfile +5 -4
  4. data/LICENSE +5 -7
  5. data/README.md +69 -51
  6. data/Rakefile +10 -0
  7. data/lib/onfido/api/default_api.rb +4233 -0
  8. data/lib/onfido/api_client.rb +431 -0
  9. data/lib/onfido/api_error.rb +58 -0
  10. data/lib/onfido/configuration.rb +420 -0
  11. data/lib/onfido/models/address.rb +422 -0
  12. data/lib/onfido/models/address_builder.rb +422 -0
  13. data/lib/onfido/models/address_shared.rb +415 -0
  14. data/lib/onfido/models/addresses_list.rb +216 -0
  15. data/lib/onfido/models/applicant.rb +390 -0
  16. data/lib/onfido/models/applicant_builder.rb +358 -0
  17. data/lib/onfido/models/applicant_create.rb +281 -0
  18. data/lib/onfido/models/applicant_request.rb +232 -0
  19. data/lib/onfido/models/applicant_response.rb +341 -0
  20. data/lib/onfido/models/applicant_shared.rb +246 -0
  21. data/lib/onfido/models/applicant_update.rb +267 -0
  22. data/lib/onfido/models/applicant_updater.rb +344 -0
  23. data/lib/onfido/models/applicants_list.rb +223 -0
  24. data/lib/onfido/models/check.rb +419 -0
  25. data/lib/onfido/models/check_builder.rb +360 -0
  26. data/lib/onfido/models/check_request.rb +301 -0
  27. data/lib/onfido/models/check_response.rb +350 -0
  28. data/lib/onfido/models/check_shared.rb +266 -0
  29. data/lib/onfido/models/checks_list.rb +223 -0
  30. data/lib/onfido/models/complete_task_builder.rb +221 -0
  31. data/lib/onfido/models/complete_task_data_builder.rb +106 -0
  32. data/lib/onfido/models/consent_item.rb +272 -0
  33. data/lib/onfido/models/consents_builder.rb +205 -0
  34. data/lib/onfido/models/country_codes.rb +289 -0
  35. data/lib/onfido/models/device_intelligence_breakdown.rb +223 -0
  36. data/lib/onfido/models/device_intelligence_breakdown_breakdown.rb +214 -0
  37. data/lib/onfido/models/device_intelligence_breakdown_breakdown_device.rb +215 -0
  38. data/lib/onfido/models/device_intelligence_breakdown_breakdown_device_breakdown.rb +232 -0
  39. data/lib/onfido/models/device_intelligence_breakdown_properties.rb +232 -0
  40. data/lib/onfido/models/device_intelligence_breakdown_properties_device.rb +468 -0
  41. data/lib/onfido/models/device_intelligence_breakdown_properties_geolocation.rb +257 -0
  42. data/lib/onfido/models/device_intelligence_breakdown_properties_ip.rb +245 -0
  43. data/lib/onfido/models/device_intelligence_report.rb +345 -0
  44. data/lib/onfido/models/document.rb +376 -0
  45. data/lib/onfido/models/document_breakdown.rb +286 -0
  46. data/lib/onfido/models/document_breakdown_age_validation.rb +224 -0
  47. data/lib/onfido/models/document_breakdown_age_validation_breakdown.rb +214 -0
  48. data/lib/onfido/models/document_breakdown_compromised_document.rb +224 -0
  49. data/lib/onfido/models/document_breakdown_compromised_document_breakdown.rb +223 -0
  50. data/lib/onfido/models/document_breakdown_data_comparison.rb +224 -0
  51. data/lib/onfido/models/document_breakdown_data_comparison_breakdown.rb +277 -0
  52. data/lib/onfido/models/document_breakdown_data_comparison_breakdown_issuing_country.rb +223 -0
  53. data/lib/onfido/models/document_breakdown_data_consistency.rb +224 -0
  54. data/lib/onfido/models/document_breakdown_data_consistency_breakdown.rb +295 -0
  55. data/lib/onfido/models/document_breakdown_data_validation.rb +224 -0
  56. data/lib/onfido/models/document_breakdown_data_validation_breakdown.rb +268 -0
  57. data/lib/onfido/models/document_breakdown_data_validation_breakdown_document_expiration.rb +224 -0
  58. data/lib/onfido/models/document_breakdown_data_validation_breakdown_expiry_date.rb +224 -0
  59. data/lib/onfido/models/document_breakdown_image_integrity.rb +224 -0
  60. data/lib/onfido/models/document_breakdown_image_integrity_breakdown.rb +241 -0
  61. data/lib/onfido/models/document_breakdown_image_integrity_breakdown_colour_picture.rb +224 -0
  62. data/lib/onfido/models/document_breakdown_image_integrity_breakdown_conclusive_document_quality.rb +224 -0
  63. data/lib/onfido/models/document_breakdown_image_integrity_breakdown_image_quality.rb +224 -0
  64. data/lib/onfido/models/document_breakdown_image_integrity_breakdown_supported_document.rb +224 -0
  65. data/lib/onfido/models/document_breakdown_issuing_authority.rb +224 -0
  66. data/lib/onfido/models/document_breakdown_issuing_authority_breakdown.rb +223 -0
  67. data/lib/onfido/models/document_breakdown_issuing_authority_breakdown_nfc_active_authentication.rb +224 -0
  68. data/lib/onfido/models/document_breakdown_issuing_authority_breakdown_nfc_passive_authentication.rb +224 -0
  69. data/lib/onfido/models/document_breakdown_police_record.rb +215 -0
  70. data/lib/onfido/models/document_breakdown_visual_authenticity.rb +224 -0
  71. data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown.rb +277 -0
  72. data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown_digital_tampering.rb +224 -0
  73. data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown_face_detection.rb +224 -0
  74. data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown_fonts.rb +224 -0
  75. data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown_original_document_present.rb +224 -0
  76. data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown_other.rb +224 -0
  77. data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown_picture_face_integrity.rb +224 -0
  78. data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown_security_features.rb +224 -0
  79. data/lib/onfido/models/document_breakdown_visual_authenticity_breakdown_template.rb +224 -0
  80. data/lib/onfido/models/document_cdq_reasons.rb +285 -0
  81. data/lib/onfido/models/document_iq_reasons.rb +305 -0
  82. data/lib/onfido/models/document_odp_reasons.rb +245 -0
  83. data/lib/onfido/models/document_properties.rb +461 -0
  84. data/lib/onfido/models/document_properties_address_lines.rb +259 -0
  85. data/lib/onfido/models/document_properties_barcode_inner.rb +367 -0
  86. data/lib/onfido/models/document_properties_document_classification.rb +232 -0
  87. data/lib/onfido/models/document_properties_document_numbers_inner.rb +223 -0
  88. data/lib/onfido/models/document_properties_driving_licence_information.rb +241 -0
  89. data/lib/onfido/models/document_properties_extracted_data.rb +394 -0
  90. data/lib/onfido/models/document_properties_nfc.rb +322 -0
  91. data/lib/onfido/models/document_report.rb +354 -0
  92. data/lib/onfido/models/document_response.rb +272 -0
  93. data/lib/onfido/models/document_shared.rb +301 -0
  94. data/lib/onfido/models/document_types.rb +64 -0
  95. data/lib/onfido/models/document_video_report.rb +354 -0
  96. data/lib/onfido/models/document_video_with_address_information_report.rb +354 -0
  97. data/lib/onfido/models/document_with_address_information_report.rb +354 -0
  98. data/lib/onfido/models/document_with_driver_verification_report.rb +354 -0
  99. data/lib/onfido/models/document_with_driver_verification_report_all_of_properties.rb +529 -0
  100. data/lib/onfido/models/document_with_driver_verification_report_all_of_properties_all_of_passenger_vehicle.rb +236 -0
  101. data/lib/onfido/models/document_with_driver_verification_report_all_of_properties_all_of_vehicle_class_details_inner.rb +245 -0
  102. data/lib/onfido/models/document_with_driving_licence_information_report.rb +354 -0
  103. data/lib/onfido/models/documents_list.rb +223 -0
  104. data/lib/onfido/models/error.rb +214 -0
  105. data/lib/onfido/models/error1.rb +224 -0
  106. data/lib/onfido/models/error_properties.rb +234 -0
  107. data/lib/onfido/models/error_properties1.rb +223 -0
  108. data/lib/onfido/models/extract_request.rb +222 -0
  109. data/lib/onfido/models/extraction.rb +233 -0
  110. data/lib/onfido/models/extraction_document_classification.rb +289 -0
  111. data/lib/onfido/models/extraction_extracted_data.rb +530 -0
  112. data/lib/onfido/models/facial_similarity_motion_breakdown.rb +232 -0
  113. data/lib/onfido/models/facial_similarity_motion_breakdown_face_comparison.rb +224 -0
  114. data/lib/onfido/models/facial_similarity_motion_breakdown_image_integrity.rb +224 -0
  115. data/lib/onfido/models/facial_similarity_motion_breakdown_image_integrity_breakdown.rb +223 -0
  116. data/lib/onfido/models/facial_similarity_motion_breakdown_image_integrity_breakdown_face_detected.rb +224 -0
  117. data/lib/onfido/models/facial_similarity_motion_breakdown_image_integrity_breakdown_source_integrity.rb +224 -0
  118. data/lib/onfido/models/facial_similarity_motion_breakdown_visual_authenticity.rb +224 -0
  119. data/lib/onfido/models/facial_similarity_motion_breakdown_visual_authenticity_breakdown.rb +223 -0
  120. data/lib/onfido/models/facial_similarity_motion_breakdown_visual_authenticity_breakdown_spoofing_detection.rb +224 -0
  121. data/lib/onfido/models/facial_similarity_motion_properties.rb +215 -0
  122. data/lib/onfido/models/facial_similarity_motion_report.rb +354 -0
  123. data/lib/onfido/models/facial_similarity_photo_breakdown.rb +232 -0
  124. data/lib/onfido/models/facial_similarity_photo_breakdown_face_comparison.rb +224 -0
  125. data/lib/onfido/models/facial_similarity_photo_breakdown_face_comparison_breakdown.rb +214 -0
  126. data/lib/onfido/models/facial_similarity_photo_breakdown_face_comparison_breakdown_face_match.rb +224 -0
  127. data/lib/onfido/models/facial_similarity_photo_breakdown_face_comparison_breakdown_face_match_properties.rb +225 -0
  128. data/lib/onfido/models/facial_similarity_photo_breakdown_image_integrity.rb +224 -0
  129. data/lib/onfido/models/facial_similarity_photo_breakdown_image_integrity_breakdown.rb +223 -0
  130. data/lib/onfido/models/facial_similarity_photo_breakdown_image_integrity_breakdown_face_detected.rb +224 -0
  131. data/lib/onfido/models/facial_similarity_photo_breakdown_image_integrity_breakdown_source_integrity.rb +224 -0
  132. data/lib/onfido/models/facial_similarity_photo_breakdown_visual_authenticity.rb +224 -0
  133. data/lib/onfido/models/facial_similarity_photo_breakdown_visual_authenticity_breakdown.rb +214 -0
  134. data/lib/onfido/models/facial_similarity_photo_breakdown_visual_authenticity_breakdown_spoofing_detection.rb +224 -0
  135. data/lib/onfido/models/facial_similarity_photo_breakdown_visual_authenticity_breakdown_spoofing_detection_properties.rb +215 -0
  136. data/lib/onfido/models/facial_similarity_photo_fully_auto_breakdown.rb +232 -0
  137. data/lib/onfido/models/facial_similarity_photo_fully_auto_breakdown_image_integrity.rb +224 -0
  138. data/lib/onfido/models/facial_similarity_photo_fully_auto_breakdown_image_integrity_breakdown.rb +223 -0
  139. data/lib/onfido/models/facial_similarity_photo_fully_auto_breakdown_image_integrity_breakdown_source_integrity.rb +224 -0
  140. data/lib/onfido/models/facial_similarity_photo_fully_auto_properties.rb +215 -0
  141. data/lib/onfido/models/facial_similarity_photo_fully_auto_report.rb +354 -0
  142. data/lib/onfido/models/facial_similarity_photo_properties.rb +215 -0
  143. data/lib/onfido/models/facial_similarity_photo_report.rb +354 -0
  144. data/lib/onfido/models/facial_similarity_video_breakdown.rb +232 -0
  145. data/lib/onfido/models/facial_similarity_video_breakdown_face_comparison.rb +224 -0
  146. data/lib/onfido/models/facial_similarity_video_breakdown_image_integrity.rb +224 -0
  147. data/lib/onfido/models/facial_similarity_video_breakdown_image_integrity_breakdown.rb +223 -0
  148. data/lib/onfido/models/facial_similarity_video_breakdown_image_integrity_breakdown_face_detected.rb +224 -0
  149. data/lib/onfido/models/facial_similarity_video_breakdown_image_integrity_breakdown_source_integrity.rb +224 -0
  150. data/lib/onfido/models/facial_similarity_video_breakdown_visual_authenticity.rb +224 -0
  151. data/lib/onfido/models/facial_similarity_video_breakdown_visual_authenticity_breakdown.rb +223 -0
  152. data/lib/onfido/models/facial_similarity_video_breakdown_visual_authenticity_breakdown_liveness_detected.rb +224 -0
  153. data/lib/onfido/models/facial_similarity_video_breakdown_visual_authenticity_breakdown_spoofing_detection.rb +224 -0
  154. data/lib/onfido/models/facial_similarity_video_properties.rb +215 -0
  155. data/lib/onfido/models/facial_similarity_video_report.rb +354 -0
  156. data/lib/onfido/models/id_number.rb +269 -0
  157. data/lib/onfido/models/id_photo.rb +289 -0
  158. data/lib/onfido/models/id_photo_response.rb +282 -0
  159. data/lib/onfido/models/id_photos_list.rb +223 -0
  160. data/lib/onfido/models/identity_enhanced_breakdown.rb +241 -0
  161. data/lib/onfido/models/identity_enhanced_breakdown_address.rb +224 -0
  162. data/lib/onfido/models/identity_enhanced_breakdown_address_breakdown.rb +232 -0
  163. data/lib/onfido/models/identity_enhanced_breakdown_address_breakdown_credit_agencies.rb +224 -0
  164. data/lib/onfido/models/identity_enhanced_breakdown_address_breakdown_credit_agencies_properties.rb +214 -0
  165. data/lib/onfido/models/identity_enhanced_breakdown_address_breakdown_telephone_database.rb +224 -0
  166. data/lib/onfido/models/identity_enhanced_breakdown_address_breakdown_voting_register.rb +224 -0
  167. data/lib/onfido/models/identity_enhanced_breakdown_date_of_birth.rb +224 -0
  168. data/lib/onfido/models/identity_enhanced_breakdown_date_of_birth_breakdown.rb +223 -0
  169. data/lib/onfido/models/identity_enhanced_breakdown_date_of_birth_breakdown_credit_agencies.rb +224 -0
  170. data/lib/onfido/models/identity_enhanced_breakdown_date_of_birth_breakdown_voting_register.rb +224 -0
  171. data/lib/onfido/models/identity_enhanced_breakdown_mortality.rb +215 -0
  172. data/lib/onfido/models/identity_enhanced_breakdown_sources.rb +224 -0
  173. data/lib/onfido/models/identity_enhanced_breakdown_sources_breakdown.rb +214 -0
  174. data/lib/onfido/models/identity_enhanced_breakdown_sources_breakdown_total_sources.rb +224 -0
  175. data/lib/onfido/models/identity_enhanced_breakdown_sources_breakdown_total_sources_properties.rb +214 -0
  176. data/lib/onfido/models/identity_enhanced_properties.rb +227 -0
  177. data/lib/onfido/models/identity_enhanced_properties_matched_addresses_inner.rb +227 -0
  178. data/lib/onfido/models/identity_enhanced_report.rb +354 -0
  179. data/lib/onfido/models/india_pan_report.rb +354 -0
  180. data/lib/onfido/models/india_pan_report_all_of_breakdown.rb +214 -0
  181. data/lib/onfido/models/india_pan_report_all_of_breakdown_device.rb +214 -0
  182. data/lib/onfido/models/india_pan_report_all_of_breakdown_device_breakdown.rb +223 -0
  183. data/lib/onfido/models/india_pan_report_all_of_breakdown_device_breakdown_pan_valid.rb +214 -0
  184. data/lib/onfido/models/india_pan_report_all_of_properties.rb +214 -0
  185. data/lib/onfido/models/india_pan_report_all_of_properties_device.rb +225 -0
  186. data/lib/onfido/models/known_faces_breakdown.rb +223 -0
  187. data/lib/onfido/models/known_faces_breakdown_image_integrity.rb +215 -0
  188. data/lib/onfido/models/known_faces_breakdown_previously_seen_faces.rb +215 -0
  189. data/lib/onfido/models/known_faces_properties.rb +217 -0
  190. data/lib/onfido/models/known_faces_properties_matches_inner.rb +255 -0
  191. data/lib/onfido/models/known_faces_report.rb +354 -0
  192. data/lib/onfido/models/live_photo.rb +289 -0
  193. data/lib/onfido/models/live_photo_response.rb +282 -0
  194. data/lib/onfido/models/live_photos_list.rb +223 -0
  195. data/lib/onfido/models/live_video.rb +287 -0
  196. data/lib/onfido/models/live_videos_list.rb +223 -0
  197. data/lib/onfido/models/location.rb +254 -0
  198. data/lib/onfido/models/location_builder.rb +254 -0
  199. data/lib/onfido/models/location_shared.rb +247 -0
  200. data/lib/onfido/models/motion_capture.rb +275 -0
  201. data/lib/onfido/models/motion_captures_list.rb +223 -0
  202. data/lib/onfido/models/photo_auto_reasons.rb +255 -0
  203. data/lib/onfido/models/photo_reasons.rb +255 -0
  204. data/lib/onfido/models/proof_of_address_breakdown.rb +232 -0
  205. data/lib/onfido/models/proof_of_address_breakdown_data_comparison.rb +224 -0
  206. data/lib/onfido/models/proof_of_address_breakdown_data_comparison_breakdown.rb +232 -0
  207. data/lib/onfido/models/proof_of_address_breakdown_document_classification.rb +224 -0
  208. data/lib/onfido/models/proof_of_address_breakdown_document_classification_breakdown.rb +214 -0
  209. data/lib/onfido/models/proof_of_address_breakdown_image_integrity.rb +224 -0
  210. data/lib/onfido/models/proof_of_address_breakdown_image_integrity_breakdown.rb +214 -0
  211. data/lib/onfido/models/proof_of_address_properties.rb +319 -0
  212. data/lib/onfido/models/proof_of_address_report.rb +354 -0
  213. data/lib/onfido/models/repeat_attempts_list.rb +292 -0
  214. data/lib/onfido/models/repeat_attempts_list_repeat_attempts_inner.rb +333 -0
  215. data/lib/onfido/models/report.rb +93 -0
  216. data/lib/onfido/models/report_document.rb +222 -0
  217. data/lib/onfido/models/report_name.rb +60 -0
  218. data/lib/onfido/models/report_result.rb +42 -0
  219. data/lib/onfido/models/report_shared.rb +329 -0
  220. data/lib/onfido/models/report_status.rb +44 -0
  221. data/lib/onfido/models/report_sub_result.rb +43 -0
  222. data/lib/onfido/models/reports_list.rb +223 -0
  223. data/lib/onfido/models/results_feedback.rb +279 -0
  224. data/lib/onfido/models/sdk_token.rb +229 -0
  225. data/lib/onfido/models/sdk_token_builder.rb +259 -0
  226. data/lib/onfido/models/sdk_token_request.rb +252 -0
  227. data/lib/onfido/models/sdk_token_response.rb +222 -0
  228. data/lib/onfido/models/task.rb +329 -0
  229. data/lib/onfido/models/task_item.rb +287 -0
  230. data/lib/onfido/models/timeline_file_reference.rb +239 -0
  231. data/lib/onfido/models/us_driving_licence_breakdown.rb +232 -0
  232. data/lib/onfido/models/us_driving_licence_breakdown_address.rb +224 -0
  233. data/lib/onfido/models/us_driving_licence_breakdown_address_breakdown.rb +259 -0
  234. data/lib/onfido/models/us_driving_licence_breakdown_document.rb +224 -0
  235. data/lib/onfido/models/us_driving_licence_breakdown_document_breakdown.rb +241 -0
  236. data/lib/onfido/models/us_driving_licence_breakdown_personal.rb +224 -0
  237. data/lib/onfido/models/us_driving_licence_breakdown_personal_breakdown.rb +322 -0
  238. data/lib/onfido/models/us_driving_licence_builder.rb +505 -0
  239. data/lib/onfido/models/us_driving_licence_report.rb +354 -0
  240. data/lib/onfido/models/us_driving_licence_shared.rb +499 -0
  241. data/lib/onfido/models/video_reasons.rb +245 -0
  242. data/lib/onfido/models/watchlist_aml_breakdown.rb +241 -0
  243. data/lib/onfido/models/watchlist_aml_breakdown_adverse_media.rb +215 -0
  244. data/lib/onfido/models/watchlist_aml_breakdown_legal_and_regulatory_warnings.rb +215 -0
  245. data/lib/onfido/models/watchlist_aml_breakdown_politically_exposed_person.rb +215 -0
  246. data/lib/onfido/models/watchlist_aml_breakdown_sanction.rb +215 -0
  247. data/lib/onfido/models/watchlist_aml_properties.rb +217 -0
  248. data/lib/onfido/models/watchlist_aml_report.rb +354 -0
  249. data/lib/onfido/models/watchlist_enhanced_breakdown.rb +241 -0
  250. data/lib/onfido/models/watchlist_enhanced_properties.rb +217 -0
  251. data/lib/onfido/models/watchlist_enhanced_report.rb +354 -0
  252. data/lib/onfido/models/watchlist_monitor.rb +342 -0
  253. data/lib/onfido/models/watchlist_monitor_builder.rb +292 -0
  254. data/lib/onfido/models/watchlist_monitor_match.rb +225 -0
  255. data/lib/onfido/models/watchlist_monitor_matches_list.rb +223 -0
  256. data/lib/onfido/models/watchlist_monitor_matches_updater.rb +227 -0
  257. data/lib/onfido/models/watchlist_monitor_response.rb +254 -0
  258. data/lib/onfido/models/watchlist_monitor_shared.rb +285 -0
  259. data/lib/onfido/models/watchlist_monitors_list.rb +223 -0
  260. data/lib/onfido/models/watchlist_peps_only_report.rb +354 -0
  261. data/lib/onfido/models/watchlist_sanctions_only_report.rb +354 -0
  262. data/lib/onfido/models/watchlist_standard_breakdown.rb +232 -0
  263. data/lib/onfido/models/watchlist_standard_properties.rb +217 -0
  264. data/lib/onfido/models/watchlist_standard_report.rb +354 -0
  265. data/lib/onfido/models/webhook.rb +304 -0
  266. data/lib/onfido/models/webhook_builder.rb +274 -0
  267. data/lib/onfido/models/webhook_create.rb +222 -0
  268. data/lib/onfido/models/webhook_event.rb +214 -0
  269. data/lib/onfido/models/webhook_event_payload.rb +273 -0
  270. data/lib/onfido/models/webhook_event_payload_object.rb +260 -0
  271. data/lib/onfido/models/webhook_event_type.rb +56 -0
  272. data/lib/onfido/models/webhook_resend.rb +216 -0
  273. data/lib/onfido/models/webhook_response.rb +252 -0
  274. data/lib/onfido/models/webhook_shared.rb +249 -0
  275. data/lib/onfido/models/webhook_update.rb +215 -0
  276. data/lib/onfido/models/webhook_updater.rb +267 -0
  277. data/lib/onfido/models/webhooks_list.rb +223 -0
  278. data/lib/onfido/models/webhooks_resend_item.rb +261 -0
  279. data/lib/onfido/models/workflow_run.rb +416 -0
  280. data/lib/onfido/models/workflow_run_builder.rb +316 -0
  281. data/lib/onfido/models/workflow_run_request.rb +217 -0
  282. data/lib/onfido/models/workflow_run_response.rb +317 -0
  283. data/lib/onfido/models/workflow_run_response_error.rb +226 -0
  284. data/lib/onfido/models/workflow_run_shared.rb +296 -0
  285. data/lib/onfido/models/workflow_run_shared_link.rb +290 -0
  286. data/lib/onfido/version.rb +12 -2
  287. data/lib/onfido/webhook_event_verifier.rb +20 -0
  288. data/lib/onfido.rb +309 -25
  289. data/onfido.gemspec +42 -33
  290. data/spec/integrations/address_picker_spec.rb +16 -0
  291. data/spec/integrations/applicant_spec.rb +73 -95
  292. data/spec/integrations/check_spec.rb +60 -41
  293. data/spec/integrations/document_spec.rb +28 -57
  294. data/spec/integrations/extraction_spec.rb +27 -12
  295. data/spec/integrations/id_photo_spec.rb +55 -0
  296. data/spec/integrations/live_photo_spec.rb +28 -45
  297. data/spec/integrations/live_video_spec.rb +33 -19
  298. data/spec/integrations/media/sample_driving_licence.png +0 -0
  299. data/spec/integrations/media/sample_photo.png +0 -0
  300. data/spec/integrations/motion_capture_spec.rb +30 -24
  301. data/spec/integrations/report_schema_spec.rb +45 -0
  302. data/spec/integrations/report_spec.rb +34 -25
  303. data/spec/integrations/sdk_token_spec.rb +12 -10
  304. data/spec/integrations/tasks_spec.rb +45 -0
  305. data/spec/integrations/watchlist_monitor_spec.rb +73 -0
  306. data/spec/integrations/webhook_spec.rb +40 -88
  307. data/spec/integrations/workflow_run_output_spec.rb +117 -0
  308. data/spec/integrations/workflow_run_spec.rb +67 -29
  309. data/spec/shared_contexts/with_applicant.rb +24 -0
  310. data/spec/shared_contexts/with_check.rb +18 -0
  311. data/spec/shared_contexts/with_document.rb +13 -0
  312. data/spec/shared_contexts/with_live_photo.rb +18 -0
  313. data/spec/shared_contexts/with_onfido.rb +14 -0
  314. data/spec/shared_contexts/with_workflow_run.rb +19 -0
  315. data/spec/spec_helper.rb +73 -11
  316. data/spec/webhook_event_verifier_spec.rb +29 -0
  317. metadata +367 -155
  318. data/.github/workflows/gem-push.yml +0 -31
  319. data/.github/workflows/ruby.yml +0 -25
  320. data/.gitignore +0 -19
  321. data/.rspec +0 -2
  322. data/.rubocop.yml +0 -13
  323. data/lib/onfido/api.rb +0 -65
  324. data/lib/onfido/errors/connection_error.rb +0 -6
  325. data/lib/onfido/errors/onfido_error.rb +0 -30
  326. data/lib/onfido/errors/request_error.rb +0 -6
  327. data/lib/onfido/errors/server_error.rb +0 -6
  328. data/lib/onfido/options.rb +0 -38
  329. data/lib/onfido/resource.rb +0 -153
  330. data/lib/onfido/resources/address.rb +0 -9
  331. data/lib/onfido/resources/applicant.rb +0 -29
  332. data/lib/onfido/resources/check.rb +0 -28
  333. data/lib/onfido/resources/document.rb +0 -28
  334. data/lib/onfido/resources/extraction.rb +0 -11
  335. data/lib/onfido/resources/live_photo.rb +0 -27
  336. data/lib/onfido/resources/live_video.rb +0 -17
  337. data/lib/onfido/resources/monitor.rb +0 -32
  338. data/lib/onfido/resources/motion_capture.rb +0 -21
  339. data/lib/onfido/resources/report.rb +0 -21
  340. data/lib/onfido/resources/sdk_token.rb +0 -10
  341. data/lib/onfido/resources/webhook.rb +0 -40
  342. data/lib/onfido/resources/workflow_run.rb +0 -17
  343. data/spec/integrations/address_spec.rb +0 -13
  344. data/spec/integrations/monitor_spec.rb +0 -100
  345. data/spec/integrations/resource_spec.rb +0 -106
  346. data/spec/onfido/api_spec.rb +0 -22
  347. data/spec/onfido/connection_error_spec.rb +0 -20
  348. data/spec/onfido/options_spec.rb +0 -39
  349. data/spec/onfido/request_error_spec.rb +0 -36
  350. data/spec/support/fake_onfido_api.rb +0 -283
  351. data/spec/support/fixtures/4xx_response.json +0 -14
  352. data/spec/support/fixtures/addresses.json +0 -24
  353. data/spec/support/fixtures/applicant.json +0 -28
  354. data/spec/support/fixtures/applicants.json +0 -12
  355. data/spec/support/fixtures/check.json +0 -12
  356. data/spec/support/fixtures/checks.json +0 -16
  357. data/spec/support/fixtures/document.json +0 -10
  358. data/spec/support/fixtures/documents.json +0 -23
  359. data/spec/support/fixtures/extraction.json +0 -23
  360. data/spec/support/fixtures/live_photo.json +0 -9
  361. data/spec/support/fixtures/live_photos.json +0 -22
  362. data/spec/support/fixtures/live_video.json +0 -23
  363. data/spec/support/fixtures/live_videos.json +0 -27
  364. data/spec/support/fixtures/monitor.json +0 -8
  365. data/spec/support/fixtures/monitor_matches.json +0 -12
  366. data/spec/support/fixtures/monitors.json +0 -12
  367. data/spec/support/fixtures/motion_capture.json +0 -9
  368. data/spec/support/fixtures/motion_captures.json +0 -13
  369. data/spec/support/fixtures/not_scheduled_for_deletion_error.json +0 -7
  370. data/spec/support/fixtures/report.json +0 -10
  371. data/spec/support/fixtures/reports.json +0 -24
  372. data/spec/support/fixtures/sdk_token.json +0 -3
  373. data/spec/support/fixtures/unexpected_error_format.json +0 -3
  374. data/spec/support/fixtures/webhook.json +0 -14
  375. data/spec/support/fixtures/webhooks.json +0 -31
  376. data/spec/support/fixtures/workflow_run.json +0 -20
  377. data/spec/support/fixtures/workflow_runs.json +0 -42
data/spec/support/fixtures/applicants.json DELETED
@@ -1,12 +0,0 @@
1
- {
2
- "applicants": [
3
- {
4
- "id": "1030303-123123-123123",
5
- "first_name": "John"
6
- },
7
- {
8
- "id": "1030303-123123-123145",
9
- "first_name": "Jane"
10
- }
11
- ]
12
- }
data/spec/support/fixtures/check.json DELETED
@@ -1,12 +0,0 @@
1
- {
2
- "id": "8546921-123123-123123",
3
- "created_at": "2019-05-23T13:50:33Z",
4
- "href": "/v3.6/checks/8546921-123123-123123",
5
- "applicant_provides_data": "false",
6
- "status": "in_progress",
7
- "result": "pending",
8
- "report_ids": [
9
- "1030303-123123-375629",
10
- "1030303-123123-456789"
11
- ]
12
- }
data/spec/support/fixtures/checks.json DELETED
@@ -1,16 +0,0 @@
1
- {
2
- "checks": [
3
- {
4
- "id": "8546921-123123-123123",
5
- "created_at": "2019-11-23T13:50:33Z",
6
- "href": "/v3.6/checks/8546921-123123-123123",
7
- "applicant_provides_data": "false",
8
- "status": "in_progress",
9
- "result": "pending",
10
- "report_ids": [
11
- "1030303-123123-375629",
12
- "1030303-123123-456789"
13
- ]
14
- }
15
- ]
16
- }
data/spec/support/fixtures/document.json DELETED
@@ -1,10 +0,0 @@
1
- {
2
- "id": "7568415-123123-123123",
3
- "created_at": "2019-11-23 13:50:33Z",
4
- "href": "/v3.6/documents/7568415-123123-123123",
5
- "file_name": "passport.jpg",
6
- "file_type": "png",
7
- "file_size": 282870,
8
- "type": "passport",
9
- "side": "back"
10
- }
data/spec/support/fixtures/documents.json DELETED
@@ -1,23 +0,0 @@
1
- {
2
- "documents": [
3
- {
4
- "id": "7568415-123123-123123",
5
- "created_at": "2019-11-23 13:50:33Z",
6
- "href": "/v3.6/documents/7568415-123123-123123",
7
- "file_name": "passport.jpg",
8
- "file_type": "png",
9
- "file_size": 282870,
10
- "type": "passport"
11
- },
12
- {
13
- "id": "121122-123123-123123",
14
- "created_at": "2019-11-23 13:50:40Z",
15
- "href": "/v3.6/documents/7568415-123123-123123",
16
- "file_name": "driving_licence.png",
17
- "file_type": "png",
18
- "file_size": 282870,
19
- "type": "driving_licence",
20
- "side": "front"
21
- }
22
- ]
23
- }
data/spec/support/fixtures/extraction.json DELETED
@@ -1,23 +0,0 @@
1
- {
2
- "document_id": "7568415-123123-123123",
3
- "document_classification": {
4
- "issuing_country": "FRA",
5
- "document_type": "national_identity_card"
6
- },
7
- "extracted_data": {
8
- "date_of_birth": "1965-09-08",
9
- "document_number": "400925733",
10
- "first_name": "MARIE",
11
- "gender": "Female",
12
- "last_name": "MAVARINE",
13
- "mrz_line1": "P<GBRDU<MARIE<<MAVARINE<<<<<<<<<<<<<<<<<<<<<",
14
- "mrz_line2": "4009257333GBR6509088F1307072<<<<<<<<<<<<<<06",
15
- "nationality": "BRITISH CITIZEN",
16
- "full_name": "MAVARINE DU MARIE",
17
- "date_of_expiry": "2013-07-07",
18
- "middle_name": "DU",
19
- "address_line_1": "52 RUE DES FLEURS",
20
- "address_line_2": "33500 BORDEAUX",
21
- "address_line_3": "FRANCE"
22
- }
23
- }
data/spec/support/fixtures/live_photo.json DELETED
@@ -1,9 +0,0 @@
1
- {
2
- "id": "3538c8f6-fdce-4745-9d34-fc246bc05aa1",
3
- "created_at": "2019-11-23 13:50:33Z",
4
- "file_name": "onfido_captured_image.jpg",
5
- "file_type": "image/jpeg",
6
- "file_size": 47544,
7
- "href": "/v3.6/live_photos/3538c8f6-fdce-4745-9d34-fc246bc05aa1",
8
- "download_href": "/v3.6/live_photos/3538c8f6-fdce-4745-9d34-fc246bc05aa1/download"
9
- }
data/spec/support/fixtures/live_photos.json DELETED
@@ -1,22 +0,0 @@
1
- {
2
- "live_photos": [
3
- {
4
- "id": "3538c8f6-fdce-4745-9d34-fc246bc05aa1",
5
- "created_at": "2019-11-23 13:50:33Z",
6
- "file_name": "onfido_captured_image.jpg",
7
- "file_type": "image/jpeg",
8
- "file_size": 47544,
9
- "href": "/v3.6/live_photos/3538c8f6-fdce-4745-9d34-fc246bc05aa1",
10
- "download_href": "/v3.6/live_photos/3538c8f6-fdce-4745-9d34-fc246bc05aa1/download"
11
- },
12
- {
13
- "id": "5134c12a-555a-1234-5e12-9d34fcbc11ba",
14
- "created_at": "2019-11-23 13:50:33Z",
15
- "file_name": "onfido_captured_image.jpg",
16
- "file_type": "image/jpeg",
17
- "file_size": 47544,
18
- "href": "/v3.6/live_photos/5134c12a-555a-1234-5e12-9d34fcbc11ba",
19
- "download_href": "/v3.6/live_photos/5134c12a-555a-1234-5e12-9d34fcbc11ba/download"
20
- }
21
- ]
22
- }
data/spec/support/fixtures/live_video.json DELETED
@@ -1,23 +0,0 @@
1
- {
2
- "id" : "c9701e9b-83aa-442f-995b-20320ee8fb01",
3
- "challenge" : [
4
- {
5
- "type" : "movement",
6
- "query" : "turnLeft"
7
- },
8
- {
9
- "type" : "recite",
10
- "query" : [
11
- 9,
12
- 5,
13
- 9
14
- ]
15
- }
16
- ],
17
- "created_at" : "2019-11-29T09:00:39Z",
18
- "file_name" : "output-29-05-2018_11_00_24.mov",
19
- "file_type" : "video/quicktime",
20
- "file_size" : 3348421,
21
- "href" : "/v3.6/live_videos/c9701e9b-83aa-442f-995b-20320ee8fb01",
22
- "download_href" : "/v3.6/live_videos/c9701e9b-83aa-442f-995b-20320ee8fb01/download"
23
- }
data/spec/support/fixtures/live_videos.json DELETED
@@ -1,27 +0,0 @@
1
- {
2
- "live_videos": [
3
- {
4
- "challenge": [
5
- {
6
- "query": "turnLeft",
7
- "type": "movement"
8
- },
9
- {
10
- "query": [
11
- 9,
12
- 5,
13
- 9
14
- ],
15
- "type": "recite"
16
- }
17
- ],
18
- "created_at": "2019-11-29T09:00:39Z",
19
- "download_href": "/v3.6/live_videos/c9701e9b-83aa-442f-995b-20320ee8fb01/download",
20
- "file_name": "output-29-11-2019_11_00_24.mov",
21
- "file_size": 3348421,
22
- "file_type": "video/quicktime",
23
- "href": "/v3.6/live_videos/c9701e9b-83aa-442f-995b-20320ee8fb01",
24
- "id": "c9701e9b-83aa-442f-995b-20320ee8fb01"
25
- }
26
- ]
27
- }
data/spec/support/fixtures/monitor.json DELETED
@@ -1,8 +0,0 @@
1
- {
2
- "id": "2748c4fc-c6b8-4c1e-a383-21efa241ce1e",
3
- "report_name": "watchlist_standard",
4
- "created_at": "2022-09-01T15:01:36.921Z",
5
- "deleted_at": null,
6
- "sandbox": false,
7
- "tags": []
8
- }
data/spec/support/fixtures/monitor_matches.json DELETED
@@ -1,12 +0,0 @@
1
- {
2
- "matches": [
3
- {
4
- "id": "37afcacb-5ff0-4b09-831d-5bcc672ca1fb",
5
- "enabled": true
6
- },
7
- {
8
- "id": "925e47d3-9e21-48d4-b570-9564c4282cec",
9
- "enabled": false
10
- }
11
- ]
12
- }
data/spec/support/fixtures/monitors.json DELETED
@@ -1,12 +0,0 @@
1
- {
2
- "monitors": [
3
- {
4
- "id": "2748c4fc-c6b8-4c1e-a383-21efa241ce1e",
5
- "report_name": "watchlist_standard",
6
- "created_at": "2022-09-01T15:01:36.921Z",
7
- "deleted_at": null,
8
- "sandbox": false,
9
- "tags": []
10
- }
11
- ]
12
- }
data/spec/support/fixtures/motion_capture.json DELETED
@@ -1,9 +0,0 @@
1
- {
2
- "id" : "b1ae05b7-fb12-47c3-971c-311b56fc8de6",
3
- "created_at" : "2022-11-22T10:22:45Z",
4
- "file_name" : "motion_capture.mp4",
5
- "file_type" : "video/mp4",
6
- "file_size" : 2437112,
7
- "href" : "/v3.6/motion_captures/b1ae05b7-fb12-47c3-971c-311b56fc8de6",
8
- "download_href" : "/v3.6/motion_captures/b1ae05b7-fb12-47c3-971c-311b56fc8de6/download"
9
- }
data/spec/support/fixtures/motion_captures.json DELETED
@@ -1,13 +0,0 @@
1
- {
2
- "motion_captures": [
3
- {
4
- "id" : "b1ae05b7-fb12-47c3-971c-311b56fc8de6",
5
- "created_at" : "2022-11-22T10:22:45Z",
6
- "file_name" : "motion_capture.mp4",
7
- "file_type" : "video/mp4",
8
- "file_size" : 2437112,
9
- "href" : "/v3.6/motion_captures/b1ae05b7-fb12-47c3-971c-311b56fc8de6",
10
- "download_href" : "/v3.6/motion_captures/b1ae05b7-fb12-47c3-971c-311b56fc8de6/download"
11
- }
12
- ]
13
- }
data/spec/support/fixtures/not_scheduled_for_deletion_error.json DELETED
@@ -1,7 +0,0 @@
1
- {
2
- "error": {
3
- "type": "validation_error",
4
- "message": "There was a validation error on this request",
5
- "fields": "Applicant a2fb9c62-ab10-4898-a8ec-342c4b552ad5 is not scheduled for deletion"
6
- }
7
- }
data/spec/support/fixtures/report.json DELETED
@@ -1,10 +0,0 @@
1
- {
2
- "id": "6951786-123123-422221",
3
- "name": "document",
4
- "created_at": "2019-11-23T13:50:45Z",
5
- "status": "in_progress",
6
- "result": "pending",
7
- "href": "/v3.6/reports/6951786-123123-422221",
8
- "breakdown": {},
9
- "properties": {}
10
- }
data/spec/support/fixtures/reports.json DELETED
@@ -1,24 +0,0 @@
1
- {
2
- "reports": [
3
- {
4
- "id": "6951786-123123-422221",
5
- "name": "document",
6
- "created_at": "2019-11-23T13:50:45Z",
7
- "status": "in_progress",
8
- "result": "pending",
9
- "href": "/v3.6/reports/6951786-123123-422221",
10
- "breakdown": {},
11
- "properties": {}
12
- },
13
- {
14
- "id": "6951786-123123-316712",
15
- "name": "facial_similarity_photo",
16
- "created_at": "2019-11-23T13:50:45Z",
17
- "status": "in_progress",
18
- "result": "pending",
19
- "href": "/v3.6/reports/6951786-123123-316712",
20
- "breakdown": {},
21
- "properties": {}
22
- }
23
- ]
24
- }
data/spec/support/fixtures/sdk_token.json DELETED
@@ -1,3 +0,0 @@
1
- {
2
- "token": "header.payload.signature"
3
- }
data/spec/support/fixtures/unexpected_error_format.json DELETED
@@ -1,3 +0,0 @@
1
- {
2
- "unexpected": "format"
3
- }
data/spec/support/fixtures/webhook.json DELETED
@@ -1,14 +0,0 @@
1
- {
2
- "id": "fcb73186-0733-4f6f-9c57-d9d5ef979443",
3
- "url": "https://webhookendpoint.url",
4
- "token": "yV85IsmuYwmjQGlZ",
5
- "enabled": true,
6
- "href": "/v3.6/webhooks/fcb73186-0733-4f6f-9c57-d9d5ef979443",
7
- "environments": [
8
- "live"
9
- ],
10
- "events": [
11
- "report.completed",
12
- "check.completed"
13
- ]
14
- }
data/spec/support/fixtures/webhooks.json DELETED
@@ -1,31 +0,0 @@
1
- {
2
- "webhooks": [
3
- {
4
- "id": "dd0a89e4-d44e-417a-aec4-01137d01ae59",
5
- "url": "https://demo.com",
6
- "enabled":false,
7
- "href": "/v3.6/webhooks/dd0a89e4-d44e-417a-aec4-01137d01ae59",
8
- "environments": [
9
- "live"
10
- ],
11
- "events": [
12
- "report.completed",
13
- "report.withdrawn",
14
- "check.completed"
15
- ]
16
- },
17
- {
18
- "id": "bfc727a8-f7bf-4073-b123-ed70a70f58e5",
19
- "url": "https://demo2.com",
20
- "enabled": true,
21
- "href": "/v3.6/webhooks/bfc727a8-f7bf-4073-b123-ed70a70f58e5",
22
- "environments": [
23
- "live"
24
- ],
25
- "events": [
26
- "report.completed",
27
- "check.completed"
28
- ]
29
- }
30
- ]
31
- }
data/spec/support/fixtures/workflow_run.json DELETED
@@ -1,20 +0,0 @@
1
- {
2
- "id": "fcb73186-0733-4f6f-9c57-d9d5ef979443",
3
- "applicant_id": "fcb73186-0733-4f6f-9c57-d9d5ef979443",
4
- "workflow_id": "fcb73186-0733-4f6f-9c57-d9d5ef979443",
5
- "workflow_version_id": 11,
6
- "status": "approved",
7
- "dashboard_url":"https://dashboard.onfido.com/results/fcb73186-0733-4f6f-9c57-d9d5ef979443",
8
- "output": {"prop1": "val_1", "prop2": 10},
9
- "reasons": ["reason_1", "reason_2"],
10
- "error": null,
11
- "created_at": "2022-06-28T15:39:42Z",
12
- "updated_at": "2022-07-28T15:40:42Z",
13
- "link": {
14
- "completed_redirect_url": "https://example.onfido.com",
15
- "expired_redirect_url": "https://example.onfido.com",
16
- "expires_at": "2022-10-17T14:40:50Z",
17
- "language": "en_US",
18
- "url": "https://eu.onfido.app/l/fcb73186-0733-4f6f-9c57-d9d5ef979443"
19
- }
20
- }
data/spec/support/fixtures/workflow_runs.json DELETED
@@ -1,42 +0,0 @@
1
- [
2
- {
3
- "id": "fcb73186-0733-4f6f-9c57-d9d5ef979443",
4
- "applicant_id": "fcb73186-0733-4f6f-9c57-d9d5ef979443",
5
- "workflow_id": "fcb73186-0733-4f6f-9c57-d9d5ef979443",
6
- "workflow_version_id": 11,
7
- "status": "approved",
8
- "dashboard_url":"https://dashboard.onfido.com/results/fcb73186-0733-4f6f-9c57-d9d5ef979443",
9
- "output": {"prop1": "val_1", "prop2": 10},
10
- "reasons": ["reason_1", "reason_2"],
11
- "error": null,
12
- "created_at": "2022-06-28T15:39:42Z",
13
- "updated_at": "2022-07-28T15:40:42Z",
14
- "link": {
15
- "completed_redirect_url": "https://example.onfido.com",
16
- "expired_redirect_url": "https://example.onfido.com",
17
- "expires_at": "2022-10-17T14:40:50Z",
18
- "language": "en_US",
19
- "url": "https://eu.onfido.app/l/fcb73186-0733-4f6f-9c57-d9d5ef979443"
20
- }
21
- },
22
- {
23
- "id": "fcb73186-0733-4f6f-9c57-d9d5ef979463",
24
- "applicant_id": "fcb73186-0733-4f6f-9c57-d9d5ef979443",
25
- "workflow_id": "fcb73186-0733-4f6f-9c57-d9d5ef979443",
26
- "workflow_version_id": 11,
27
- "status": "approved",
28
- "dashboard_url":"https://dashboard.onfido.com/results/fcb73186-0733-4f6f-9c57-d9d5ef979443",
29
- "output": {"prop1": "val_1", "prop2": 10},
30
- "reasons": ["reason_1", "reason_2"],
31
- "error": null,
32
- "created_at": "2022-06-28T15:39:42Z",
33
- "updated_at": "2022-07-28T15:40:42Z",
34
- "link": {
35
- "completed_redirect_url": "https://example.onfido.com",
36
- "expired_redirect_url": "https://example.onfido.com",
37
- "expires_at": "2022-10-17T14:40:50Z",
38
- "language": "en_US",
39
- "url": "https://eu.onfido.app/l/fcb73186-0733-4f6f-9c57-d9d5ef979443"
40
- }
41
- }
42
- ]