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/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
|
-
| [**
|
8
|
-
| [**list_providers**](NetworkApi.md#list_providers) | **GET** /api/v1/network/providers | List
|
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
|
-
##
|
12
|
+
## list_provider_contracts
|
13
13
|
|
14
|
-
> <
|
14
|
+
> <ListProviderContractsResponse> list_provider_contracts
|
15
15
|
|
16
|
-
|
16
|
+
List Provider Contracts
|
17
17
|
|
18
|
-
|
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
|
-
#
|
36
|
-
result = api_instance.
|
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->
|
38
|
+
puts "Error when calling NetworkApi->list_provider_contracts: #{e}"
|
40
39
|
end
|
41
40
|
```
|
42
41
|
|
43
|
-
#### Using the
|
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(<
|
46
|
+
> <Array(<ListProviderContractsResponse>, Integer, Hash)> list_provider_contracts_with_http_info
|
48
47
|
|
49
48
|
```ruby
|
50
49
|
begin
|
51
|
-
#
|
52
|
-
data, status_code, headers = api_instance.
|
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 # => <
|
54
|
+
p data # => <ListProviderContractsResponse>
|
56
55
|
rescue TrinsicApi::ApiError => e
|
57
|
-
puts "Error when calling NetworkApi->
|
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
|
-
|
64
|
-
| ---- | ---- | ----------- | ----- |
|
65
|
-
| **phone_number** | **String** | | |
|
62
|
+
This endpoint does not need any parameter.
|
66
63
|
|
67
64
|
### Return type
|
68
65
|
|
69
|
-
[**
|
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
|
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
|
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
|
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
|
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'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 last name as it appears in their National ID (optional) | |
|
10
|
+
| **phone_number** | **String** | The user's phone number (optional) | [optional] |
|
11
|
+
| **date_of_birth** | **Date** | The user's date of birth, in `YYYY-MM-DD` format | |
|
12
|
+
| **gender** | **String** | The user's gender as it appears in their National ID (e.g., male, female) | [optional] |
|
13
|
+
| **national_id_number** | **String** | The user'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** |
|
8
|
-
| **family_name** | **String** |
|
9
|
-
| **middle_name** | **String** |
|
10
|
-
| **full_name** | **String** |
|
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
|
-
| **
|
13
|
+
| **sex** | [**Sex**](Sex.md) | | [optional] |
|
13
14
|
| **phone_number** | **String** | | [optional] |
|
14
|
-
| **address** | [**Address**](Address.md) |
|
15
|
-
| **date_of_birth** | **
|
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:
|
24
|
-
family_name:
|
25
|
-
middle_name:
|
26
|
-
full_name:
|
24
|
+
given_name: null,
|
25
|
+
family_name: null,
|
26
|
+
middle_name: null,
|
27
|
+
full_name: null,
|
28
|
+
suffix: null,
|
27
29
|
nationality: null,
|
28
|
-
|
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's given / first name | [optional] |
|
8
|
+
| **middle_name** | **String** | The user's middle name | [optional] |
|
9
|
+
| **family_name** | **String** | The user's family / last name | [optional] |
|
10
|
+
| **suffix** | **String** | The user's name suffix | [optional] |
|
11
|
+
| **date_of_birth** | **Date** | The user's date of birth, in `YYYY-MM-DD` 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's QR code after decoding it. | [optional] |
|
8
|
+
| **qr_code_image** | **String** | The raw bytes of the image containing the user'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's Name as it appears in Trinsic's Dashboard and Widget | |
|
9
|
+
| **description** | **String** | The Provider's description as it appears in Trinsic'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's logo on Trinsic's CDN. May be a PNG, JPG, or SVG image. | |
|
11
|
+
| **available** | **Boolean** | Whether the Provider is available for use in your App. If `false`, you will need to contact Trinsic to enable this Provider for your App. | |
|
12
|
+
| **geography** | **Array<String>** | The geographies within the Regions the Provider is available. | |
|
13
|
+
| **regions** | **Array<String>** | The regions within which the Provider is available. | |
|
14
|
+
| **launch_method** | [**IntegrationLaunchMethod**](IntegrationLaunchMethod.md) | Relevant only to Advanced Provider Sessions. The `LaunchMethod` 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 `CollectionMethod` which must be supported to launch the Provider Session in Advanced Provider Sessions. | |
|
16
|
+
| **results_may_be_delayed_after_redirect** | **Boolean** | If `true`, then the results for this Provider may not be available immediately after the user is redirected back to your application. In this case, the `GetSessionResults` 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 `RefreshStepContent` capability. For example, Samsung Wallet'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 `true`, this Provider requires provider-specific input on Session creation. If this input is not provided, Trinsic'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 `true` 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 `false`, 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<SubProviderMetadata>**](SubProviderMetadata.md) | Metadata about the sub-providers which are available for this Provider. For example, Italy'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: ["CA"],
|
35
|
+
regions: ["United States"],
|
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
|
+
|
data/docs/ProviderInformation.md
CHANGED
@@ -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 `f-indonesia-nik` provider | [optional] |
|
8
|
+
| **mexico_curp** | [**MexicoCurpInput**](MexicoCurpInput.md) | Input for the `f-mexico-curp` provider | [optional] |
|
9
|
+
| **south_africa_nid** | [**SouthAfricaNidInput**](SouthAfricaNidInput.md) | Input for the `f-south-africa-nid` provider | [optional] |
|
10
|
+
| **kenya_nid** | [**KenyaNidInput**](KenyaNidInput.md) | Input for the `f-kenya-nid` provider | [optional] |
|
11
|
+
| **nigeria_nin** | [**NigeriaNinInput**](NigeriaNinInput.md) | Input for the `f-nigeria-nin` provider | [optional] |
|
12
|
+
| **aadhaar** | [**AadhaarInput**](AadhaarInput.md) | Input for the `f-india-aadhaar-match` provider | [optional] |
|
13
|
+
| **bangladesh_national_id** | [**BangladeshNationalIdInput**](BangladeshNationalIdInput.md) | Input for the `bangladesh-nid` provider | [optional] |
|
14
|
+
| **brazil_cpf_check** | [**BrazilCpfCheckInput**](BrazilCpfCheckInput.md) | Input for the `g-brazil-cpf` provider | [optional] |
|
15
|
+
| **brazil_digital_cnh** | [**BrazilDigitalCnhInput**](BrazilDigitalCnhInput.md) | Input for the `g-brazil-digital-cnh` provider | [optional] |
|
16
|
+
| **philippine_match** | [**PhilippineMatchInput**](PhilippineMatchInput.md) | Input for the `b-philsys-biometric` provider | [optional] |
|
17
|
+
| **philippine_qr** | [**PhilippineQRInput**](PhilippineQRInput.md) | Input for the `b-philippine-qr-digital-national-id` and `b-philippine-qr-ephill-id` providers | [optional] |
|
18
|
+
| **smart_id** | [**SmartIdInput**](SmartIdInput.md) | Input for the `smart-id` provider | [optional] |
|
19
|
+
| **mobile_id** | [**MobileIdInput**](MobileIdInput.md) | Input for the `mobile-id` provider | [optional] |
|
20
|
+
| **idin** | [**IdinInput**](IdinInput.md) | Input for the `idin` provider | [optional] |
|
21
|
+
| **spid** | [**SpidInput**](SpidInput.md) | Input for the `spid` provider | [optional] |
|
22
|
+
| **trinsic_test_database_lookup** | [**TrinsicTestDatabaseLookupInput**](TrinsicTestDatabaseLookupInput.md) | *TEST MODE ONLY.* Input for the `trinsic-test-database-lookup` provider | [optional] |
|
23
|
+
| **trinsic_test_sub_providers** | [**TrinsicTestSubProvidersInput**](TrinsicTestSubProvidersInput.md) | *TEST MODE ONLY.* Input for the `trinsic-test-sub-providers` 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
|
+
|
data/docs/RecommendRequest.md
CHANGED
@@ -4,9 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **
|
8
|
-
| **countries** | **Array<String>** | A list of countries, in alpha-2 ISO 3166 format, you wish to specify for the recommendation, this can include the user's country of residence, nationality, etc. | [optional] |
|
9
|
-
| **states** | **Array<String>** | 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
|
-
|
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's identity in the network, as well as to determine the user's geographic location. | [optional] |
|
8
|
+
| **countries** | **Array<String>** | A list of countries, in alpha-2 ISO 3166 format, which the user is related to. This can include the user's country of residence, nationality, etc. | [optional] |
|
9
|
+
| **subdivisions** | **Array<String>** | 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<String>** | Any IP addresses related to the user. Will be used to determine the user'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 `ResultsAccessKey` 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'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 `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. | |
|
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
|
-
| **
|
9
|
-
| **
|
10
|
-
| **
|
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 `true`, inspect the value of `Success` to determine whether the Session was successful. | |
|
9
|
+
| **success** | **Boolean** | Whether the Session has completed successfully. If this is `false`, the Session is either not yet done, or has failed. Inspect `Done` and `ErrorCode` for more information. If this is `true`, the Session has completed successfully. | |
|
10
|
+
| **error_code** | [**SessionErrorCode**](SessionErrorCode.md) | The reason for the Session's failure. Only present if `Success` is `false`. | [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'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
|
-
|
23
|
-
|
24
|
-
|
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::
|
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::
|
13
|
+
instance = TrinsicApi::SessionErrorCode.new()
|
14
14
|
```
|
15
15
|
|