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.
- checksums.yaml +4 -4
- data/README.md +1 -1
- data/docs/AadhaarInput.md +20 -0
- data/docs/Address.md +3 -3
- data/docs/AttachmentAccessKeys.md +7 -5
- data/docs/AttachmentsApi.md +1 -1
- data/docs/BangladeshNationalIdInput.md +24 -0
- data/docs/BrazilCpfCheckInput.md +18 -0
- data/docs/BrazilDigitalCnhInput.md +24 -0
- data/docs/CreateAdvancedProviderSessionRequest.md +26 -0
- data/docs/CreateAdvancedProviderSessionResponse.md +22 -0
- data/docs/CreateHostedProviderSessionRequest.md +22 -0
- data/docs/CreateHostedProviderSessionResponse.md +22 -0
- data/docs/CreateWidgetSessionRequest.md +22 -0
- data/docs/CreateWidgetSessionResponse.md +22 -0
- data/docs/DocumentData.md +3 -3
- data/docs/DocumentScanAttachments.md +18 -0
- data/docs/{SessionState.md → DocumentType.md} +2 -2
- data/docs/HttpValidationProblemDetails.md +28 -0
- data/docs/IdentityData.md +6 -4
- data/docs/IdinInput.md +18 -0
- data/docs/IndonesiaNikInput.md +22 -0
- data/docs/{FailureMessage.md → IntegrationCapability.md} +2 -5
- data/docs/IntegrationLaunchMethod.md +15 -0
- data/docs/IntegrationStep.md +22 -0
- data/docs/KenyaNidInput.md +28 -0
- data/docs/{SessionFailCode.md → Language.md} +2 -2
- data/docs/ListProviderContractsResponse.md +18 -0
- data/docs/MexicoCurpInput.md +18 -0
- data/docs/MobileIdInput.md +22 -0
- data/docs/NetworkApi.md +22 -25
- data/docs/NigeriaNinInput.md +30 -0
- data/docs/PersonData.md +14 -12
- data/docs/PhilippineMatchInput.md +26 -0
- data/docs/PhilippineQRInput.md +20 -0
- data/docs/ProblemDetails.md +26 -0
- data/docs/ProviderAttachments.md +18 -0
- data/docs/ProviderContract.md +46 -0
- data/docs/ProviderInformation.md +3 -3
- data/docs/ProviderInput.md +50 -0
- data/docs/RecommendRequest.md +2 -6
- data/docs/RecommendationInfo.md +24 -0
- data/docs/RefreshStepContentRequest.md +18 -0
- data/docs/RefreshStepContentResponse.md +18 -0
- data/docs/ResultCollection.md +20 -0
- data/docs/ResultCollectionMethod.md +15 -0
- data/docs/Session.md +6 -8
- data/docs/{VerificationFailCode.md → SessionErrorCode.md} +2 -2
- data/docs/SessionsApi.md +237 -19
- data/docs/Sex.md +15 -0
- data/docs/SmartIdInput.md +18 -0
- data/docs/SouthAfricaNidInput.md +24 -0
- data/docs/SpidInput.md +18 -0
- data/docs/StepRefreshInfo.md +22 -0
- data/docs/SubProviderMetadata.md +24 -0
- data/docs/TrinsicTestDatabaseLookupInput.md +24 -0
- data/docs/TrinsicTestSubProvidersInput.md +18 -0
- data/lib/trinsic_api/api/attachments_api.rb +3 -3
- data/lib/trinsic_api/api/network_api.rb +19 -25
- data/lib/trinsic_api/api/sessions_api.rb +219 -21
- data/lib/trinsic_api/api_client.rb +1 -1
- data/lib/trinsic_api/api_error.rb +1 -1
- data/lib/trinsic_api/configuration.rb +1 -1
- data/lib/trinsic_api/models/aadhaar_input.rb +227 -0
- data/lib/trinsic_api/models/address.rb +16 -10
- data/lib/trinsic_api/models/attachment_access_keys.rb +25 -10
- data/lib/trinsic_api/models/bangladesh_national_id_input.rb +249 -0
- data/lib/trinsic_api/models/brazil_cpf_check_input.rb +261 -0
- data/lib/trinsic_api/models/brazil_digital_cnh_input.rb +294 -0
- data/lib/trinsic_api/models/cancel_session_response.rb +1 -1
- data/lib/trinsic_api/models/create_advanced_provider_session_request.rb +312 -0
- data/lib/trinsic_api/models/create_advanced_provider_session_response.rb +256 -0
- data/lib/trinsic_api/models/create_hosted_provider_session_request.rb +288 -0
- data/lib/trinsic_api/models/create_hosted_provider_session_response.rb +256 -0
- data/lib/trinsic_api/models/create_widget_session_request.rb +240 -0
- data/lib/trinsic_api/models/create_widget_session_response.rb +256 -0
- data/lib/trinsic_api/models/document_data.rb +32 -4
- data/lib/trinsic_api/models/{failure_message.rb → document_scan_attachments.rb} +12 -18
- data/lib/trinsic_api/models/{session_state.rb → document_type.rb} +9 -11
- data/lib/trinsic_api/models/get_attachment_request.rb +1 -1
- data/lib/trinsic_api/models/get_attachment_response.rb +1 -1
- data/lib/trinsic_api/models/get_session_response.rb +1 -1
- data/lib/trinsic_api/models/get_session_result_request.rb +1 -1
- data/lib/trinsic_api/models/get_session_result_response.rb +2 -1
- data/lib/trinsic_api/models/{known_address.rb → http_validation_problem_details.rb} +55 -51
- data/lib/trinsic_api/models/identity_data.rb +16 -6
- data/lib/trinsic_api/models/{known_identity_data.rb → idin_input.rb} +13 -13
- data/lib/trinsic_api/models/{disclosed_fields_request.rb → indonesia_nik_input.rb} +94 -93
- data/lib/trinsic_api/models/integration_capability.rb +44 -0
- data/lib/trinsic_api/models/integration_launch_method.rb +42 -0
- data/lib/trinsic_api/models/integration_step.rb +275 -0
- data/lib/trinsic_api/models/kenya_nid_input.rb +397 -0
- data/lib/trinsic_api/models/language.rb +42 -0
- data/lib/trinsic_api/models/{validation_result.rb → list_provider_contracts_response.rb} +17 -25
- data/lib/trinsic_api/models/list_providers_response.rb +1 -1
- data/lib/trinsic_api/models/list_sessions_response.rb +1 -1
- data/lib/trinsic_api/models/{create_session_response.rb → mexico_curp_input.rb} +44 -26
- data/lib/trinsic_api/models/mobile_id_input.rb +260 -0
- data/lib/trinsic_api/models/nigeria_nin_input.rb +383 -0
- data/lib/trinsic_api/models/order_direction.rb +1 -1
- data/lib/trinsic_api/models/person_data.rb +50 -15
- data/lib/trinsic_api/models/{known_person_data.rb → philippine_match_input.rb} +28 -33
- data/lib/trinsic_api/models/philippine_qr_input.rb +227 -0
- data/lib/trinsic_api/models/{verification.rb → problem_details.rb} +49 -42
- data/lib/trinsic_api/models/provider_attachments.rb +215 -0
- data/lib/trinsic_api/models/provider_contract.rb +482 -0
- data/lib/trinsic_api/models/provider_info.rb +1 -1
- data/lib/trinsic_api/models/provider_information.rb +1 -1
- data/lib/trinsic_api/models/provider_input.rb +392 -0
- data/lib/trinsic_api/models/recommend_request.rb +10 -40
- data/lib/trinsic_api/models/recommend_response.rb +1 -1
- data/lib/trinsic_api/models/recommendation_info.rb +256 -0
- data/lib/trinsic_api/models/refresh_step_content_request.rb +216 -0
- data/lib/trinsic_api/models/{identity_lookup_response.rb → refresh_step_content_response.rb} +16 -16
- data/lib/trinsic_api/models/result_collection.rb +261 -0
- data/lib/trinsic_api/models/result_collection_method.rb +40 -0
- data/lib/trinsic_api/models/session.rb +32 -48
- data/lib/trinsic_api/models/session_error_code.rb +48 -0
- data/lib/trinsic_api/models/session_ordering.rb +1 -1
- data/lib/trinsic_api/models/sex.rb +42 -0
- data/lib/trinsic_api/models/smart_id_input.rb +216 -0
- data/lib/trinsic_api/models/{disclosed_fields.rb → south_africa_nid_input.rb} +107 -154
- data/lib/trinsic_api/models/spid_input.rb +216 -0
- data/lib/trinsic_api/models/step_refresh_info.rb +256 -0
- data/lib/trinsic_api/models/sub_provider_metadata.rb +274 -0
- data/lib/trinsic_api/models/trinsic_test_database_lookup_input.rb +249 -0
- data/lib/trinsic_api/models/trinsic_test_sub_providers_input.rb +216 -0
- data/lib/trinsic_api/version.rb +2 -2
- data/lib/trinsic_api.rb +45 -15
- data/spec/api/attachments_api_spec.rb +2 -2
- data/spec/api/network_api_spec.rb +8 -9
- data/spec/api/sessions_api_spec.rb +45 -8
- data/spec/models/{verification_spec.rb → aadhaar_input_spec.rb} +9 -9
- data/spec/models/address_spec.rb +2 -2
- data/spec/models/attachment_access_keys_spec.rb +7 -1
- data/spec/models/bangladesh_national_id_input_spec.rb +54 -0
- data/spec/models/{identity_lookup_response_spec.rb → brazil_cpf_check_input_spec.rb} +8 -8
- data/spec/models/brazil_digital_cnh_input_spec.rb +54 -0
- data/spec/models/cancel_session_response_spec.rb +1 -1
- data/spec/models/create_advanced_provider_session_request_spec.rb +60 -0
- data/spec/models/create_advanced_provider_session_response_spec.rb +48 -0
- data/spec/models/create_hosted_provider_session_request_spec.rb +48 -0
- data/spec/models/create_hosted_provider_session_response_spec.rb +48 -0
- data/spec/models/create_widget_session_request_spec.rb +48 -0
- data/spec/models/create_widget_session_response_spec.rb +48 -0
- data/spec/models/document_data_spec.rb +1 -1
- data/spec/models/document_scan_attachments_spec.rb +36 -0
- data/spec/models/{session_state_spec.rb → document_type_spec.rb} +7 -7
- data/spec/models/get_attachment_request_spec.rb +1 -1
- data/spec/models/get_attachment_response_spec.rb +1 -1
- data/spec/models/get_session_response_spec.rb +1 -1
- data/spec/models/get_session_result_request_spec.rb +1 -1
- data/spec/models/get_session_result_response_spec.rb +1 -1
- data/spec/models/http_validation_problem_details_spec.rb +66 -0
- data/spec/models/identity_data_spec.rb +7 -1
- data/spec/models/{failure_message_spec.rb → idin_input_spec.rb} +8 -8
- data/spec/models/indonesia_nik_input_spec.rb +48 -0
- data/spec/models/integration_capability_spec.rb +30 -0
- data/spec/models/integration_launch_method_spec.rb +30 -0
- data/spec/models/integration_step_spec.rb +48 -0
- data/spec/models/{known_person_data_spec.rb → kenya_nid_input_spec.rb} +13 -13
- data/spec/models/{session_fail_code_spec.rb → language_spec.rb} +7 -7
- data/spec/models/list_provider_contracts_response_spec.rb +36 -0
- data/spec/models/list_providers_response_spec.rb +1 -1
- data/spec/models/list_sessions_response_spec.rb +1 -1
- data/spec/models/{known_identity_data_spec.rb → mexico_curp_input_spec.rb} +8 -8
- data/spec/models/mobile_id_input_spec.rb +48 -0
- data/spec/models/{known_address_spec.rb → nigeria_nin_input_spec.rb} +14 -14
- data/spec/models/order_direction_spec.rb +1 -1
- data/spec/models/person_data_spec.rb +8 -2
- data/spec/models/{create_session_request_spec.rb → philippine_match_input_spec.rb} +12 -12
- data/spec/models/{create_session_response_spec.rb → philippine_qr_input_spec.rb} +9 -9
- data/spec/models/problem_details_spec.rb +60 -0
- data/spec/models/provider_attachments_spec.rb +36 -0
- data/spec/models/{disclosed_fields_request_spec.rb → provider_contract_spec.rb} +37 -19
- data/spec/models/provider_info_spec.rb +1 -1
- data/spec/models/provider_information_spec.rb +1 -1
- data/spec/models/{disclosed_fields_spec.rb → provider_input_spec.rb} +49 -19
- data/spec/models/recommend_request_spec.rb +2 -14
- data/spec/models/recommend_response_spec.rb +1 -1
- data/spec/models/recommendation_info_spec.rb +54 -0
- data/spec/models/refresh_step_content_request_spec.rb +36 -0
- data/spec/models/refresh_step_content_response_spec.rb +36 -0
- data/spec/models/result_collection_method_spec.rb +30 -0
- data/spec/models/{validation_result_spec.rb → result_collection_spec.rb} +9 -9
- data/spec/models/{verification_fail_code_spec.rb → session_error_code_spec.rb} +7 -7
- data/spec/models/session_ordering_spec.rb +1 -1
- data/spec/models/session_spec.rb +4 -10
- data/spec/models/sex_spec.rb +30 -0
- data/spec/models/smart_id_input_spec.rb +36 -0
- data/spec/models/south_africa_nid_input_spec.rb +54 -0
- data/spec/models/spid_input_spec.rb +36 -0
- data/spec/models/step_refresh_info_spec.rb +48 -0
- data/spec/models/sub_provider_metadata_spec.rb +54 -0
- data/spec/models/trinsic_test_database_lookup_input_spec.rb +54 -0
- data/spec/models/trinsic_test_sub_providers_input_spec.rb +36 -0
- data/spec/spec_helper.rb +1 -1
- data/trinsic_api.gemspec +1 -1
- metadata +195 -75
- data/docs/CreateSessionRequest.md +0 -26
- data/docs/CreateSessionResponse.md +0 -20
- data/docs/DisclosedFields.md +0 -40
- data/docs/DisclosedFieldsRequest.md +0 -40
- data/docs/IdentityLookupResponse.md +0 -18
- data/docs/KnownAddress.md +0 -30
- data/docs/KnownIdentityData.md +0 -18
- data/docs/KnownPersonData.md +0 -28
- data/docs/ValidationResult.md +0 -20
- data/docs/Verification.md +0 -20
- data/lib/trinsic_api/models/create_session_request.rb +0 -257
- data/lib/trinsic_api/models/session_fail_code.rb +0 -45
- data/lib/trinsic_api/models/verification_fail_code.rb +0 -44
data/docs/SessionsApi.md
CHANGED
@@ -5,11 +5,14 @@ All URIs are relative to *https://api.trinsic.id*
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
7
|
| [**cancel_session**](SessionsApi.md#cancel_session) | **POST** /api/v1/sessions/{sessionId}/cancel | Cancel Session |
|
8
|
-
| [**
|
8
|
+
| [**create_advanced_provider_session**](SessionsApi.md#create_advanced_provider_session) | **POST** /api/v1/sessions/provider/advanced | Create Advanced Provider Session |
|
9
|
+
| [**create_hosted_provider_session**](SessionsApi.md#create_hosted_provider_session) | **POST** /api/v1/sessions/provider/hosted | Create Hosted Provider Session |
|
10
|
+
| [**create_widget_session**](SessionsApi.md#create_widget_session) | **POST** /api/v1/sessions/widget | Create Widget Session |
|
9
11
|
| [**get_session**](SessionsApi.md#get_session) | **GET** /api/v1/sessions/{sessionId} | Get Session |
|
10
12
|
| [**get_session_result**](SessionsApi.md#get_session_result) | **POST** /api/v1/sessions/{sessionId}/results | Get Session Results |
|
11
|
-
| [**list_sessions**](SessionsApi.md#list_sessions) | **GET** /api/v1/sessions | List Sessions |
|
13
|
+
| [**list_sessions**](SessionsApi.md#list_sessions) | **GET** /api/v1/sessions/list | List Sessions |
|
12
14
|
| [**redact_session**](SessionsApi.md#redact_session) | **POST** /api/v1/sessions/{sessionId}/redact | Redact Session |
|
15
|
+
| [**refresh_step_content**](SessionsApi.md#refresh_step_content) | **POST** /api/v1/sessions/{acceptanceSessionId}/step/refresh | Refresh Step Content |
|
13
16
|
|
14
17
|
|
15
18
|
## cancel_session
|
@@ -81,13 +84,13 @@ end
|
|
81
84
|
- **Accept**: text/plain, application/json, text/json
|
82
85
|
|
83
86
|
|
84
|
-
##
|
87
|
+
## create_advanced_provider_session
|
85
88
|
|
86
|
-
> <
|
89
|
+
> <CreateAdvancedProviderSessionResponse> create_advanced_provider_session(opts)
|
87
90
|
|
88
|
-
Create Session
|
91
|
+
Create Advanced Provider Session
|
89
92
|
|
90
|
-
|
93
|
+
Verify a user's identity with a specific provider, handling additional user interaction in your own UI. Signal which kinds of user interactions your UI can handle using the `Capabilities` field. If `FallbackToHostedUi` is `true`, Trinsic's hosted UI will automatically be invoked to handle any capabilities you do not support.
|
91
94
|
|
92
95
|
### Examples
|
93
96
|
|
@@ -102,33 +105,33 @@ end
|
|
102
105
|
|
103
106
|
api_instance = TrinsicApi::SessionsApi.new
|
104
107
|
opts = {
|
105
|
-
|
108
|
+
create_advanced_provider_session_request: TrinsicApi::CreateAdvancedProviderSessionRequest.new({provider: 'provider_example', capabilities: [TrinsicApi::IntegrationCapability::LAUNCH_BROWSER]}) # CreateAdvancedProviderSessionRequest |
|
106
109
|
}
|
107
110
|
|
108
111
|
begin
|
109
|
-
# Create Session
|
110
|
-
result = api_instance.
|
112
|
+
# Create Advanced Provider Session
|
113
|
+
result = api_instance.create_advanced_provider_session(opts)
|
111
114
|
p result
|
112
115
|
rescue TrinsicApi::ApiError => e
|
113
|
-
puts "Error when calling SessionsApi->
|
116
|
+
puts "Error when calling SessionsApi->create_advanced_provider_session: #{e}"
|
114
117
|
end
|
115
118
|
```
|
116
119
|
|
117
|
-
#### Using the
|
120
|
+
#### Using the create_advanced_provider_session_with_http_info variant
|
118
121
|
|
119
122
|
This returns an Array which contains the response data, status code and headers.
|
120
123
|
|
121
|
-
> <Array(<
|
124
|
+
> <Array(<CreateAdvancedProviderSessionResponse>, Integer, Hash)> create_advanced_provider_session_with_http_info(opts)
|
122
125
|
|
123
126
|
```ruby
|
124
127
|
begin
|
125
|
-
# Create Session
|
126
|
-
data, status_code, headers = api_instance.
|
128
|
+
# Create Advanced Provider Session
|
129
|
+
data, status_code, headers = api_instance.create_advanced_provider_session_with_http_info(opts)
|
127
130
|
p status_code # => 2xx
|
128
131
|
p headers # => { ... }
|
129
|
-
p data # => <
|
132
|
+
p data # => <CreateAdvancedProviderSessionResponse>
|
130
133
|
rescue TrinsicApi::ApiError => e
|
131
|
-
puts "Error when calling SessionsApi->
|
134
|
+
puts "Error when calling SessionsApi->create_advanced_provider_session_with_http_info: #{e}"
|
132
135
|
end
|
133
136
|
```
|
134
137
|
|
@@ -136,11 +139,153 @@ end
|
|
136
139
|
|
137
140
|
| Name | Type | Description | Notes |
|
138
141
|
| ---- | ---- | ----------- | ----- |
|
139
|
-
| **
|
142
|
+
| **create_advanced_provider_session_request** | [**CreateAdvancedProviderSessionRequest**](CreateAdvancedProviderSessionRequest.md) | | [optional] |
|
140
143
|
|
141
144
|
### Return type
|
142
145
|
|
143
|
-
[**
|
146
|
+
[**CreateAdvancedProviderSessionResponse**](CreateAdvancedProviderSessionResponse.md)
|
147
|
+
|
148
|
+
### Authorization
|
149
|
+
|
150
|
+
[Bearer](../README.md#Bearer)
|
151
|
+
|
152
|
+
### HTTP request headers
|
153
|
+
|
154
|
+
- **Content-Type**: application/json, text/json, application/*+json
|
155
|
+
- **Accept**: text/plain, application/json, text/json
|
156
|
+
|
157
|
+
|
158
|
+
## create_hosted_provider_session
|
159
|
+
|
160
|
+
> <CreateHostedProviderSessionResponse> create_hosted_provider_session(opts)
|
161
|
+
|
162
|
+
Create Hosted Provider Session
|
163
|
+
|
164
|
+
Verify a user's identity with a specific provider, using Trinsic-hosted UI for providers which require additional user interaction.
|
165
|
+
|
166
|
+
### Examples
|
167
|
+
|
168
|
+
```ruby
|
169
|
+
require 'time'
|
170
|
+
require 'trinsic_api'
|
171
|
+
# setup authorization
|
172
|
+
TrinsicApi.configure do |config|
|
173
|
+
# Configure Bearer authorization: Bearer
|
174
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
175
|
+
end
|
176
|
+
|
177
|
+
api_instance = TrinsicApi::SessionsApi.new
|
178
|
+
opts = {
|
179
|
+
create_hosted_provider_session_request: TrinsicApi::CreateHostedProviderSessionRequest.new({provider: 'provider_example', redirect_url: 'redirect_url_example'}) # CreateHostedProviderSessionRequest |
|
180
|
+
}
|
181
|
+
|
182
|
+
begin
|
183
|
+
# Create Hosted Provider Session
|
184
|
+
result = api_instance.create_hosted_provider_session(opts)
|
185
|
+
p result
|
186
|
+
rescue TrinsicApi::ApiError => e
|
187
|
+
puts "Error when calling SessionsApi->create_hosted_provider_session: #{e}"
|
188
|
+
end
|
189
|
+
```
|
190
|
+
|
191
|
+
#### Using the create_hosted_provider_session_with_http_info variant
|
192
|
+
|
193
|
+
This returns an Array which contains the response data, status code and headers.
|
194
|
+
|
195
|
+
> <Array(<CreateHostedProviderSessionResponse>, Integer, Hash)> create_hosted_provider_session_with_http_info(opts)
|
196
|
+
|
197
|
+
```ruby
|
198
|
+
begin
|
199
|
+
# Create Hosted Provider Session
|
200
|
+
data, status_code, headers = api_instance.create_hosted_provider_session_with_http_info(opts)
|
201
|
+
p status_code # => 2xx
|
202
|
+
p headers # => { ... }
|
203
|
+
p data # => <CreateHostedProviderSessionResponse>
|
204
|
+
rescue TrinsicApi::ApiError => e
|
205
|
+
puts "Error when calling SessionsApi->create_hosted_provider_session_with_http_info: #{e}"
|
206
|
+
end
|
207
|
+
```
|
208
|
+
|
209
|
+
### Parameters
|
210
|
+
|
211
|
+
| Name | Type | Description | Notes |
|
212
|
+
| ---- | ---- | ----------- | ----- |
|
213
|
+
| **create_hosted_provider_session_request** | [**CreateHostedProviderSessionRequest**](CreateHostedProviderSessionRequest.md) | | [optional] |
|
214
|
+
|
215
|
+
### Return type
|
216
|
+
|
217
|
+
[**CreateHostedProviderSessionResponse**](CreateHostedProviderSessionResponse.md)
|
218
|
+
|
219
|
+
### Authorization
|
220
|
+
|
221
|
+
[Bearer](../README.md#Bearer)
|
222
|
+
|
223
|
+
### HTTP request headers
|
224
|
+
|
225
|
+
- **Content-Type**: application/json, text/json, application/*+json
|
226
|
+
- **Accept**: text/plain, application/json, text/json
|
227
|
+
|
228
|
+
|
229
|
+
## create_widget_session
|
230
|
+
|
231
|
+
> <CreateWidgetSessionResponse> create_widget_session(opts)
|
232
|
+
|
233
|
+
Create Widget Session
|
234
|
+
|
235
|
+
Verify a user's identity using Trinsic's hosted Widget flow.
|
236
|
+
|
237
|
+
### Examples
|
238
|
+
|
239
|
+
```ruby
|
240
|
+
require 'time'
|
241
|
+
require 'trinsic_api'
|
242
|
+
# setup authorization
|
243
|
+
TrinsicApi.configure do |config|
|
244
|
+
# Configure Bearer authorization: Bearer
|
245
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
246
|
+
end
|
247
|
+
|
248
|
+
api_instance = TrinsicApi::SessionsApi.new
|
249
|
+
opts = {
|
250
|
+
create_widget_session_request: TrinsicApi::CreateWidgetSessionRequest.new # CreateWidgetSessionRequest |
|
251
|
+
}
|
252
|
+
|
253
|
+
begin
|
254
|
+
# Create Widget Session
|
255
|
+
result = api_instance.create_widget_session(opts)
|
256
|
+
p result
|
257
|
+
rescue TrinsicApi::ApiError => e
|
258
|
+
puts "Error when calling SessionsApi->create_widget_session: #{e}"
|
259
|
+
end
|
260
|
+
```
|
261
|
+
|
262
|
+
#### Using the create_widget_session_with_http_info variant
|
263
|
+
|
264
|
+
This returns an Array which contains the response data, status code and headers.
|
265
|
+
|
266
|
+
> <Array(<CreateWidgetSessionResponse>, Integer, Hash)> create_widget_session_with_http_info(opts)
|
267
|
+
|
268
|
+
```ruby
|
269
|
+
begin
|
270
|
+
# Create Widget Session
|
271
|
+
data, status_code, headers = api_instance.create_widget_session_with_http_info(opts)
|
272
|
+
p status_code # => 2xx
|
273
|
+
p headers # => { ... }
|
274
|
+
p data # => <CreateWidgetSessionResponse>
|
275
|
+
rescue TrinsicApi::ApiError => e
|
276
|
+
puts "Error when calling SessionsApi->create_widget_session_with_http_info: #{e}"
|
277
|
+
end
|
278
|
+
```
|
279
|
+
|
280
|
+
### Parameters
|
281
|
+
|
282
|
+
| Name | Type | Description | Notes |
|
283
|
+
| ---- | ---- | ----------- | ----- |
|
284
|
+
| **create_widget_session_request** | [**CreateWidgetSessionRequest**](CreateWidgetSessionRequest.md) | | [optional] |
|
285
|
+
|
286
|
+
### Return type
|
287
|
+
|
288
|
+
[**CreateWidgetSessionResponse**](CreateWidgetSessionResponse.md)
|
144
289
|
|
145
290
|
### Authorization
|
146
291
|
|
@@ -375,7 +520,7 @@ end
|
|
375
520
|
|
376
521
|
Redact Session
|
377
522
|
|
378
|
-
Redact a Session, removing all identity data from Trinsic's servers.
|
523
|
+
Redact a Session, removing all identity data from Trinsic's servers. Every application has a redaction period that dictates how long we will hold on to your users' PII data. Once a session falls outside the redaction cutoff date, all PII will automatically be removed from that session. You can utilize this endpoint to redact a session immediately. Identity data that a user has chosen to save in their passkey-protected wallet will not be deleted.
|
379
524
|
|
380
525
|
### Examples
|
381
526
|
|
@@ -436,3 +581,76 @@ nil (empty response body)
|
|
436
581
|
- **Content-Type**: Not defined
|
437
582
|
- **Accept**: application/json
|
438
583
|
|
584
|
+
|
585
|
+
## refresh_step_content
|
586
|
+
|
587
|
+
> <RefreshStepContentResponse> refresh_step_content(acceptance_session_id, opts)
|
588
|
+
|
589
|
+
Refresh Step Content
|
590
|
+
|
591
|
+
Refreshes the content of a Step for an Advanced Provider Session.
|
592
|
+
|
593
|
+
### Examples
|
594
|
+
|
595
|
+
```ruby
|
596
|
+
require 'time'
|
597
|
+
require 'trinsic_api'
|
598
|
+
# setup authorization
|
599
|
+
TrinsicApi.configure do |config|
|
600
|
+
# Configure Bearer authorization: Bearer
|
601
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
602
|
+
end
|
603
|
+
|
604
|
+
api_instance = TrinsicApi::SessionsApi.new
|
605
|
+
acceptance_session_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
606
|
+
opts = {
|
607
|
+
refresh_step_content_request: TrinsicApi::RefreshStepContentRequest.new # RefreshStepContentRequest |
|
608
|
+
}
|
609
|
+
|
610
|
+
begin
|
611
|
+
# Refresh Step Content
|
612
|
+
result = api_instance.refresh_step_content(acceptance_session_id, opts)
|
613
|
+
p result
|
614
|
+
rescue TrinsicApi::ApiError => e
|
615
|
+
puts "Error when calling SessionsApi->refresh_step_content: #{e}"
|
616
|
+
end
|
617
|
+
```
|
618
|
+
|
619
|
+
#### Using the refresh_step_content_with_http_info variant
|
620
|
+
|
621
|
+
This returns an Array which contains the response data, status code and headers.
|
622
|
+
|
623
|
+
> <Array(<RefreshStepContentResponse>, Integer, Hash)> refresh_step_content_with_http_info(acceptance_session_id, opts)
|
624
|
+
|
625
|
+
```ruby
|
626
|
+
begin
|
627
|
+
# Refresh Step Content
|
628
|
+
data, status_code, headers = api_instance.refresh_step_content_with_http_info(acceptance_session_id, opts)
|
629
|
+
p status_code # => 2xx
|
630
|
+
p headers # => { ... }
|
631
|
+
p data # => <RefreshStepContentResponse>
|
632
|
+
rescue TrinsicApi::ApiError => e
|
633
|
+
puts "Error when calling SessionsApi->refresh_step_content_with_http_info: #{e}"
|
634
|
+
end
|
635
|
+
```
|
636
|
+
|
637
|
+
### Parameters
|
638
|
+
|
639
|
+
| Name | Type | Description | Notes |
|
640
|
+
| ---- | ---- | ----------- | ----- |
|
641
|
+
| **acceptance_session_id** | **String** | | |
|
642
|
+
| **refresh_step_content_request** | [**RefreshStepContentRequest**](RefreshStepContentRequest.md) | | [optional] |
|
643
|
+
|
644
|
+
### Return type
|
645
|
+
|
646
|
+
[**RefreshStepContentResponse**](RefreshStepContentResponse.md)
|
647
|
+
|
648
|
+
### Authorization
|
649
|
+
|
650
|
+
[Bearer](../README.md#Bearer)
|
651
|
+
|
652
|
+
### HTTP request headers
|
653
|
+
|
654
|
+
- **Content-Type**: application/json, text/json, application/*+json
|
655
|
+
- **Accept**: text/plain, application/json, text/json
|
656
|
+
|
data/docs/Sex.md
ADDED
@@ -0,0 +1,18 @@
|
|
1
|
+
# TrinsicApi::SmartIdInput
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **smart_id_document_number** | **String** | The user's Smart ID Document Number | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'trinsic_api'
|
13
|
+
|
14
|
+
instance = TrinsicApi::SmartIdInput.new(
|
15
|
+
smart_id_document_number: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# TrinsicApi::SouthAfricaNidInput
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **full_name** | **String** | The user's full name as it appears in their National ID | |
|
8
|
+
| **date_of_birth** | **Date** | The user's date of birth, in `YYYY-MM-DD` format | |
|
9
|
+
| **gender** | **String** | The user's gender as it appears in their National ID (e.g., male, female) | |
|
10
|
+
| **national_id_number** | **String** | The user's South African National ID number | |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'trinsic_api'
|
16
|
+
|
17
|
+
instance = TrinsicApi::SouthAfricaNidInput.new(
|
18
|
+
full_name: null,
|
19
|
+
date_of_birth: null,
|
20
|
+
gender: null,
|
21
|
+
national_id_number: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
data/docs/SpidInput.md
ADDED
@@ -0,0 +1,18 @@
|
|
1
|
+
# TrinsicApi::SpidInput
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **sub_provider_id** | **String** | The ID of the specific IDP to invoke within SPID. If not specified, the user will be prompted to select an IDP. | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'trinsic_api'
|
13
|
+
|
14
|
+
instance = TrinsicApi::SpidInput.new(
|
15
|
+
sub_provider_id: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# TrinsicApi::StepRefreshInfo
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **expires_at** | **Time** | The UTC date/time at which the step `content` will expire and should no longer be used. Use the `Refresh Step Content` API to obtain a new value for `content`. | |
|
8
|
+
| **refresh_after** | **Time** | The UTC date/time after which Trinsic recommends you refresh the step `content`. | |
|
9
|
+
| **time_to_live_seconds** | **Integer** | The total lifetime of the step `content`. | |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'trinsic_api'
|
15
|
+
|
16
|
+
instance = TrinsicApi::StepRefreshInfo.new(
|
17
|
+
expires_at: null,
|
18
|
+
refresh_after: null,
|
19
|
+
time_to_live_seconds: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# TrinsicApi::SubProviderMetadata
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | The ID of the sub-provider. This cannot be used as a standalone Provider ID when creating a Session. It must be passed in via the Provider-specific input. | |
|
8
|
+
| **name** | **String** | The name of the sub-provider | |
|
9
|
+
| **description** | **String** | Flavor text for the sub-provider | |
|
10
|
+
| **logo_url** | **String** | A URL pointing to the logo on Trinsic's CDN. May be a PNG, JPG, or SVG image. | |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'trinsic_api'
|
16
|
+
|
17
|
+
instance = TrinsicApi::SubProviderMetadata.new(
|
18
|
+
id: null,
|
19
|
+
name: null,
|
20
|
+
description: null,
|
21
|
+
logo_url: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# TrinsicApi::TrinsicTestDatabaseLookupInput
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **given_name** | **String** | The given name to use for the output of the test Session. This is required; if not provided, Trinsic's Fallback UI will be invoked to collect it from the user. Can be any non-empty value. | [optional] |
|
8
|
+
| **family_name** | **String** | The family name to use for the output of the test Session. This is required; if not provided, Trinsic's Fallback UI will be invoked to collect it from the user. Can be any non-empty value. | [optional] |
|
9
|
+
| **identity_code** | **String** | A 6-digit code; must be \"123456\" for the Session to succeed. This is required; if not provided, Trinsic's Fallback UI will be invoked to collect it from the user. Any other value will cause the Session to fail. | [optional] |
|
10
|
+
| **selfie_base64** | **String** | An optional selfie image, base64-encoded. Will replace the existing test selfie attachment output if provided. | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'trinsic_api'
|
16
|
+
|
17
|
+
instance = TrinsicApi::TrinsicTestDatabaseLookupInput.new(
|
18
|
+
given_name: null,
|
19
|
+
family_name: null,
|
20
|
+
identity_code: null,
|
21
|
+
selfie_base64: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# TrinsicApi::TrinsicTestSubProvidersInput
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **sub_provider_id** | **String** | The ID of the specific IDP to invoke within the test federated provider. Valid options are `sub-provider-a` and `sub-provider-b`. If not specified, the user will be prompted to select one. | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'trinsic_api'
|
13
|
+
|
14
|
+
instance = TrinsicApi::TrinsicTestSubProvidersInput.new(
|
15
|
+
sub_provider_id: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -1,5 +1,5 @@
|
|
1
1
|
=begin
|
2
|
-
#
|
2
|
+
#Trinsic API
|
3
3
|
|
4
4
|
#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
5
5
|
|
@@ -20,7 +20,7 @@ module TrinsicApi
|
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
22
|
# Get Attachment
|
23
|
-
# Exchange an Attachment Access Key (from `IdentityData.Attachments`) for the raw contents of the attachment.
|
23
|
+
# Exchange an Attachment Access Key (from `IdentityData.Attachments`) for the raw contents of the attachment. Use this API to fetch document (front, back, portrait) or other (selfie) images from a verification, if relevant. In some cases, attachments may not be immediately available after a verification is completed. If so, this endpoint will return an HTTP 503 code, and you should try again later.
|
24
24
|
# @param [Hash] opts the optional parameters
|
25
25
|
# @option opts [GetAttachmentRequest] :get_attachment_request
|
26
26
|
# @return [GetAttachmentResponse]
|
@@ -30,7 +30,7 @@ module TrinsicApi
|
|
30
30
|
end
|
31
31
|
|
32
32
|
# Get Attachment
|
33
|
-
# Exchange an Attachment Access Key (from `IdentityData.Attachments`) for the raw contents of the attachment.
|
33
|
+
# Exchange an Attachment Access Key (from `IdentityData.Attachments`) for the raw contents of the attachment. Use this API to fetch document (front, back, portrait) or other (selfie) images from a verification, if relevant. In some cases, attachments may not be immediately available after a verification is completed. If so, this endpoint will return an HTTP 503 code, and you should try again later.
|
34
34
|
# @param [Hash] opts the optional parameters
|
35
35
|
# @option opts [GetAttachmentRequest] :get_attachment_request
|
36
36
|
# @return [Array<(GetAttachmentResponse, Integer, Hash)>] GetAttachmentResponse data, response status code and response headers
|
@@ -1,5 +1,5 @@
|
|
1
1
|
=begin
|
2
|
-
#
|
2
|
+
#Trinsic API
|
3
3
|
|
4
4
|
#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
5
5
|
|
@@ -19,31 +19,25 @@ module TrinsicApi
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
-
#
|
23
|
-
#
|
24
|
-
# @param phone_number [String]
|
22
|
+
# List Provider Contracts
|
23
|
+
# 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.
|
25
24
|
# @param [Hash] opts the optional parameters
|
26
|
-
# @return [
|
27
|
-
def
|
28
|
-
data, _status_code, _headers =
|
25
|
+
# @return [ListProviderContractsResponse]
|
26
|
+
def list_provider_contracts(opts = {})
|
27
|
+
data, _status_code, _headers = list_provider_contracts_with_http_info(opts)
|
29
28
|
data
|
30
29
|
end
|
31
30
|
|
32
|
-
#
|
33
|
-
#
|
34
|
-
# @param phone_number [String]
|
31
|
+
# List Provider Contracts
|
32
|
+
# 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.
|
35
33
|
# @param [Hash] opts the optional parameters
|
36
|
-
# @return [Array<(
|
37
|
-
def
|
34
|
+
# @return [Array<(ListProviderContractsResponse, Integer, Hash)>] ListProviderContractsResponse data, response status code and response headers
|
35
|
+
def list_provider_contracts_with_http_info(opts = {})
|
38
36
|
if @api_client.config.debugging
|
39
|
-
@api_client.config.logger.debug 'Calling API: NetworkApi.
|
40
|
-
end
|
41
|
-
# verify the required parameter 'phone_number' is set
|
42
|
-
if @api_client.config.client_side_validation && phone_number.nil?
|
43
|
-
fail ArgumentError, "Missing the required parameter 'phone_number' when calling NetworkApi.identity_lookup"
|
37
|
+
@api_client.config.logger.debug 'Calling API: NetworkApi.list_provider_contracts ...'
|
44
38
|
end
|
45
39
|
# resource path
|
46
|
-
local_var_path = '/api/v1/network/
|
40
|
+
local_var_path = '/api/v1/network/providers/contracts'
|
47
41
|
|
48
42
|
# query parameters
|
49
43
|
query_params = opts[:query_params] || {}
|
@@ -60,13 +54,13 @@ module TrinsicApi
|
|
60
54
|
post_body = opts[:debug_body]
|
61
55
|
|
62
56
|
# return_type
|
63
|
-
return_type = opts[:debug_return_type] || '
|
57
|
+
return_type = opts[:debug_return_type] || 'ListProviderContractsResponse'
|
64
58
|
|
65
59
|
# auth_names
|
66
60
|
auth_names = opts[:debug_auth_names] || ['Bearer']
|
67
61
|
|
68
62
|
new_options = opts.merge(
|
69
|
-
:operation => :"NetworkApi.
|
63
|
+
:operation => :"NetworkApi.list_provider_contracts",
|
70
64
|
:header_params => header_params,
|
71
65
|
:query_params => query_params,
|
72
66
|
:form_params => form_params,
|
@@ -77,12 +71,12 @@ module TrinsicApi
|
|
77
71
|
|
78
72
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
79
73
|
if @api_client.config.debugging
|
80
|
-
@api_client.config.logger.debug "API called: NetworkApi#
|
74
|
+
@api_client.config.logger.debug "API called: NetworkApi#list_provider_contracts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
81
75
|
end
|
82
76
|
return data, status_code, headers
|
83
77
|
end
|
84
78
|
|
85
|
-
# List
|
79
|
+
# List Providers
|
86
80
|
# List all identity providers available for use
|
87
81
|
# @param [Hash] opts the optional parameters
|
88
82
|
# @return [ListProvidersResponse]
|
@@ -91,7 +85,7 @@ module TrinsicApi
|
|
91
85
|
data
|
92
86
|
end
|
93
87
|
|
94
|
-
# List
|
88
|
+
# List Providers
|
95
89
|
# List all identity providers available for use
|
96
90
|
# @param [Hash] opts the optional parameters
|
97
91
|
# @return [Array<(ListProvidersResponse, Integer, Hash)>] ListProvidersResponse data, response status code and response headers
|
@@ -140,7 +134,7 @@ module TrinsicApi
|
|
140
134
|
end
|
141
135
|
|
142
136
|
# Recommend Providers
|
143
|
-
# Generate provider recommendations based on the given signals (phone number, countries, states)
|
137
|
+
# Generate provider recommendations based on the given signals (phone number, countries, states).
|
144
138
|
# @param [Hash] opts the optional parameters
|
145
139
|
# @option opts [RecommendRequest] :recommend_request
|
146
140
|
# @return [RecommendResponse]
|
@@ -150,7 +144,7 @@ module TrinsicApi
|
|
150
144
|
end
|
151
145
|
|
152
146
|
# Recommend Providers
|
153
|
-
# Generate provider recommendations based on the given signals (phone number, countries, states)
|
147
|
+
# Generate provider recommendations based on the given signals (phone number, countries, states).
|
154
148
|
# @param [Hash] opts the optional parameters
|
155
149
|
# @option opts [RecommendRequest] :recommend_request
|
156
150
|
# @return [Array<(RecommendResponse, Integer, Hash)>] RecommendResponse data, response status code and response headers
|