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
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: fa14bb9bd00b017345d4f218e0c95a581467789d125e6abfaca16861b116c9cf
|
4
|
+
data.tar.gz: a5cd42b42828d252fecf19bf85464276a39a77302194601f83bea2582e1e6b67
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: '0699ad53215ddbea96c703f1f5bcecba64965b8b1dc23838497ac82cb5f45982ea728522d939f229d25c5f06664ee5dfbe180a1af30c4bac6bc7d880fcbd41d6'
|
7
|
+
data.tar.gz: a27e0981198674c648dde26d63bd4a70fffbdd0f9e94a63c5e64c1ea192e3dab0c702472afb409203a8baecbca24fee80f698187281581d9d414db4825427632
|
data/README.md
CHANGED
@@ -38,7 +38,7 @@ attachments = TrinsicApi::AttachmentsApi.new
|
|
38
38
|
network = TrinsicApi::NetworkApi.new
|
39
39
|
sessions = TrinsicApi::SessionsApi.new
|
40
40
|
|
41
|
-
sessions.
|
41
|
+
sessions.create_widget_session({})
|
42
42
|
```
|
43
43
|
|
44
44
|
You can find a full Ruby server example in the [samples](https://github.com/trinsic-id/sdk/tree/main/api-ruby/samples) folder.
|
@@ -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
|
-
| **
|
11
|
+
| **subdivision** | **String** | | [optional] |
|
12
12
|
| **postal_code** | **String** | | [optional] |
|
13
13
|
| **country** | **String** | | [optional] |
|
14
|
-
| **full_address** | **String** |
|
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
|
-
|
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** |
|
8
|
-
| **document_front** | **String** |
|
9
|
-
| **document_back** | **String** |
|
10
|
-
| **document_portrait** | **String** |
|
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
|
|
data/docs/AttachmentsApi.md
CHANGED
@@ -13,7 +13,7 @@ All URIs are relative to *https://api.trinsic.id*
|
|
13
13
|
|
14
14
|
Get Attachment
|
15
15
|
|
16
|
-
Exchange an Attachment Access Key (from `IdentityData.Attachments`) for the raw contents of the attachment.
|
16
|
+
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.
|
17
17
|
|
18
18
|
### Examples
|
19
19
|
|
@@ -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,22 @@
|
|
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. | |
|
9
|
+
| **results_access_key** | **String** | The `resultsAccessKey` for the Acceptance Session. This is an encrypted payload which contains the decryption key necessary to access the Session's Data Vault. Save this securely in your systems; it must be passed back with any API call which requires access to the Session's Data Vault. Trinsic cannot access a Session's Data Vault without this key. | |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'trinsic_api'
|
15
|
+
|
16
|
+
instance = TrinsicApi::CreateHostedProviderSessionResponse.new(
|
17
|
+
session_id: null,
|
18
|
+
launch_url: https://api.trinsic.id/api/session/launch?clientToken=...,
|
19
|
+
results_access_key: 417zNGHMJp6Ht2jCoktTLNGDRZEt4BqTwwQ8Q9ZaQz8aS4Jd7nD1xff2WLhPS69j5q9QT4gvgV79Gv7QtaXwu5YC9Utr35...
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -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
|
+
| **recommendation_info** | [**RecommendationInfo**](RecommendationInfo.md) | Data that you already know about the user being verified. This data is used to improve the user experience during provider selection, by surfacing the most relevant providers first. | [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
|
+
recommendation_info: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# TrinsicApi::CreateWidgetSessionResponse
|
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 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. | |
|
9
|
+
| **results_access_key** | **String** | The `resultsAccessKey` for the Acceptance Session. This is an encrypted payload which contains the decryption key necessary to access the Session's Data Vault. Save this securely in your systems; it must be passed back with any API call which requires access to the Session's Data Vault. Trinsic cannot access a Session's Data Vault without this key. | |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'trinsic_api'
|
15
|
+
|
16
|
+
instance = TrinsicApi::CreateWidgetSessionResponse.new(
|
17
|
+
session_id: null,
|
18
|
+
launch_url: https://api.trinsic.id/api/session/launch?clientToken=...,
|
19
|
+
results_access_key: 417zNGHMJp6Ht2jCoktTLNGDRZEt4BqTwwQ8Q9ZaQz8aS4Jd7nD1xff2WLhPS69j5q9QT4gvgV79Gv7QtaXwu5YC9Utr35...
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
data/docs/DocumentData.md
CHANGED
@@ -4,10 +4,10 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **type** | **
|
7
|
+
| **type** | [**DocumentType**](DocumentType.md) | | [optional] |
|
8
8
|
| **number** | **String** | | [optional] |
|
9
|
-
| **issue_date** | **
|
10
|
-
| **expiration_date** | **
|
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
|
+
|
@@ -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,11 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **originating_provider_id** | **String** |
|
8
|
-
| **
|
9
|
-
| **
|
10
|
-
| **
|
7
|
+
| **originating_provider_id** | **String** | | [optional] |
|
8
|
+
| **originating_sub_provider_id** | **String** | | [optional] |
|
9
|
+
| **person** | [**PersonData**](PersonData.md) | | [optional] |
|
10
|
+
| **document** | [**DocumentData**](DocumentData.md) | | [optional] |
|
11
|
+
| **attachment_access_keys** | [**AttachmentAccessKeys**](AttachmentAccessKeys.md) | | [optional] |
|
11
12
|
|
12
13
|
## Example
|
13
14
|
|
@@ -16,6 +17,7 @@ require 'trinsic_api'
|
|
16
17
|
|
17
18
|
instance = TrinsicApi::IdentityData.new(
|
18
19
|
originating_provider_id: null,
|
20
|
+
originating_sub_provider_id: null,
|
19
21
|
person: null,
|
20
22
|
document: null,
|
21
23
|
attachment_access_keys: null
|
data/docs/IdinInput.md
ADDED
@@ -0,0 +1,18 @@
|
|
1
|
+
# TrinsicApi::IdinInput
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **sub_provider_id** | **String** | The ID of the specific bank to invoke with IDIN. If not specified, the user will be prompted to select a bank. | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'trinsic_api'
|
13
|
+
|
14
|
+
instance = TrinsicApi::IdinInput.new(
|
15
|
+
sub_provider_id: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -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::
|
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::
|
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,18 @@
|
|
1
|
+
# TrinsicApi::ListProviderContractsResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **provider_contracts** | [**Array<ProviderContract>**](ProviderContract.md) | Contracts for all Providers available to your App, filtered by your App's current test mode setting. | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'trinsic_api'
|
13
|
+
|
14
|
+
instance = TrinsicApi::ListProviderContractsResponse.new(
|
15
|
+
provider_contracts: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -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
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# TrinsicApi::MobileIdInput
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **mobile_id_phone_number** | **String** | The user's phone number in E.164 format | [optional] |
|
8
|
+
| **mobile_id_national_identity_number** | **String** | The user's National ID number | [optional] |
|
9
|
+
| **mobile_id_language** | [**Language**](Language.md) | The user's language -- LIT, EST, ENG, or RUS | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'trinsic_api'
|
15
|
+
|
16
|
+
instance = TrinsicApi::MobileIdInput.new(
|
17
|
+
mobile_id_phone_number: null,
|
18
|
+
mobile_id_national_identity_number: null,
|
19
|
+
mobile_id_language: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|