trinsic_api 1.2.0 → 2.0.0

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 (212) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/docs/AadhaarInput.md +20 -0
  4. data/docs/Address.md +3 -3
  5. data/docs/AttachmentAccessKeys.md +7 -5
  6. data/docs/AttachmentsApi.md +1 -1
  7. data/docs/BangladeshNationalIdInput.md +24 -0
  8. data/docs/BrazilCpfCheckInput.md +18 -0
  9. data/docs/BrazilDigitalCnhInput.md +24 -0
  10. data/docs/CreateAdvancedProviderSessionRequest.md +26 -0
  11. data/docs/CreateAdvancedProviderSessionResponse.md +22 -0
  12. data/docs/CreateHostedProviderSessionRequest.md +22 -0
  13. data/docs/CreateHostedProviderSessionResponse.md +22 -0
  14. data/docs/CreateWidgetSessionRequest.md +22 -0
  15. data/docs/CreateWidgetSessionResponse.md +22 -0
  16. data/docs/DocumentData.md +3 -3
  17. data/docs/DocumentScanAttachments.md +18 -0
  18. data/docs/{SessionState.md → DocumentType.md} +2 -2
  19. data/docs/HttpValidationProblemDetails.md +28 -0
  20. data/docs/IdentityData.md +6 -4
  21. data/docs/IdinInput.md +18 -0
  22. data/docs/IndonesiaNikInput.md +22 -0
  23. data/docs/{FailureMessage.md → IntegrationCapability.md} +2 -5
  24. data/docs/IntegrationLaunchMethod.md +15 -0
  25. data/docs/IntegrationStep.md +22 -0
  26. data/docs/KenyaNidInput.md +28 -0
  27. data/docs/{SessionFailCode.md → Language.md} +2 -2
  28. data/docs/ListProviderContractsResponse.md +18 -0
  29. data/docs/MexicoCurpInput.md +18 -0
  30. data/docs/MobileIdInput.md +22 -0
  31. data/docs/NetworkApi.md +22 -25
  32. data/docs/NigeriaNinInput.md +30 -0
  33. data/docs/PersonData.md +14 -12
  34. data/docs/PhilippineMatchInput.md +26 -0
  35. data/docs/PhilippineQRInput.md +20 -0
  36. data/docs/ProblemDetails.md +26 -0
  37. data/docs/ProviderAttachments.md +18 -0
  38. data/docs/ProviderContract.md +46 -0
  39. data/docs/ProviderInformation.md +3 -3
  40. data/docs/ProviderInput.md +50 -0
  41. data/docs/RecommendRequest.md +2 -6
  42. data/docs/RecommendationInfo.md +24 -0
  43. data/docs/RefreshStepContentRequest.md +18 -0
  44. data/docs/RefreshStepContentResponse.md +18 -0
  45. data/docs/ResultCollection.md +20 -0
  46. data/docs/ResultCollectionMethod.md +15 -0
  47. data/docs/Session.md +6 -8
  48. data/docs/{VerificationFailCode.md → SessionErrorCode.md} +2 -2
  49. data/docs/SessionsApi.md +237 -19
  50. data/docs/Sex.md +15 -0
  51. data/docs/SmartIdInput.md +18 -0
  52. data/docs/SouthAfricaNidInput.md +24 -0
  53. data/docs/SpidInput.md +18 -0
  54. data/docs/StepRefreshInfo.md +22 -0
  55. data/docs/SubProviderMetadata.md +24 -0
  56. data/docs/TrinsicTestDatabaseLookupInput.md +24 -0
  57. data/docs/TrinsicTestSubProvidersInput.md +18 -0
  58. data/lib/trinsic_api/api/attachments_api.rb +3 -3
  59. data/lib/trinsic_api/api/network_api.rb +19 -25
  60. data/lib/trinsic_api/api/sessions_api.rb +219 -21
  61. data/lib/trinsic_api/api_client.rb +1 -1
  62. data/lib/trinsic_api/api_error.rb +1 -1
  63. data/lib/trinsic_api/configuration.rb +1 -1
  64. data/lib/trinsic_api/models/aadhaar_input.rb +227 -0
  65. data/lib/trinsic_api/models/address.rb +16 -10
  66. data/lib/trinsic_api/models/attachment_access_keys.rb +25 -10
  67. data/lib/trinsic_api/models/bangladesh_national_id_input.rb +249 -0
  68. data/lib/trinsic_api/models/brazil_cpf_check_input.rb +261 -0
  69. data/lib/trinsic_api/models/brazil_digital_cnh_input.rb +294 -0
  70. data/lib/trinsic_api/models/cancel_session_response.rb +1 -1
  71. data/lib/trinsic_api/models/create_advanced_provider_session_request.rb +312 -0
  72. data/lib/trinsic_api/models/create_advanced_provider_session_response.rb +256 -0
  73. data/lib/trinsic_api/models/create_hosted_provider_session_request.rb +288 -0
  74. data/lib/trinsic_api/models/create_hosted_provider_session_response.rb +256 -0
  75. data/lib/trinsic_api/models/create_widget_session_request.rb +240 -0
  76. data/lib/trinsic_api/models/create_widget_session_response.rb +256 -0
  77. data/lib/trinsic_api/models/document_data.rb +32 -4
  78. data/lib/trinsic_api/models/{failure_message.rb → document_scan_attachments.rb} +12 -18
  79. data/lib/trinsic_api/models/{session_state.rb → document_type.rb} +9 -11
  80. data/lib/trinsic_api/models/get_attachment_request.rb +1 -1
  81. data/lib/trinsic_api/models/get_attachment_response.rb +1 -1
  82. data/lib/trinsic_api/models/get_session_response.rb +1 -1
  83. data/lib/trinsic_api/models/get_session_result_request.rb +1 -1
  84. data/lib/trinsic_api/models/get_session_result_response.rb +2 -1
  85. data/lib/trinsic_api/models/{known_address.rb → http_validation_problem_details.rb} +55 -51
  86. data/lib/trinsic_api/models/identity_data.rb +16 -6
  87. data/lib/trinsic_api/models/{known_identity_data.rb → idin_input.rb} +13 -13
  88. data/lib/trinsic_api/models/{disclosed_fields_request.rb → indonesia_nik_input.rb} +94 -93
  89. data/lib/trinsic_api/models/integration_capability.rb +44 -0
  90. data/lib/trinsic_api/models/integration_launch_method.rb +42 -0
  91. data/lib/trinsic_api/models/integration_step.rb +275 -0
  92. data/lib/trinsic_api/models/kenya_nid_input.rb +397 -0
  93. data/lib/trinsic_api/models/language.rb +42 -0
  94. data/lib/trinsic_api/models/{validation_result.rb → list_provider_contracts_response.rb} +17 -25
  95. data/lib/trinsic_api/models/list_providers_response.rb +1 -1
  96. data/lib/trinsic_api/models/list_sessions_response.rb +1 -1
  97. data/lib/trinsic_api/models/{create_session_response.rb → mexico_curp_input.rb} +44 -26
  98. data/lib/trinsic_api/models/mobile_id_input.rb +260 -0
  99. data/lib/trinsic_api/models/nigeria_nin_input.rb +383 -0
  100. data/lib/trinsic_api/models/order_direction.rb +1 -1
  101. data/lib/trinsic_api/models/person_data.rb +50 -15
  102. data/lib/trinsic_api/models/{known_person_data.rb → philippine_match_input.rb} +28 -33
  103. data/lib/trinsic_api/models/philippine_qr_input.rb +227 -0
  104. data/lib/trinsic_api/models/{verification.rb → problem_details.rb} +49 -42
  105. data/lib/trinsic_api/models/provider_attachments.rb +215 -0
  106. data/lib/trinsic_api/models/provider_contract.rb +482 -0
  107. data/lib/trinsic_api/models/provider_info.rb +1 -1
  108. data/lib/trinsic_api/models/provider_information.rb +1 -1
  109. data/lib/trinsic_api/models/provider_input.rb +392 -0
  110. data/lib/trinsic_api/models/recommend_request.rb +10 -40
  111. data/lib/trinsic_api/models/recommend_response.rb +1 -1
  112. data/lib/trinsic_api/models/recommendation_info.rb +256 -0
  113. data/lib/trinsic_api/models/refresh_step_content_request.rb +216 -0
  114. data/lib/trinsic_api/models/{identity_lookup_response.rb → refresh_step_content_response.rb} +16 -16
  115. data/lib/trinsic_api/models/result_collection.rb +261 -0
  116. data/lib/trinsic_api/models/result_collection_method.rb +40 -0
  117. data/lib/trinsic_api/models/session.rb +32 -48
  118. data/lib/trinsic_api/models/session_error_code.rb +48 -0
  119. data/lib/trinsic_api/models/session_ordering.rb +1 -1
  120. data/lib/trinsic_api/models/sex.rb +42 -0
  121. data/lib/trinsic_api/models/smart_id_input.rb +216 -0
  122. data/lib/trinsic_api/models/{disclosed_fields.rb → south_africa_nid_input.rb} +107 -154
  123. data/lib/trinsic_api/models/spid_input.rb +216 -0
  124. data/lib/trinsic_api/models/step_refresh_info.rb +256 -0
  125. data/lib/trinsic_api/models/sub_provider_metadata.rb +274 -0
  126. data/lib/trinsic_api/models/trinsic_test_database_lookup_input.rb +249 -0
  127. data/lib/trinsic_api/models/trinsic_test_sub_providers_input.rb +216 -0
  128. data/lib/trinsic_api/version.rb +2 -2
  129. data/lib/trinsic_api.rb +45 -15
  130. data/spec/api/attachments_api_spec.rb +2 -2
  131. data/spec/api/network_api_spec.rb +8 -9
  132. data/spec/api/sessions_api_spec.rb +45 -8
  133. data/spec/models/{verification_spec.rb → aadhaar_input_spec.rb} +9 -9
  134. data/spec/models/address_spec.rb +2 -2
  135. data/spec/models/attachment_access_keys_spec.rb +7 -1
  136. data/spec/models/bangladesh_national_id_input_spec.rb +54 -0
  137. data/spec/models/{identity_lookup_response_spec.rb → brazil_cpf_check_input_spec.rb} +8 -8
  138. data/spec/models/brazil_digital_cnh_input_spec.rb +54 -0
  139. data/spec/models/cancel_session_response_spec.rb +1 -1
  140. data/spec/models/create_advanced_provider_session_request_spec.rb +60 -0
  141. data/spec/models/create_advanced_provider_session_response_spec.rb +48 -0
  142. data/spec/models/create_hosted_provider_session_request_spec.rb +48 -0
  143. data/spec/models/create_hosted_provider_session_response_spec.rb +48 -0
  144. data/spec/models/create_widget_session_request_spec.rb +48 -0
  145. data/spec/models/create_widget_session_response_spec.rb +48 -0
  146. data/spec/models/document_data_spec.rb +1 -1
  147. data/spec/models/document_scan_attachments_spec.rb +36 -0
  148. data/spec/models/{session_state_spec.rb → document_type_spec.rb} +7 -7
  149. data/spec/models/get_attachment_request_spec.rb +1 -1
  150. data/spec/models/get_attachment_response_spec.rb +1 -1
  151. data/spec/models/get_session_response_spec.rb +1 -1
  152. data/spec/models/get_session_result_request_spec.rb +1 -1
  153. data/spec/models/get_session_result_response_spec.rb +1 -1
  154. data/spec/models/http_validation_problem_details_spec.rb +66 -0
  155. data/spec/models/identity_data_spec.rb +7 -1
  156. data/spec/models/{failure_message_spec.rb → idin_input_spec.rb} +8 -8
  157. data/spec/models/indonesia_nik_input_spec.rb +48 -0
  158. data/spec/models/integration_capability_spec.rb +30 -0
  159. data/spec/models/integration_launch_method_spec.rb +30 -0
  160. data/spec/models/integration_step_spec.rb +48 -0
  161. data/spec/models/{known_person_data_spec.rb → kenya_nid_input_spec.rb} +13 -13
  162. data/spec/models/{session_fail_code_spec.rb → language_spec.rb} +7 -7
  163. data/spec/models/list_provider_contracts_response_spec.rb +36 -0
  164. data/spec/models/list_providers_response_spec.rb +1 -1
  165. data/spec/models/list_sessions_response_spec.rb +1 -1
  166. data/spec/models/{known_identity_data_spec.rb → mexico_curp_input_spec.rb} +8 -8
  167. data/spec/models/mobile_id_input_spec.rb +48 -0
  168. data/spec/models/{known_address_spec.rb → nigeria_nin_input_spec.rb} +14 -14
  169. data/spec/models/order_direction_spec.rb +1 -1
  170. data/spec/models/person_data_spec.rb +8 -2
  171. data/spec/models/{create_session_request_spec.rb → philippine_match_input_spec.rb} +12 -12
  172. data/spec/models/{create_session_response_spec.rb → philippine_qr_input_spec.rb} +9 -9
  173. data/spec/models/problem_details_spec.rb +60 -0
  174. data/spec/models/provider_attachments_spec.rb +36 -0
  175. data/spec/models/{disclosed_fields_request_spec.rb → provider_contract_spec.rb} +37 -19
  176. data/spec/models/provider_info_spec.rb +1 -1
  177. data/spec/models/provider_information_spec.rb +1 -1
  178. data/spec/models/{disclosed_fields_spec.rb → provider_input_spec.rb} +49 -19
  179. data/spec/models/recommend_request_spec.rb +2 -14
  180. data/spec/models/recommend_response_spec.rb +1 -1
  181. data/spec/models/recommendation_info_spec.rb +54 -0
  182. data/spec/models/refresh_step_content_request_spec.rb +36 -0
  183. data/spec/models/refresh_step_content_response_spec.rb +36 -0
  184. data/spec/models/result_collection_method_spec.rb +30 -0
  185. data/spec/models/{validation_result_spec.rb → result_collection_spec.rb} +9 -9
  186. data/spec/models/{verification_fail_code_spec.rb → session_error_code_spec.rb} +7 -7
  187. data/spec/models/session_ordering_spec.rb +1 -1
  188. data/spec/models/session_spec.rb +4 -10
  189. data/spec/models/sex_spec.rb +30 -0
  190. data/spec/models/smart_id_input_spec.rb +36 -0
  191. data/spec/models/south_africa_nid_input_spec.rb +54 -0
  192. data/spec/models/spid_input_spec.rb +36 -0
  193. data/spec/models/step_refresh_info_spec.rb +48 -0
  194. data/spec/models/sub_provider_metadata_spec.rb +54 -0
  195. data/spec/models/trinsic_test_database_lookup_input_spec.rb +54 -0
  196. data/spec/models/trinsic_test_sub_providers_input_spec.rb +36 -0
  197. data/spec/spec_helper.rb +1 -1
  198. data/trinsic_api.gemspec +1 -1
  199. metadata +195 -75
  200. data/docs/CreateSessionRequest.md +0 -26
  201. data/docs/CreateSessionResponse.md +0 -20
  202. data/docs/DisclosedFields.md +0 -40
  203. data/docs/DisclosedFieldsRequest.md +0 -40
  204. data/docs/IdentityLookupResponse.md +0 -18
  205. data/docs/KnownAddress.md +0 -30
  206. data/docs/KnownIdentityData.md +0 -18
  207. data/docs/KnownPersonData.md +0 -28
  208. data/docs/ValidationResult.md +0 -20
  209. data/docs/Verification.md +0 -20
  210. data/lib/trinsic_api/models/create_session_request.rb +0 -257
  211. data/lib/trinsic_api/models/session_fail_code.rb +0 -45
  212. data/lib/trinsic_api/models/verification_fail_code.rb +0 -44
data/docs/NetworkApi.md CHANGED
@@ -4,18 +4,18 @@ All URIs are relative to *https://api.trinsic.id*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
- | [**identity_lookup**](NetworkApi.md#identity_lookup) | **GET** /api/v1/network/identities/{phoneNumber} | Lookup Identity |
8
- | [**list_providers**](NetworkApi.md#list_providers) | **GET** /api/v1/network/providers | List Identity Providers |
7
+ | [**list_provider_contracts**](NetworkApi.md#list_provider_contracts) | **GET** /api/v1/network/providers/contracts | List Provider Contracts |
8
+ | [**list_providers**](NetworkApi.md#list_providers) | **GET** /api/v1/network/providers | List Providers |
9
9
  | [**recommend_providers**](NetworkApi.md#recommend_providers) | **POST** /api/v1/network/recommend | Recommend Providers |
10
10
 
11
11
 
12
- ## identity_lookup
12
+ ## list_provider_contracts
13
13
 
14
- > <IdentityLookupResponse> identity_lookup(phone_number)
14
+ > <ListProviderContractsResponse> list_provider_contracts
15
15
 
16
- Lookup Identity
16
+ List Provider Contracts
17
17
 
18
- Query the availability of an identity in the Trinsic Network by phone number
18
+ List the contracts for all Providers available to your App. If your App is in test mode, this call will only return Providers available in test mode. If your App is not in test mode, this call will only return Providers available in production.
19
19
 
20
20
  ### Examples
21
21
 
@@ -29,44 +29,41 @@ TrinsicApi.configure do |config|
29
29
  end
30
30
 
31
31
  api_instance = TrinsicApi::NetworkApi.new
32
- phone_number = 'phone_number_example' # String |
33
32
 
34
33
  begin
35
- # Lookup Identity
36
- result = api_instance.identity_lookup(phone_number)
34
+ # List Provider Contracts
35
+ result = api_instance.list_provider_contracts
37
36
  p result
38
37
  rescue TrinsicApi::ApiError => e
39
- puts "Error when calling NetworkApi->identity_lookup: #{e}"
38
+ puts "Error when calling NetworkApi->list_provider_contracts: #{e}"
40
39
  end
41
40
  ```
42
41
 
43
- #### Using the identity_lookup_with_http_info variant
42
+ #### Using the list_provider_contracts_with_http_info variant
44
43
 
45
44
  This returns an Array which contains the response data, status code and headers.
46
45
 
47
- > <Array(<IdentityLookupResponse>, Integer, Hash)> identity_lookup_with_http_info(phone_number)
46
+ > <Array(<ListProviderContractsResponse>, Integer, Hash)> list_provider_contracts_with_http_info
48
47
 
49
48
  ```ruby
50
49
  begin
51
- # Lookup Identity
52
- data, status_code, headers = api_instance.identity_lookup_with_http_info(phone_number)
50
+ # List Provider Contracts
51
+ data, status_code, headers = api_instance.list_provider_contracts_with_http_info
53
52
  p status_code # => 2xx
54
53
  p headers # => { ... }
55
- p data # => <IdentityLookupResponse>
54
+ p data # => <ListProviderContractsResponse>
56
55
  rescue TrinsicApi::ApiError => e
57
- puts "Error when calling NetworkApi->identity_lookup_with_http_info: #{e}"
56
+ puts "Error when calling NetworkApi->list_provider_contracts_with_http_info: #{e}"
58
57
  end
59
58
  ```
60
59
 
61
60
  ### Parameters
62
61
 
63
- | Name | Type | Description | Notes |
64
- | ---- | ---- | ----------- | ----- |
65
- | **phone_number** | **String** | | |
62
+ This endpoint does not need any parameter.
66
63
 
67
64
  ### Return type
68
65
 
69
- [**IdentityLookupResponse**](IdentityLookupResponse.md)
66
+ [**ListProviderContractsResponse**](ListProviderContractsResponse.md)
70
67
 
71
68
  ### Authorization
72
69
 
@@ -82,7 +79,7 @@ end
82
79
 
83
80
  > <ListProvidersResponse> list_providers
84
81
 
85
- List Identity Providers
82
+ List Providers
86
83
 
87
84
  List all identity providers available for use
88
85
 
@@ -100,7 +97,7 @@ end
100
97
  api_instance = TrinsicApi::NetworkApi.new
101
98
 
102
99
  begin
103
- # List Identity Providers
100
+ # List Providers
104
101
  result = api_instance.list_providers
105
102
  p result
106
103
  rescue TrinsicApi::ApiError => e
@@ -116,7 +113,7 @@ This returns an Array which contains the response data, status code and headers.
116
113
 
117
114
  ```ruby
118
115
  begin
119
- # List Identity Providers
116
+ # List Providers
120
117
  data, status_code, headers = api_instance.list_providers_with_http_info
121
118
  p status_code # => 2xx
122
119
  p headers # => { ... }
@@ -150,7 +147,7 @@ This endpoint does not need any parameter.
150
147
 
151
148
  Recommend Providers
152
149
 
153
- Generate provider recommendations based on the given signals (phone number, countries, states)
150
+ Generate provider recommendations based on the given signals (phone number, countries, states).
154
151
 
155
152
  ### Examples
156
153
 
@@ -165,7 +162,7 @@ end
165
162
 
166
163
  api_instance = TrinsicApi::NetworkApi.new
167
164
  opts = {
168
- recommend_request: TrinsicApi::RecommendRequest.new({phone_number: 'phone_number_example'}) # RecommendRequest |
165
+ recommend_request: TrinsicApi::RecommendRequest.new # RecommendRequest |
169
166
  }
170
167
 
171
168
  begin
@@ -0,0 +1,30 @@
1
+ # TrinsicApi::NigeriaNinInput
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **first_name** | **String** | The user&#39;s first name as it appears in their National ID | |
8
+ | **middle_name** | **String** | The user&#39;s middle name as it appears in their National ID (optional) | [optional] |
9
+ | **last_name** | **String** | The user&#39;s last name as it appears in their National ID (optional) | |
10
+ | **phone_number** | **String** | The user&#39;s phone number (optional) | [optional] |
11
+ | **date_of_birth** | **Date** | The user&#39;s date of birth, in &#x60;YYYY-MM-DD&#x60; format | |
12
+ | **gender** | **String** | The user&#39;s gender as it appears in their National ID (e.g., male, female) | [optional] |
13
+ | **national_id_number** | **String** | The user&#39;s South African National ID number | |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'trinsic_api'
19
+
20
+ instance = TrinsicApi::NigeriaNinInput.new(
21
+ first_name: null,
22
+ middle_name: null,
23
+ last_name: null,
24
+ phone_number: null,
25
+ date_of_birth: null,
26
+ gender: null,
27
+ national_id_number: null
28
+ )
29
+ ```
30
+
data/docs/PersonData.md CHANGED
@@ -4,15 +4,16 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
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** | The individual&#39;s full name as a single string. Useful for names which do not fit into a \&quot;first middle last\&quot; structure. | [optional] |
7
+ | **given_name** | **String** | | [optional] |
8
+ | **family_name** | **String** | | [optional] |
9
+ | **middle_name** | **String** | | [optional] |
10
+ | **full_name** | **String** | | [optional] |
11
+ | **suffix** | **String** | | [optional] |
11
12
  | **nationality** | **String** | | [optional] |
12
- | **gender** | **String** | | [optional] |
13
+ | **sex** | [**Sex**](Sex.md) | | [optional] |
13
14
  | **phone_number** | **String** | | [optional] |
14
- | **address** | [**Address**](Address.md) | Address information for an individual | [optional] |
15
- | **date_of_birth** | **String** | | [optional] |
15
+ | **address** | [**Address**](Address.md) | | [optional] |
16
+ | **date_of_birth** | **Date** | | [optional] |
16
17
 
17
18
  ## Example
18
19
 
@@ -20,12 +21,13 @@
20
21
  require 'trinsic_api'
21
22
 
22
23
  instance = TrinsicApi::PersonData.new(
23
- given_name: John,
24
- family_name: Doe,
25
- middle_name: Jacob,
26
- full_name: John Jacob de Doe,
24
+ given_name: null,
25
+ family_name: null,
26
+ middle_name: null,
27
+ full_name: null,
28
+ suffix: null,
27
29
  nationality: null,
28
- gender: null,
30
+ sex: null,
29
31
  phone_number: null,
30
32
  address: null,
31
33
  date_of_birth: null
@@ -0,0 +1,26 @@
1
+ # TrinsicApi::PhilippineMatchInput
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **given_name** | **String** | The user&#39;s given / first name | [optional] |
8
+ | **middle_name** | **String** | The user&#39;s middle name | [optional] |
9
+ | **family_name** | **String** | The user&#39;s family / last name | [optional] |
10
+ | **suffix** | **String** | The user&#39;s name suffix | [optional] |
11
+ | **date_of_birth** | **Date** | The user&#39;s date of birth, in &#x60;YYYY-MM-DD&#x60; format | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'trinsic_api'
17
+
18
+ instance = TrinsicApi::PhilippineMatchInput.new(
19
+ given_name: null,
20
+ middle_name: null,
21
+ family_name: null,
22
+ suffix: null,
23
+ date_of_birth: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,20 @@
1
+ # TrinsicApi::PhilippineQRInput
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **qr_code_text** | **String** | The raw text of the user&#39;s QR code after decoding it. | [optional] |
8
+ | **qr_code_image** | **String** | The raw bytes of the image containing the user&#39;s QR code. | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'trinsic_api'
14
+
15
+ instance = TrinsicApi::PhilippineQRInput.new(
16
+ qr_code_text: null,
17
+ qr_code_image: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,26 @@
1
+ # TrinsicApi::ProblemDetails
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
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'trinsic_api'
17
+
18
+ instance = TrinsicApi::ProblemDetails.new(
19
+ type: null,
20
+ title: null,
21
+ status: null,
22
+ detail: null,
23
+ instance: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,18 @@
1
+ # TrinsicApi::ProviderAttachments
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **document_scan** | [**DocumentScanAttachments**](DocumentScanAttachments.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'trinsic_api'
13
+
14
+ instance = TrinsicApi::ProviderAttachments.new(
15
+ document_scan: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,46 @@
1
+ # TrinsicApi::ProviderContract
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | The ID of the Provider for this contract. | |
8
+ | **name** | **String** | The Provider&#39;s Name as it appears in Trinsic&#39;s Dashboard and Widget | |
9
+ | **description** | **String** | The Provider&#39;s description as it appears in Trinsic&#39;s Widget. This is flavor text, not a full, human-readable description of the provider. | |
10
+ | **logo_url** | **String** | A URL pointing to the Provider&#39;s logo on Trinsic&#39;s CDN. May be a PNG, JPG, or SVG image. | |
11
+ | **available** | **Boolean** | Whether the Provider is available for use in your App. If &#x60;false&#x60;, you will need to contact Trinsic to enable this Provider for your App. | |
12
+ | **geography** | **Array&lt;String&gt;** | The geographies within the Regions the Provider is available. | |
13
+ | **regions** | **Array&lt;String&gt;** | The regions within which the Provider is available. | |
14
+ | **launch_method** | [**IntegrationLaunchMethod**](IntegrationLaunchMethod.md) | Relevant only to Advanced Provider Sessions. The &#x60;LaunchMethod&#x60; which must be supported to launch the Provider Session in Advanced Provider Sessions. | |
15
+ | **collection_method** | [**ResultCollectionMethod**](ResultCollectionMethod.md) | Relevant only to Advanced Provider Sessions. The &#x60;CollectionMethod&#x60; which must be supported to launch the Provider Session in Advanced Provider Sessions. | |
16
+ | **results_may_be_delayed_after_redirect** | **Boolean** | If &#x60;true&#x60;, then the results for this Provider may not be available immediately after the user is redirected back to your application. In this case, the &#x60;GetSessionResults&#x60; API must be called until results are available. This is an uncommon scenario, and typically only applies to Providers which use a biometric check or traditional document scan. | |
17
+ | **has_refreshable_content** | **Boolean** | Relevant only to Advanced Provider Sessions. Whether the Provider requires the &#x60;RefreshStepContent&#x60; capability. For example, Samsung Wallet&#39;s deep links expire every 30 seconds, and must be refreshed periodically for a resilient user flow. | |
18
+ | **requires_input** | **Boolean** | Relevant to Hosted Provider Sessions and Advanced Provider Sessions. If &#x60;true&#x60;, this Provider requires provider-specific input on Session creation. If this input is not provided, Trinsic&#39;s Hosted UI will be invoked to collect the input from the user. | |
19
+ | **has_trinsic_interface** | **Boolean** | Whether there exists a Trinsic-hosted UI for this Provider. This is &#x60;true&#x60; for any Provider which is not a simple, OIDC-like redirect flow. | |
20
+ | **supports_advanced_provider_sessions** | **Boolean** | Whether this Provider can be fully whitelabeled/OEMed through the Advanced Provider Sessions API. If &#x60;false&#x60;, the Provider may still be launched through Advanced Provider Sessions; however, it will necessarily require a Trinsic-hosted UI to function. | |
21
+ | **sub_providers** | [**Array&lt;SubProviderMetadata&gt;**](SubProviderMetadata.md) | Metadata about the sub-providers which are available for this Provider. For example, Italy&#39;s SPID is a Provider which aggregates access to multiple sub-providers. | [optional] |
22
+
23
+ ## Example
24
+
25
+ ```ruby
26
+ require 'trinsic_api'
27
+
28
+ instance = TrinsicApi::ProviderContract.new(
29
+ id: ca-mdl,
30
+ name: CA DMV,
31
+ description: dmv.ca.gov,
32
+ logo_url: https://content.trinsic.id/connect/integrations/ca-dmv.png,
33
+ available: true,
34
+ geography: [&quot;CA&quot;],
35
+ regions: [&quot;United States&quot;],
36
+ launch_method: null,
37
+ collection_method: null,
38
+ results_may_be_delayed_after_redirect: false,
39
+ has_refreshable_content: false,
40
+ requires_input: false,
41
+ has_trinsic_interface: true,
42
+ supports_advanced_provider_sessions: true,
43
+ sub_providers: null
44
+ )
45
+ ```
46
+
@@ -4,9 +4,9 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **provider_id** | **String** | | |
8
- | **provider_display_name** | **String** | | |
9
- | **provider_logo** | **String** | | |
7
+ | **provider_id** | **String** | | [readonly] |
8
+ | **provider_display_name** | **String** | | [readonly] |
9
+ | **provider_logo** | **String** | | [readonly] |
10
10
 
11
11
  ## Example
12
12
 
@@ -0,0 +1,50 @@
1
+ # TrinsicApi::ProviderInput
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **indonesia_nik** | [**IndonesiaNikInput**](IndonesiaNikInput.md) | Input for the &#x60;f-indonesia-nik&#x60; provider | [optional] |
8
+ | **mexico_curp** | [**MexicoCurpInput**](MexicoCurpInput.md) | Input for the &#x60;f-mexico-curp&#x60; provider | [optional] |
9
+ | **south_africa_nid** | [**SouthAfricaNidInput**](SouthAfricaNidInput.md) | Input for the &#x60;f-south-africa-nid&#x60; provider | [optional] |
10
+ | **kenya_nid** | [**KenyaNidInput**](KenyaNidInput.md) | Input for the &#x60;f-kenya-nid&#x60; provider | [optional] |
11
+ | **nigeria_nin** | [**NigeriaNinInput**](NigeriaNinInput.md) | Input for the &#x60;f-nigeria-nin&#x60; provider | [optional] |
12
+ | **aadhaar** | [**AadhaarInput**](AadhaarInput.md) | Input for the &#x60;f-india-aadhaar-match&#x60; provider | [optional] |
13
+ | **bangladesh_national_id** | [**BangladeshNationalIdInput**](BangladeshNationalIdInput.md) | Input for the &#x60;bangladesh-nid&#x60; provider | [optional] |
14
+ | **brazil_cpf_check** | [**BrazilCpfCheckInput**](BrazilCpfCheckInput.md) | Input for the &#x60;g-brazil-cpf&#x60; provider | [optional] |
15
+ | **brazil_digital_cnh** | [**BrazilDigitalCnhInput**](BrazilDigitalCnhInput.md) | Input for the &#x60;g-brazil-digital-cnh&#x60; provider | [optional] |
16
+ | **philippine_match** | [**PhilippineMatchInput**](PhilippineMatchInput.md) | Input for the &#x60;b-philsys-biometric&#x60; provider | [optional] |
17
+ | **philippine_qr** | [**PhilippineQRInput**](PhilippineQRInput.md) | Input for the &#x60;b-philippine-qr-digital-national-id&#x60; and &#x60;b-philippine-qr-ephill-id&#x60; providers | [optional] |
18
+ | **smart_id** | [**SmartIdInput**](SmartIdInput.md) | Input for the &#x60;smart-id&#x60; provider | [optional] |
19
+ | **mobile_id** | [**MobileIdInput**](MobileIdInput.md) | Input for the &#x60;mobile-id&#x60; provider | [optional] |
20
+ | **idin** | [**IdinInput**](IdinInput.md) | Input for the &#x60;idin&#x60; provider | [optional] |
21
+ | **spid** | [**SpidInput**](SpidInput.md) | Input for the &#x60;spid&#x60; provider | [optional] |
22
+ | **trinsic_test_database_lookup** | [**TrinsicTestDatabaseLookupInput**](TrinsicTestDatabaseLookupInput.md) | *TEST MODE ONLY.* Input for the &#x60;trinsic-test-database-lookup&#x60; provider | [optional] |
23
+ | **trinsic_test_sub_providers** | [**TrinsicTestSubProvidersInput**](TrinsicTestSubProvidersInput.md) | *TEST MODE ONLY.* Input for the &#x60;trinsic-test-sub-providers&#x60; provider | [optional] |
24
+
25
+ ## Example
26
+
27
+ ```ruby
28
+ require 'trinsic_api'
29
+
30
+ instance = TrinsicApi::ProviderInput.new(
31
+ indonesia_nik: null,
32
+ mexico_curp: null,
33
+ south_africa_nid: null,
34
+ kenya_nid: null,
35
+ nigeria_nin: null,
36
+ aadhaar: null,
37
+ bangladesh_national_id: null,
38
+ brazil_cpf_check: null,
39
+ brazil_digital_cnh: null,
40
+ philippine_match: null,
41
+ philippine_qr: null,
42
+ smart_id: null,
43
+ mobile_id: null,
44
+ idin: null,
45
+ spid: null,
46
+ trinsic_test_database_lookup: null,
47
+ trinsic_test_sub_providers: null
48
+ )
49
+ ```
50
+
@@ -4,9 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **phone_number** | **String** | The phone number of the user you whish to generate a recommendation for. Will be used to lookup the user&#39;s identity in the network | |
8
- | **countries** | **Array&lt;String&gt;** | A list of countries, in alpha-2 ISO 3166 format, you wish to specify for the recommendation, this can include the user&#39;s country of residence, nationality, etc. | [optional] |
9
- | **states** | **Array&lt;String&gt;** | If one of the countries is US, you can specify a list of US states to further refine the recommendation (e.g., CA, UT, NY) | [optional] |
7
+ | **recommendation_info** | [**RecommendationInfo**](RecommendationInfo.md) | Information about the user you wish to generate a recommendation for. | [optional] |
10
8
 
11
9
  ## Example
12
10
 
@@ -14,9 +12,7 @@
14
12
  require 'trinsic_api'
15
13
 
16
14
  instance = TrinsicApi::RecommendRequest.new(
17
- phone_number: null,
18
- countries: null,
19
- states: null
15
+ recommendation_info: null
20
16
  )
21
17
  ```
22
18
 
@@ -0,0 +1,24 @@
1
+ # TrinsicApi::RecommendationInfo
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **phone_number** | **String** | The phone number of the user you wish to generate a recommendation for. Will be used to look up the user&#39;s identity in the network, as well as to determine the user&#39;s geographic location. | [optional] |
8
+ | **countries** | **Array&lt;String&gt;** | A list of countries, in alpha-2 ISO 3166 format, which the user is related to. This can include the user&#39;s country of residence, nationality, etc. | [optional] |
9
+ | **subdivisions** | **Array&lt;String&gt;** | If one of the countries has subdivisions (for example: US states), specify those related to the user here (e.g., CA, UT, NY) | [optional] |
10
+ | **ip_addresses** | **Array&lt;String&gt;** | Any IP addresses related to the user. Will be used to determine the user&#39;s geographic location. | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'trinsic_api'
16
+
17
+ instance = TrinsicApi::RecommendationInfo.new(
18
+ phone_number: null,
19
+ countries: null,
20
+ subdivisions: null,
21
+ ip_addresses: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,18 @@
1
+ # TrinsicApi::RefreshStepContentRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **results_access_key** | **String** | The &#x60;ResultsAccessKey&#x60; returned when the Session was created | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'trinsic_api'
13
+
14
+ instance = TrinsicApi::RefreshStepContentRequest.new(
15
+ results_access_key: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,18 @@
1
+ # TrinsicApi::RefreshStepContentResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **next_step** | [**IntegrationStep**](IntegrationStep.md) | The integration&#39;s next step with refreshed content | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'trinsic_api'
13
+
14
+ instance = TrinsicApi::RefreshStepContentResponse.new(
15
+ next_step: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,20 @@
1
+ # TrinsicApi::ResultCollection
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **method** | [**ResultCollectionMethod**](ResultCollectionMethod.md) | The method by which the results of the Acceptance Session should be collected. | |
8
+ | **results_access_key** | **String** | The &#x60;resultsAccessKey&#x60; for the Acceptance Session. This is an encrypted payload which contains the decryption key necessary to access the Session&#39;s Data Vault. Save this securely in your systems; it must be passed back with any API call which requires access to the Session&#39;s Data Vault. Trinsic cannot access a Session&#39;s Data Vault without this key. | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'trinsic_api'
14
+
15
+ instance = TrinsicApi::ResultCollection.new(
16
+ method: null,
17
+ results_access_key: 417zNGHMJp6Ht2jCoktTLNGDRZEt4BqTwwQ8Q9ZaQz8aS4Jd7nD1xff2WLhPS69j5q9QT4gvgV79Gv7QtaXwu5YC9Utr35...
18
+ )
19
+ ```
20
+
@@ -0,0 +1,15 @@
1
+ # TrinsicApi::ResultCollectionMethod
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'trinsic_api'
12
+
13
+ instance = TrinsicApi::ResultCollectionMethod.new()
14
+ ```
15
+
data/docs/Session.md CHANGED
@@ -5,10 +5,9 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **id** | **String** | | |
8
- | **state** | [**SessionState**](SessionState.md) | The state of the session | |
9
- | **fail_code** | [**SessionFailCode**](SessionFailCode.md) | If the session is in state &#x60;IdvFailed&#x60;, this field contains the reason for failure. | [optional] |
10
- | **verification** | [**Verification**](Verification.md) | The underlying verification for this Session | |
11
- | **disclosed_fields** | [**DisclosedFields**](DisclosedFields.md) | The fields that were requested to be disclosed when the Session was created | |
8
+ | **done** | **Boolean** | Whether the Session is in a terminal / final state. If this is &#x60;true&#x60;, inspect the value of &#x60;Success&#x60; to determine whether the Session was successful. | |
9
+ | **success** | **Boolean** | Whether the Session has completed successfully. If this is &#x60;false&#x60;, the Session is either not yet done, or has failed. Inspect &#x60;Done&#x60; and &#x60;ErrorCode&#x60; for more information. If this is &#x60;true&#x60;, the Session has completed successfully. | |
10
+ | **error_code** | [**SessionErrorCode**](SessionErrorCode.md) | The reason for the Session&#39;s failure. Only present if &#x60;Success&#x60; is &#x60;false&#x60;. | [optional] |
12
11
  | **created** | **Integer** | The unix timestamp, in seconds, when this session was created | |
13
12
  | **updated** | **Integer** | The unix timestamp, in seconds, when this session&#39;s state last changed | |
14
13
 
@@ -19,10 +18,9 @@ require 'trinsic_api'
19
18
 
20
19
  instance = TrinsicApi::Session.new(
21
20
  id: 678c1ff6-2178-49e7-81d2-548afb6f85ec,
22
- state: null,
23
- fail_code: null,
24
- verification: null,
25
- disclosed_fields: null,
21
+ done: null,
22
+ success: null,
23
+ error_code: null,
26
24
  created: 1722526411,
27
25
  updated: 1722526722
28
26
  )
@@ -1,4 +1,4 @@
1
- # TrinsicApi::VerificationFailCode
1
+ # TrinsicApi::SessionErrorCode
2
2
 
3
3
  ## Properties
4
4
 
@@ -10,6 +10,6 @@
10
10
  ```ruby
11
11
  require 'trinsic_api'
12
12
 
13
- instance = TrinsicApi::VerificationFailCode.new()
13
+ instance = TrinsicApi::SessionErrorCode.new()
14
14
  ```
15
15