trinsic_api 1.1.2 → 2.0.0.pre.alpha3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (183) hide show
  1. checksums.yaml +4 -4
  2. data/docs/AadhaarInput.md +20 -0
  3. data/docs/Address.md +3 -3
  4. data/docs/AttachmentAccessKeys.md +7 -5
  5. data/docs/BangladeshNationalIdInput.md +24 -0
  6. data/docs/BrazilCpfCheckInput.md +18 -0
  7. data/docs/BrazilDigitalCnhInput.md +24 -0
  8. data/docs/CreateAdvancedProviderSessionRequest.md +26 -0
  9. data/docs/CreateAdvancedProviderSessionResponse.md +22 -0
  10. data/docs/CreateHostedProviderSessionRequest.md +22 -0
  11. data/docs/CreateHostedProviderSessionResponse.md +20 -0
  12. data/docs/CreateWidgetSessionRequest.md +22 -0
  13. data/docs/{CreateSessionResponse.md → CreateWidgetSessionResponse.md} +5 -5
  14. data/docs/DocumentData.md +3 -3
  15. data/docs/DocumentScanAttachments.md +18 -0
  16. data/docs/{SessionState.md → DocumentType.md} +2 -2
  17. data/docs/HttpValidationProblemDetails.md +28 -0
  18. data/docs/IdentityData.md +4 -4
  19. data/docs/IndonesiaNikInput.md +22 -0
  20. data/docs/{FailureMessage.md → IntegrationCapability.md} +2 -5
  21. data/docs/IntegrationLaunchMethod.md +15 -0
  22. data/docs/IntegrationStep.md +22 -0
  23. data/docs/KenyaNidInput.md +28 -0
  24. data/docs/KnownAddress.md +32 -0
  25. data/docs/KnownIdentityData.md +18 -0
  26. data/docs/KnownPersonData.md +32 -0
  27. data/docs/MexicoCurpInput.md +18 -0
  28. data/docs/NetworkApi.md +37 -35
  29. data/docs/NigeriaNinInput.md +30 -0
  30. data/docs/PersonData.md +14 -12
  31. data/docs/PhilippineMatchInput.md +26 -0
  32. data/docs/PhilippineQRInput.md +20 -0
  33. data/docs/ProblemDetails.md +26 -0
  34. data/docs/ProviderAttachments.md +18 -0
  35. data/docs/ProviderInfo.md +3 -1
  36. data/docs/ProviderInformation.md +22 -0
  37. data/docs/ProviderInput.md +38 -0
  38. data/docs/RecommendRequest.md +26 -0
  39. data/docs/RecommendResponse.md +22 -0
  40. data/docs/RefreshStepContentRequest.md +18 -0
  41. data/docs/RefreshStepContentResponse.md +18 -0
  42. data/docs/ResultCollection.md +20 -0
  43. data/docs/ResultCollectionMethod.md +15 -0
  44. data/docs/Session.md +6 -8
  45. data/docs/{VerificationFailCode.md → SessionErrorCode.md} +2 -2
  46. data/docs/SessionsApi.md +236 -18
  47. data/docs/{SessionFailCode.md → Sex.md} +2 -2
  48. data/docs/SouthAfricaNidInput.md +24 -0
  49. data/docs/StepRefreshInfo.md +22 -0
  50. data/lib/trinsic_api/api/attachments_api.rb +1 -1
  51. data/lib/trinsic_api/api/network_api.rb +38 -37
  52. data/lib/trinsic_api/api/sessions_api.rb +217 -19
  53. data/lib/trinsic_api/api_client.rb +1 -1
  54. data/lib/trinsic_api/api_error.rb +1 -1
  55. data/lib/trinsic_api/configuration.rb +1 -1
  56. data/lib/trinsic_api/models/{validation_result.rb → aadhaar_input.rb} +21 -26
  57. data/lib/trinsic_api/models/address.rb +16 -10
  58. data/lib/trinsic_api/models/attachment_access_keys.rb +25 -10
  59. data/lib/trinsic_api/models/bangladesh_national_id_input.rb +249 -0
  60. data/lib/trinsic_api/models/brazil_cpf_check_input.rb +261 -0
  61. data/lib/trinsic_api/models/brazil_digital_cnh_input.rb +294 -0
  62. data/lib/trinsic_api/models/cancel_session_response.rb +1 -1
  63. data/lib/trinsic_api/models/create_advanced_provider_session_request.rb +312 -0
  64. data/lib/trinsic_api/models/create_advanced_provider_session_response.rb +256 -0
  65. data/lib/trinsic_api/models/create_hosted_provider_session_request.rb +288 -0
  66. data/lib/trinsic_api/models/create_hosted_provider_session_response.rb +233 -0
  67. data/lib/trinsic_api/models/create_widget_session_request.rb +240 -0
  68. data/lib/trinsic_api/models/{create_session_response.rb → create_widget_session_response.rb} +18 -17
  69. data/lib/trinsic_api/models/document_data.rb +32 -4
  70. data/lib/trinsic_api/models/{failure_message.rb → document_scan_attachments.rb} +12 -18
  71. data/lib/trinsic_api/models/{session_state.rb → document_type.rb} +9 -11
  72. data/lib/trinsic_api/models/get_attachment_request.rb +1 -1
  73. data/lib/trinsic_api/models/get_attachment_response.rb +1 -1
  74. data/lib/trinsic_api/models/get_session_response.rb +1 -1
  75. data/lib/trinsic_api/models/get_session_result_request.rb +1 -1
  76. data/lib/trinsic_api/models/get_session_result_response.rb +2 -1
  77. data/lib/trinsic_api/models/http_validation_problem_details.rb +273 -0
  78. data/lib/trinsic_api/models/identity_data.rb +5 -5
  79. data/lib/trinsic_api/models/{create_session_request.rb → indonesia_nik_input.rb} +105 -38
  80. data/lib/trinsic_api/models/integration_capability.rb +44 -0
  81. data/lib/trinsic_api/models/integration_launch_method.rb +42 -0
  82. data/lib/trinsic_api/models/integration_step.rb +275 -0
  83. data/lib/trinsic_api/models/kenya_nid_input.rb +397 -0
  84. data/lib/trinsic_api/models/known_address.rb +287 -0
  85. data/lib/trinsic_api/models/known_identity_data.rb +217 -0
  86. data/lib/trinsic_api/models/{disclosed_fields_request.rb → known_person_data.rb} +57 -77
  87. data/lib/trinsic_api/models/list_providers_response.rb +1 -1
  88. data/lib/trinsic_api/models/list_sessions_response.rb +1 -1
  89. data/lib/trinsic_api/models/mexico_curp_input.rb +250 -0
  90. data/lib/trinsic_api/models/nigeria_nin_input.rb +383 -0
  91. data/lib/trinsic_api/models/order_direction.rb +1 -1
  92. data/lib/trinsic_api/models/person_data.rb +50 -15
  93. data/lib/trinsic_api/models/philippine_match_input.rb +260 -0
  94. data/lib/trinsic_api/models/philippine_qr_input.rb +227 -0
  95. data/lib/trinsic_api/models/problem_details.rb +255 -0
  96. data/lib/trinsic_api/models/provider_attachments.rb +215 -0
  97. data/lib/trinsic_api/models/provider_info.rb +18 -5
  98. data/lib/trinsic_api/models/provider_information.rb +253 -0
  99. data/lib/trinsic_api/models/provider_input.rb +326 -0
  100. data/lib/trinsic_api/models/recommend_request.rb +266 -0
  101. data/lib/trinsic_api/models/recommend_response.rb +262 -0
  102. data/lib/trinsic_api/models/refresh_step_content_request.rb +216 -0
  103. data/lib/trinsic_api/models/{identity_lookup_response.rb → refresh_step_content_response.rb} +16 -16
  104. data/lib/trinsic_api/models/{verification.rb → result_collection.rb} +27 -20
  105. data/lib/trinsic_api/models/result_collection_method.rb +40 -0
  106. data/lib/trinsic_api/models/session.rb +32 -48
  107. data/lib/trinsic_api/models/session_error_code.rb +48 -0
  108. data/lib/trinsic_api/models/session_ordering.rb +1 -1
  109. data/lib/trinsic_api/models/sex.rb +42 -0
  110. data/lib/trinsic_api/models/{disclosed_fields.rb → south_africa_nid_input.rb} +107 -154
  111. data/lib/trinsic_api/models/step_refresh_info.rb +256 -0
  112. data/lib/trinsic_api/version.rb +2 -2
  113. data/lib/trinsic_api.rb +40 -12
  114. data/spec/api/attachments_api_spec.rb +1 -1
  115. data/spec/api/network_api_spec.rb +12 -12
  116. data/spec/api/sessions_api_spec.rb +44 -7
  117. data/spec/models/{verification_spec.rb → aadhaar_input_spec.rb} +9 -9
  118. data/spec/models/address_spec.rb +2 -2
  119. data/spec/models/attachment_access_keys_spec.rb +7 -1
  120. data/spec/models/bangladesh_national_id_input_spec.rb +54 -0
  121. data/spec/models/{identity_lookup_response_spec.rb → brazil_cpf_check_input_spec.rb} +8 -8
  122. data/spec/models/brazil_digital_cnh_input_spec.rb +54 -0
  123. data/spec/models/cancel_session_response_spec.rb +1 -1
  124. data/spec/models/create_advanced_provider_session_request_spec.rb +60 -0
  125. data/spec/models/create_advanced_provider_session_response_spec.rb +48 -0
  126. data/spec/models/create_hosted_provider_session_request_spec.rb +48 -0
  127. data/spec/models/create_hosted_provider_session_response_spec.rb +42 -0
  128. data/spec/models/create_widget_session_request_spec.rb +48 -0
  129. data/spec/models/{create_session_response_spec.rb → create_widget_session_response_spec.rb} +8 -8
  130. data/spec/models/document_data_spec.rb +1 -1
  131. data/spec/models/document_scan_attachments_spec.rb +36 -0
  132. data/spec/models/{session_state_spec.rb → document_type_spec.rb} +7 -7
  133. data/spec/models/get_attachment_request_spec.rb +1 -1
  134. data/spec/models/get_attachment_response_spec.rb +1 -1
  135. data/spec/models/get_session_response_spec.rb +1 -1
  136. data/spec/models/get_session_result_request_spec.rb +1 -1
  137. data/spec/models/get_session_result_response_spec.rb +1 -1
  138. data/spec/models/http_validation_problem_details_spec.rb +66 -0
  139. data/spec/models/identity_data_spec.rb +1 -1
  140. data/spec/models/indonesia_nik_input_spec.rb +48 -0
  141. data/spec/models/integration_capability_spec.rb +30 -0
  142. data/spec/models/integration_launch_method_spec.rb +30 -0
  143. data/spec/models/integration_step_spec.rb +48 -0
  144. data/spec/models/kenya_nid_input_spec.rb +66 -0
  145. data/spec/models/known_address_spec.rb +78 -0
  146. data/spec/models/known_identity_data_spec.rb +36 -0
  147. data/spec/models/{disclosed_fields_request_spec.rb → known_person_data_spec.rb} +13 -37
  148. data/spec/models/list_providers_response_spec.rb +1 -1
  149. data/spec/models/list_sessions_response_spec.rb +1 -1
  150. data/spec/models/{failure_message_spec.rb → mexico_curp_input_spec.rb} +8 -8
  151. data/spec/models/nigeria_nin_input_spec.rb +72 -0
  152. data/spec/models/order_direction_spec.rb +1 -1
  153. data/spec/models/person_data_spec.rb +8 -2
  154. data/spec/models/philippine_match_input_spec.rb +60 -0
  155. data/spec/models/philippine_qr_input_spec.rb +42 -0
  156. data/spec/models/problem_details_spec.rb +60 -0
  157. data/spec/models/provider_attachments_spec.rb +36 -0
  158. data/spec/models/provider_info_spec.rb +7 -1
  159. data/spec/models/provider_information_spec.rb +48 -0
  160. data/spec/models/{disclosed_fields_spec.rb → provider_input_spec.rb} +18 -24
  161. data/spec/models/recommend_request_spec.rb +60 -0
  162. data/spec/models/recommend_response_spec.rb +48 -0
  163. data/spec/models/refresh_step_content_request_spec.rb +36 -0
  164. data/spec/models/refresh_step_content_response_spec.rb +36 -0
  165. data/spec/models/result_collection_method_spec.rb +30 -0
  166. data/spec/models/{validation_result_spec.rb → result_collection_spec.rb} +9 -9
  167. data/spec/models/{verification_fail_code_spec.rb → session_error_code_spec.rb} +7 -7
  168. data/spec/models/session_ordering_spec.rb +1 -1
  169. data/spec/models/session_spec.rb +4 -10
  170. data/spec/models/{session_fail_code_spec.rb → sex_spec.rb} +7 -7
  171. data/spec/models/{create_session_request_spec.rb → south_africa_nid_input_spec.rb} +11 -11
  172. data/spec/models/step_refresh_info_spec.rb +48 -0
  173. data/spec/spec_helper.rb +1 -1
  174. data/trinsic_api.gemspec +1 -1
  175. metadata +173 -61
  176. data/docs/CreateSessionRequest.md +0 -24
  177. data/docs/DisclosedFields.md +0 -40
  178. data/docs/DisclosedFieldsRequest.md +0 -40
  179. data/docs/IdentityLookupResponse.md +0 -18
  180. data/docs/ValidationResult.md +0 -20
  181. data/docs/Verification.md +0 -20
  182. data/lib/trinsic_api/models/session_fail_code.rb +0 -45
  183. data/lib/trinsic_api/models/verification_fail_code.rb +0 -43
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 555547575f24bd34d4674407c0516a0569a3252af1f79da905d2dad43c5a2b75
4
- data.tar.gz: d8c405fa2d8c7c46592901108e04b61edc1a39f7f7f540a687478f7b6c56e992
3
+ metadata.gz: 52a9b11625e2f73927d0a96e3c33c2755eae31d9c04a162ab7a85b91be2f6fa6
4
+ data.tar.gz: 189f8f249163f376410a00d52c13f3997d09a8ce19e27cce24cbfbeb96e91454
5
5
  SHA512:
6
- metadata.gz: 39358ab2dd616d6c51d8e08931531ebd3a238c4f3bf58269c032f9df2c20dd06ea51265b0322ab432fbcbfab95b21ce99d8cc8f4f565d27340cab6b92b0ac36d
7
- data.tar.gz: 43c7d0b6a7f400bc5f7d78916d3dcd4a439c721cb4e2e7cf76850692f2154513dd2389bb7dba91b464c90fdac612db3085ff33f9404cd72f595c1ea8e4ebd83a
6
+ metadata.gz: b44904314be04019690dc752bd2943229a7570a7abaf618ac8da70a5ec72597ff7387c8621c7d5d440b6aa23f1e00ee69eb1180eaa6a28e0ccb3bb048a3e3ec2
7
+ data.tar.gz: 2ead6f95554841b749d19d97a5e49319b8962e018f2ad61ec1a6a6f5debb4ebda1953994420af4154212dfefc702bdf777bd789490b2f9f87da14fb153e25155
@@ -0,0 +1,20 @@
1
+ # TrinsicApi::AadhaarInput
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **full_name** | **String** | The user's full name | [optional] |
8
+ | **date_of_birth** | **Date** | The user's date of birth, in `YYYY-MM-DD` format | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'trinsic_api'
14
+
15
+ instance = TrinsicApi::AadhaarInput.new(
16
+ full_name: null,
17
+ date_of_birth: null
18
+ )
19
+ ```
20
+
data/docs/Address.md CHANGED
@@ -8,10 +8,10 @@
8
8
  | **line2** | **String** | | [optional] |
9
9
  | **line3** | **String** | | [optional] |
10
10
  | **city** | **String** | | [optional] |
11
- | **state** | **String** | | [optional] |
11
+ | **subdivision** | **String** | | [optional] |
12
12
  | **postal_code** | **String** | | [optional] |
13
13
  | **country** | **String** | | [optional] |
14
- | **full_address** | **String** | The full address as a single string | [optional] |
14
+ | **full_address** | **String** | | [optional] |
15
15
 
16
16
  ## Example
17
17
 
@@ -23,7 +23,7 @@ instance = TrinsicApi::Address.new(
23
23
  line2: null,
24
24
  line3: null,
25
25
  city: null,
26
- state: null,
26
+ subdivision: null,
27
27
  postal_code: null,
28
28
  country: null,
29
29
  full_address: null
@@ -4,10 +4,11 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **selfie** | **String** | Key to access the selfie image (if relevant) for this verification | [optional] |
8
- | **document_front** | **String** | Key to access the document front image (if relevant) for this verification | [optional] |
9
- | **document_back** | **String** | Key to access the document back image (if relevant) for this verification | [optional] |
10
- | **document_portrait** | **String** | Key to access the document portrait image (if relevant and available) for this verification. Specifically, this is a cropped version of the document front image which includes only the portrait on the document. | [optional] |
7
+ | **selfie** | **String** | | [optional] |
8
+ | **document_front** | **String** | | [optional] |
9
+ | **document_back** | **String** | | [optional] |
10
+ | **document_portrait** | **String** | | [optional] |
11
+ | **provider** | [**ProviderAttachments**](ProviderAttachments.md) | | |
11
12
 
12
13
  ## Example
13
14
 
@@ -18,7 +19,8 @@ instance = TrinsicApi::AttachmentAccessKeys.new(
18
19
  selfie: null,
19
20
  document_front: null,
20
21
  document_back: null,
21
- document_portrait: null
22
+ document_portrait: null,
23
+ provider: null
22
24
  )
23
25
  ```
24
26
 
@@ -0,0 +1,24 @@
1
+ # TrinsicApi::BangladeshNationalIdInput
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **national_id_number** | **String** | The user's Bangladesh National ID number. | [optional] |
8
+ | **date_of_birth** | **Date** | The user's date of birth, in `YYYY-MM-DD` format | [optional] |
9
+ | **name** | **String** | The user's full name | [optional] |
10
+ | **photo_base64** | **String** | The base64-encoded bytes of the photo collected from the user | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'trinsic_api'
16
+
17
+ instance = TrinsicApi::BangladeshNationalIdInput.new(
18
+ national_id_number: null,
19
+ date_of_birth: null,
20
+ name: null,
21
+ photo_base64: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,18 @@
1
+ # TrinsicApi::BrazilCpfCheckInput
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **cpf_number** | **String** | The user's 11-digit, numeric CPF Number | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'trinsic_api'
13
+
14
+ instance = TrinsicApi::BrazilCpfCheckInput.new(
15
+ cpf_number: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,24 @@
1
+ # TrinsicApi::BrazilDigitalCnhInput
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **cpf_number** | **String** | The user's 11-digit, numeric CPF Number | |
8
+ | **digital_cnh_file** | **String** | The raw bytes of the digital CNH file collected from the user. TODO: Lucas or JP help me describe these below vvvvvvvv This can be: - An image containing a physical or digital QR code - A PDF file exported from the CNH app - Some scary third thing? | [optional] |
9
+ | **digital_cnh_file_content_type** | **String** | The MIME Type of the file contained in `DigitalCnhFile`. Must be one of `application/pdf`, `image/jpeg`, or `image/png`. | [optional] |
10
+ | **facial_biometry_photo** | **String** | The raw bytes of the image of the user's face, collected for biometric comparison. | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'trinsic_api'
16
+
17
+ instance = TrinsicApi::BrazilDigitalCnhInput.new(
18
+ cpf_number: null,
19
+ digital_cnh_file: null,
20
+ digital_cnh_file_content_type: null,
21
+ facial_biometry_photo: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,26 @@
1
+ # TrinsicApi::CreateAdvancedProviderSessionRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **provider** | **String** | The ID of the provider to launch | |
8
+ | **provider_input** | [**ProviderInput**](ProviderInput.md) | Provider-specific input for those providers which require it. | [optional] |
9
+ | **redirect_url** | **String** | The Redirect URL to which the user should be sent after the session is complete. This field is required for providers which employ a redirect-based flow. | [optional] |
10
+ | **capabilities** | [**Array<IntegrationCapability>**](IntegrationCapability.md) | The list of capabilities your integration supports. Capabilities are the core of Trinsic's whitelabel-with-optional-fallback offering. Most capabilities align with either an `IntegrationLaunchMethod` or an `IntegrationCollectionMethod`. The exception being refresh content to support updating the content of the launch method. For example, to support a basic redirect-based flow, you must include the `LaunchRedirect` and `CaptureRedirect` capabilities. To support a mobile deeplink / polling flow, you must include the `DeeplinkToMobile` and `PollForResults` capabilities. If `FallbackToHostedUi` is `true`, Trinsic will automatically fall back to a Trinsic-hosted UI to cover any gaps in your integration's capabilities. If `FallbackToHostedUi` is `false`, gaps in your integration's capabilities will result in an error during Session creation. Read more on how to integrate at <a href=\"https://docs.trinsic.id/docs/advanced-provider-sessions\">the guide on Advanced Provider Sessions</a> | |
11
+ | **fallback_to_hosted_ui** | **Boolean** | Whether the session should fall back to a Trinsic-hosted UI in certain instances. Specifically, fallback will occur if any of the following are true: - You attempted to launch a provider which requires a capability you did not express support for - In this case, Trinsic's hosted UI will perform the necessary capability - You attempted to launch a provider which requires input, and the input was either not provided or incomplete - In this case, Trinsic's hosted UI will collect the necessary input from the user If fallback occurs, the session's NextStep will always be LaunchBrowser, and the CollectionMethod will always be CaptureRedirect. If this field is set to `true`, you must also: 1. Set the `RedirectUrl` field to a non-empty value 2. Include the `LaunchBrowser` and `CaptureRedirect` capabilities in the `Capabilities` field | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'trinsic_api'
17
+
18
+ instance = TrinsicApi::CreateAdvancedProviderSessionRequest.new(
19
+ provider: null,
20
+ provider_input: null,
21
+ redirect_url: null,
22
+ capabilities: null,
23
+ fallback_to_hosted_ui: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,22 @@
1
+ # TrinsicApi::CreateAdvancedProviderSessionResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **session_id** | **String** | The ID of the newly-created Acceptance Session | |
8
+ | **result_collection** | [**ResultCollection**](ResultCollection.md) | The method by which you must collect the results of the Acceptance Session. | |
9
+ | **next_step** | [**IntegrationStep**](IntegrationStep.md) | The next step you must take to launch the user into the integration | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'trinsic_api'
15
+
16
+ instance = TrinsicApi::CreateAdvancedProviderSessionResponse.new(
17
+ session_id: 00000000-0000-0000-0000-000000000000,
18
+ result_collection: null,
19
+ next_step: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,22 @@
1
+ # TrinsicApi::CreateHostedProviderSessionRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **provider** | **String** | The ID of the provider to launch | |
8
+ | **redirect_url** | **String** | The Redirect URL to which the user should be sent after the session is complete. | |
9
+ | **provider_input** | [**ProviderInput**](ProviderInput.md) | Provider-specific input for those providers which require it. | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'trinsic_api'
15
+
16
+ instance = TrinsicApi::CreateHostedProviderSessionRequest.new(
17
+ provider: null,
18
+ redirect_url: null,
19
+ provider_input: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,20 @@
1
+ # TrinsicApi::CreateHostedProviderSessionResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **session_id** | **String** | The ID of the newly-created Acceptance Session | |
8
+ | **launch_url** | **String** | The URL that should be used to launch the Hosted Provider Session on your user's device. There are two recommended ways to do so: - Redirect their browser to the `LaunchUrl` as a top-level navigation - Open a popup window and navigate it to the `LaunchUrl` This URL is sensitive and as such can only be obtained once. If you need to obtain it again, you will need to create a new Acceptance Session. | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'trinsic_api'
14
+
15
+ instance = TrinsicApi::CreateHostedProviderSessionResponse.new(
16
+ session_id: null,
17
+ launch_url: https://api.trinsic.id/api/session/launch?clientToken=...
18
+ )
19
+ ```
20
+
@@ -0,0 +1,22 @@
1
+ # TrinsicApi::CreateWidgetSessionRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **redirect_url** | **String** | The URL to redirect the user to after the widget session is complete. *Note*: this should NOT be set if you intend to use Trinsic's Web UI SDK to launch the Widget as an embedded iFrame or popup; in that case, session resolution is handled by our SDK, not via redirect. | [optional] |
8
+ | **providers** | **Array<String>** | The list of allowed identity providers. If not specified, all available providers will be allowed. | [optional] |
9
+ | **known_identity_data** | [**KnownIdentityData**](KnownIdentityData.md) | Known identity data of an individual being verified. Provide this to Trinsic during Session creation to enable improved identity provider selection recommendations. | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'trinsic_api'
15
+
16
+ instance = TrinsicApi::CreateWidgetSessionRequest.new(
17
+ redirect_url: null,
18
+ providers: null,
19
+ known_identity_data: null
20
+ )
21
+ ```
22
+
@@ -1,19 +1,19 @@
1
- # TrinsicApi::CreateSessionResponse
1
+ # TrinsicApi::CreateWidgetSessionResponse
2
2
 
3
3
  ## Properties
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **session** | [**Session**](Session.md) | The created Acceptance Session | |
8
- | **launch_url** | **String** | The URL that should be used to invoke the Acceptance Session on your user's device. You can use our frontend SDKs to launch the user into the Acceptance Session, or you can redirect the user's browser to this URL. If the Session was created with `LaunchProviderDirectly` set to `true`, you can't use the iFrame mode. This URL is sensitive and as such can only be obtained once. If you need to obtain it again, you will need to create a new Acceptance Session. | [optional] |
7
+ | **session_id** | **String** | The ID of the newly-created Acceptance Session | |
8
+ | **launch_url** | **String** | The URL that should be used to invoke the Acceptance Session on your user's device. You can use our frontend SDKs to launch the user into the Acceptance Session, or you can redirect the user's browser to this URL. This URL is sensitive and as such can only be obtained once. If you need to obtain it again, you will need to create a new Acceptance Session. | [optional] |
9
9
 
10
10
  ## Example
11
11
 
12
12
  ```ruby
13
13
  require 'trinsic_api'
14
14
 
15
- instance = TrinsicApi::CreateSessionResponse.new(
16
- session: null,
15
+ instance = TrinsicApi::CreateWidgetSessionResponse.new(
16
+ session_id: null,
17
17
  launch_url: https://api.trinsic.id/api/session/launch?clientToken=...
18
18
  )
19
19
  ```
data/docs/DocumentData.md CHANGED
@@ -4,10 +4,10 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **type** | **String** | | [optional] |
7
+ | **type** | [**DocumentType**](DocumentType.md) | | [optional] |
8
8
  | **number** | **String** | | [optional] |
9
- | **issue_date** | **String** | | [optional] |
10
- | **expiration_date** | **String** | | [optional] |
9
+ | **issue_date** | **Date** | | [optional] |
10
+ | **expiration_date** | **Date** | | [optional] |
11
11
  | **issuing_country** | **String** | | [optional] |
12
12
  | **issuing_authority** | **String** | | [optional] |
13
13
 
@@ -0,0 +1,18 @@
1
+ # TrinsicApi::DocumentScanAttachments
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **report** | **String** | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'trinsic_api'
13
+
14
+ instance = TrinsicApi::DocumentScanAttachments.new(
15
+ report: null
16
+ )
17
+ ```
18
+
@@ -1,4 +1,4 @@
1
- # TrinsicApi::SessionState
1
+ # TrinsicApi::DocumentType
2
2
 
3
3
  ## Properties
4
4
 
@@ -10,6 +10,6 @@
10
10
  ```ruby
11
11
  require 'trinsic_api'
12
12
 
13
- instance = TrinsicApi::SessionState.new()
13
+ instance = TrinsicApi::DocumentType.new()
14
14
  ```
15
15
 
@@ -0,0 +1,28 @@
1
+ # TrinsicApi::HttpValidationProblemDetails
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **type** | **String** | | [optional] |
8
+ | **title** | **String** | | [optional] |
9
+ | **status** | **Integer** | | [optional] |
10
+ | **detail** | **String** | | [optional] |
11
+ | **instance** | **String** | | [optional] |
12
+ | **errors** | **Hash<String, Array<String>>** | | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'trinsic_api'
18
+
19
+ instance = TrinsicApi::HttpValidationProblemDetails.new(
20
+ type: null,
21
+ title: null,
22
+ status: null,
23
+ detail: null,
24
+ instance: null,
25
+ errors: null
26
+ )
27
+ ```
28
+
data/docs/IdentityData.md CHANGED
@@ -4,10 +4,10 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **originating_provider_id** | **String** | The ID of the integration from which this data originated (eg \"yoti\", \"clear\") | [optional] |
8
- | **person** | [**PersonData**](PersonData.md) | Identity data of the individual who was verified | [optional] |
9
- | **document** | [**DocumentData**](DocumentData.md) | Identity data of the document involved in verification, if relevant | [optional] |
10
- | **attachment_access_keys** | [**AttachmentAccessKeys**](AttachmentAccessKeys.md) | Attachment Access Keys for attachments (eg document / selfie images) | [optional] |
7
+ | **originating_provider_id** | **String** | | [optional] |
8
+ | **person** | [**PersonData**](PersonData.md) | | [optional] |
9
+ | **document** | [**DocumentData**](DocumentData.md) | | [optional] |
10
+ | **attachment_access_keys** | [**AttachmentAccessKeys**](AttachmentAccessKeys.md) | | [optional] |
11
11
 
12
12
  ## Example
13
13
 
@@ -0,0 +1,22 @@
1
+ # TrinsicApi::IndonesiaNikInput
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **full_name** | **String** | The user's full name | |
8
+ | **date_of_birth** | **Date** | The user's date of birth, in `YYYY-MM-DD` format | |
9
+ | **nik_id_number** | **String** | The user's Indonesia NIK ID number | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'trinsic_api'
15
+
16
+ instance = TrinsicApi::IndonesiaNikInput.new(
17
+ full_name: null,
18
+ date_of_birth: null,
19
+ nik_id_number: null
20
+ )
21
+ ```
22
+
@@ -1,18 +1,15 @@
1
- # TrinsicApi::FailureMessage
1
+ # TrinsicApi::IntegrationCapability
2
2
 
3
3
  ## Properties
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **message** | **String** | | |
8
7
 
9
8
  ## Example
10
9
 
11
10
  ```ruby
12
11
  require 'trinsic_api'
13
12
 
14
- instance = TrinsicApi::FailureMessage.new(
15
- message: null
16
- )
13
+ instance = TrinsicApi::IntegrationCapability.new()
17
14
  ```
18
15
 
@@ -0,0 +1,15 @@
1
+ # TrinsicApi::IntegrationLaunchMethod
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'trinsic_api'
12
+
13
+ instance = TrinsicApi::IntegrationLaunchMethod.new()
14
+ ```
15
+
@@ -0,0 +1,22 @@
1
+ # TrinsicApi::IntegrationStep
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **method** | [**IntegrationLaunchMethod**](IntegrationLaunchMethod.md) | The launch method to perform | |
8
+ | **content** | **String** | Step type-specific content related to the step: a URL for `LaunchBrowser`, a deeplink for `DeeplinkToMobile` or a string to show to the user for `ShowContent`. | |
9
+ | **refresh** | [**StepRefreshInfo**](StepRefreshInfo.md) | If non-null, contains metadata about how to refresh the value of `content`. | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'trinsic_api'
15
+
16
+ instance = TrinsicApi::IntegrationStep.new(
17
+ method: null,
18
+ content: https://api.trinsic.id/api/session/launch?clientToken=...,
19
+ refresh: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,28 @@
1
+ # TrinsicApi::KenyaNidInput
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **first_name** | **String** | The user's first name as it appears in their National ID | |
8
+ | **middle_name** | **String** | The user's middle name as it appears in their National ID (optional) | [optional] |
9
+ | **last_name** | **String** | The user's middle name as it appears in their National ID (optional) | |
10
+ | **date_of_birth** | **Date** | The user's date of birth, in `YYYY-MM-DD` format | |
11
+ | **gender** | **String** | The user's gender as it appears in their National ID (e.g., male, female) | |
12
+ | **national_id_number** | **String** | The user's South Kenya National ID number | |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'trinsic_api'
18
+
19
+ instance = TrinsicApi::KenyaNidInput.new(
20
+ first_name: null,
21
+ middle_name: null,
22
+ last_name: null,
23
+ date_of_birth: null,
24
+ gender: null,
25
+ national_id_number: null
26
+ )
27
+ ```
28
+
@@ -0,0 +1,32 @@
1
+ # TrinsicApi::KnownAddress
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **line1** | **String** | | [optional] |
8
+ | **line2** | **String** | | [optional] |
9
+ | **line3** | **String** | | [optional] |
10
+ | **city** | **String** | | [optional] |
11
+ | **subdivision** | **String** | | [optional] |
12
+ | **state** | **String** | Deprecated. Use `Subdivision` instead. | [optional] |
13
+ | **postal_code** | **String** | | [optional] |
14
+ | **country** | **String** | | [optional] |
15
+
16
+ ## Example
17
+
18
+ ```ruby
19
+ require 'trinsic_api'
20
+
21
+ instance = TrinsicApi::KnownAddress.new(
22
+ line1: null,
23
+ line2: null,
24
+ line3: null,
25
+ city: null,
26
+ subdivision: null,
27
+ state: null,
28
+ postal_code: null,
29
+ country: null
30
+ )
31
+ ```
32
+
@@ -0,0 +1,18 @@
1
+ # TrinsicApi::KnownIdentityData
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **person** | [**KnownPersonData**](KnownPersonData.md) | Known identity data specific to the person being verified | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'trinsic_api'
13
+
14
+ instance = TrinsicApi::KnownIdentityData.new(
15
+ person: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,32 @@
1
+ # TrinsicApi::KnownPersonData
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **given_name** | **String** | Given (first) name of the individual | [optional] |
8
+ | **family_name** | **String** | Family (last) name of the individual | [optional] |
9
+ | **middle_name** | **String** | Middle name of the individual | [optional] |
10
+ | **full_name** | **String** | Full name of the individual. | [optional] |
11
+ | **suffix** | **String** | Suffix of the individual | [optional] |
12
+ | **phone_number** | **String** | The phone number (with preceding + character and country code) of the individual being verified | [optional] |
13
+ | **address** | [**KnownAddress**](KnownAddress.md) | The address of the individual being verified | [optional] |
14
+ | **date_of_birth** | **String** | Date of birth of the individual, in the format \"YYYY-MM-DD\" | [optional] |
15
+
16
+ ## Example
17
+
18
+ ```ruby
19
+ require 'trinsic_api'
20
+
21
+ instance = TrinsicApi::KnownPersonData.new(
22
+ given_name: John,
23
+ family_name: Doe,
24
+ middle_name: Jacob,
25
+ full_name: John Jacob Doe,
26
+ suffix: null,
27
+ phone_number: null,
28
+ address: null,
29
+ date_of_birth: null
30
+ )
31
+ ```
32
+
@@ -0,0 +1,18 @@
1
+ # TrinsicApi::MexicoCurpInput
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **curp** | **String** | The user's CURP number | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'trinsic_api'
13
+
14
+ instance = TrinsicApi::MexicoCurpInput.new(
15
+ curp: null
16
+ )
17
+ ```
18
+