trinsic_api 2.0.2 → 2.1.0.pre.alpha1
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/docs/AttachmentsApi.md +2 -2
- data/docs/BangladeshNidInput.md +26 -0
- data/docs/BrazilDigitalCnhInput.md +1 -1
- data/docs/ContractField.md +20 -0
- data/docs/CreateAdvancedProviderSessionRequest.md +3 -3
- data/docs/CreateHostedProviderSessionRequest.md +1 -1
- data/docs/FieldAvailability.md +15 -0
- data/docs/HttpValidationProblemDetails.md +5 -5
- data/docs/NetworkApi.md +14 -9
- data/docs/ProblemDetails.md +5 -5
- data/docs/ProviderContract.md +6 -2
- data/docs/ProviderInfo.md +9 -1
- data/docs/ProviderInformation.md +16 -4
- data/docs/ProviderInput.md +13 -13
- data/docs/RecommendRequest.md +3 -1
- data/docs/RecommendResponse.md +3 -3
- data/docs/RefreshStepContentRequest.md +1 -1
- data/docs/Session.md +1 -1
- data/docs/SessionsApi.md +13 -13
- data/docs/SmartIdInput.md +3 -1
- data/docs/SubProviderMetadata.md +4 -2
- data/lib/trinsic_api/api/attachments_api.rb +3 -3
- data/lib/trinsic_api/api/network_api.rb +8 -5
- data/lib/trinsic_api/api/sessions_api.rb +11 -11
- data/lib/trinsic_api/models/bangladesh_nid_input.rb +350 -0
- data/lib/trinsic_api/models/brazil_digital_cnh_input.rb +1 -1
- data/lib/trinsic_api/models/{bangladesh_national_id_input.rb → contract_field.rb} +69 -36
- data/lib/trinsic_api/models/create_advanced_provider_session_request.rb +16 -16
- data/lib/trinsic_api/models/create_hosted_provider_session_request.rb +1 -1
- data/lib/trinsic_api/models/document_type.rb +2 -1
- data/lib/trinsic_api/models/field_availability.rb +41 -0
- data/lib/trinsic_api/models/http_validation_problem_details.rb +5 -0
- data/lib/trinsic_api/models/integration_capability.rb +2 -1
- data/lib/trinsic_api/models/problem_details.rb +5 -0
- data/lib/trinsic_api/models/provider_contract.rb +42 -2
- data/lib/trinsic_api/models/provider_info.rb +98 -4
- data/lib/trinsic_api/models/provider_information.rb +155 -4
- data/lib/trinsic_api/models/provider_input.rb +13 -13
- data/lib/trinsic_api/models/recommend_request.rb +16 -5
- data/lib/trinsic_api/models/recommend_response.rb +3 -3
- data/lib/trinsic_api/models/refresh_step_content_request.rb +26 -1
- data/lib/trinsic_api/models/session.rb +1 -1
- data/lib/trinsic_api/models/smart_id_input.rb +16 -5
- data/lib/trinsic_api/models/sub_provider_metadata.rb +29 -2
- data/lib/trinsic_api/version.rb +1 -1
- data/lib/trinsic_api.rb +3 -2
- data/spec/api/attachments_api_spec.rb +1 -1
- data/spec/api/network_api_spec.rb +2 -1
- data/spec/api/sessions_api_spec.rb +1 -1
- data/spec/models/{bangladesh_national_id_input_spec.rb → bangladesh_nid_input_spec.rb} +13 -7
- data/spec/models/contract_field_spec.rb +42 -0
- data/spec/models/create_advanced_provider_session_request_spec.rb +4 -4
- data/spec/models/field_availability_spec.rb +30 -0
- data/spec/models/provider_contract_spec.rb +12 -0
- data/spec/models/provider_info_spec.rb +24 -0
- data/spec/models/provider_information_spec.rb +36 -0
- data/spec/models/recommend_request_spec.rb +6 -0
- data/spec/models/smart_id_input_spec.rb +6 -0
- data/spec/models/sub_provider_metadata_spec.rb +6 -0
- metadata +67 -63
- data/docs/BangladeshNationalIdInput.md +0 -24
- data/docs/WellKnownApi.md +0 -71
- data/lib/trinsic_api/api/well_known_api.rb +0 -75
- data/spec/api/well_known_api_spec.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: 25bf4a13299ac364eb63f78819c1e90c41f80d58c7d18f9d85b7e6c91901c37e
|
4
|
+
data.tar.gz: 2b47ccd6f77de82e6c09de7e6880f52fa31a65b9fde5ba92efa4418533c5c30d
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e746926505f49345d88e77b261ac4013106e37c6d8b95dfc94ec8fbe11832e390f52554bcdffeed7c18e03560e805a46ae13f58c37818a3377e9eff35d10d32b
|
7
|
+
data.tar.gz: 3a414b2496bb80365a8c4bb069aedbcaf21a8d433300101972051d801501f4c31549a9eba4c1f060691c6ae00303701464bfbbc5fea7ceaf70a886dca2a89396
|
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.
|
16
|
+
Exchange an Attachment Access Key (from `IdentityData.AttachmentAccessKeys`) 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
|
|
@@ -75,5 +75,5 @@ end
|
|
75
75
|
### HTTP request headers
|
76
76
|
|
77
77
|
- **Content-Type**: application/json, text/json, application/*+json
|
78
|
-
- **Accept**: text/plain, application/json, text/json
|
78
|
+
- **Accept**: text/plain, application/json, text/json, application/problem+json
|
79
79
|
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# TrinsicApi::BangladeshNidInput
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **national_id_number** | **String** | The user's Bangladesh National ID number. | |
|
8
|
+
| **date_of_birth** | **Date** | The user's date of birth, in `YYYY-MM-DD` format | |
|
9
|
+
| **name** | **String** | The user's full name | |
|
10
|
+
| **photo_byes** | **String** | The raw bytes of the photo file collected from the user. | [optional] |
|
11
|
+
| **photo_image_mime_type** | **String** | The MIME Type of the file contained in `PhotoByes`. Must be one of `image/jpeg`, or `image/png`. | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'trinsic_api'
|
17
|
+
|
18
|
+
instance = TrinsicApi::BangladeshNidInput.new(
|
19
|
+
national_id_number: null,
|
20
|
+
date_of_birth: null,
|
21
|
+
name: null,
|
22
|
+
photo_byes: null,
|
23
|
+
photo_image_mime_type: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
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.
|
8
|
+
| **digital_cnh_file** | **String** | The raw bytes of the digital CNH file collected from the user. | [optional] |
|
9
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
10
|
| **facial_biometry_photo** | **String** | The raw bytes of the image of the user's face, collected for biometric comparison. | [optional] |
|
11
11
|
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# TrinsicApi::ContractField
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **name** | **String** | The name of the field as it appears in verification results. | |
|
8
|
+
| **outputted** | [**FieldAvailability**](FieldAvailability.md) | Indicates when this field will be present in verification results. | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'trinsic_api'
|
14
|
+
|
15
|
+
instance = TrinsicApi::ContractField.new(
|
16
|
+
name: person.givenName,
|
17
|
+
outputted: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -5,10 +5,10 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
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
8
|
| **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
9
|
| **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
10
|
| **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] |
|
11
|
+
| **provider_input** | [**ProviderInput**](ProviderInput.md) | Provider-specific input for those providers which require it. | [optional] |
|
12
12
|
|
13
13
|
## Example
|
14
14
|
|
@@ -17,10 +17,10 @@ require 'trinsic_api'
|
|
17
17
|
|
18
18
|
instance = TrinsicApi::CreateAdvancedProviderSessionRequest.new(
|
19
19
|
provider: null,
|
20
|
-
provider_input: null,
|
21
20
|
redirect_url: null,
|
22
21
|
capabilities: null,
|
23
|
-
fallback_to_hosted_ui: null
|
22
|
+
fallback_to_hosted_ui: null,
|
23
|
+
provider_input: null
|
24
24
|
)
|
25
25
|
```
|
26
26
|
|
@@ -6,7 +6,7 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **provider** | **String** | The ID of the provider to launch | |
|
8
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] |
|
9
|
+
| **provider_input** | [**ProviderInput**](ProviderInput.md) | Provider-specific input for those providers which require it. <b>Deprecated:</b> In the future, Hosted Provider Sessions will not accept input on creation, and will instead always redirect the user to a hosted interface to collect input. If you need to collect input from the user yourself, please use the Create Advanced Session endpoint instead. | [optional] |
|
10
10
|
|
11
11
|
## Example
|
12
12
|
|
@@ -4,11 +4,11 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **type** | **String** |
|
8
|
-
| **title** | **String** |
|
9
|
-
| **status** | **Integer** |
|
10
|
-
| **detail** | **String** |
|
11
|
-
| **instance** | **String** |
|
7
|
+
| **type** | **String** | A URI reference that identifies the problem type. | [optional] |
|
8
|
+
| **title** | **String** | A short, human-readable summary of the error. | [optional] |
|
9
|
+
| **status** | **Integer** | The HTTP status code returned for the request. | [optional] |
|
10
|
+
| **detail** | **String** | A human-readable explanation specific of the problem. | [optional] |
|
11
|
+
| **instance** | **String** | A URI reference that identifies the specific occurrence of the problem. | [optional] |
|
12
12
|
| **errors** | **Hash<String, Array<String>>** | | [optional] |
|
13
13
|
|
14
14
|
## Example
|
data/docs/NetworkApi.md
CHANGED
@@ -72,12 +72,12 @@ This endpoint does not need any parameter.
|
|
72
72
|
### HTTP request headers
|
73
73
|
|
74
74
|
- **Content-Type**: Not defined
|
75
|
-
- **Accept**: text/plain, application/json, text/json
|
75
|
+
- **Accept**: text/plain, application/json, text/json, application/problem+json
|
76
76
|
|
77
77
|
|
78
78
|
## list_providers
|
79
79
|
|
80
|
-
> <ListProvidersResponse> list_providers
|
80
|
+
> <ListProvidersResponse> list_providers(opts)
|
81
81
|
|
82
82
|
List Providers
|
83
83
|
|
@@ -95,10 +95,13 @@ TrinsicApi.configure do |config|
|
|
95
95
|
end
|
96
96
|
|
97
97
|
api_instance = TrinsicApi::NetworkApi.new
|
98
|
+
opts = {
|
99
|
+
health: 'health_example' # String | Filter providers by health status. Valid values: \"online\", \"offline\", \"all\". Defaults to \"all\".
|
100
|
+
}
|
98
101
|
|
99
102
|
begin
|
100
103
|
# List Providers
|
101
|
-
result = api_instance.list_providers
|
104
|
+
result = api_instance.list_providers(opts)
|
102
105
|
p result
|
103
106
|
rescue TrinsicApi::ApiError => e
|
104
107
|
puts "Error when calling NetworkApi->list_providers: #{e}"
|
@@ -109,12 +112,12 @@ end
|
|
109
112
|
|
110
113
|
This returns an Array which contains the response data, status code and headers.
|
111
114
|
|
112
|
-
> <Array(<ListProvidersResponse>, Integer, Hash)> list_providers_with_http_info
|
115
|
+
> <Array(<ListProvidersResponse>, Integer, Hash)> list_providers_with_http_info(opts)
|
113
116
|
|
114
117
|
```ruby
|
115
118
|
begin
|
116
119
|
# List Providers
|
117
|
-
data, status_code, headers = api_instance.list_providers_with_http_info
|
120
|
+
data, status_code, headers = api_instance.list_providers_with_http_info(opts)
|
118
121
|
p status_code # => 2xx
|
119
122
|
p headers # => { ... }
|
120
123
|
p data # => <ListProvidersResponse>
|
@@ -125,7 +128,9 @@ end
|
|
125
128
|
|
126
129
|
### Parameters
|
127
130
|
|
128
|
-
|
131
|
+
| Name | Type | Description | Notes |
|
132
|
+
| ---- | ---- | ----------- | ----- |
|
133
|
+
| **health** | **String** | Filter providers by health status. Valid values: \"online\", \"offline\", \"all\". Defaults to \"all\". | [optional] |
|
129
134
|
|
130
135
|
### Return type
|
131
136
|
|
@@ -138,7 +143,7 @@ This endpoint does not need any parameter.
|
|
138
143
|
### HTTP request headers
|
139
144
|
|
140
145
|
- **Content-Type**: Not defined
|
141
|
-
- **Accept**: text/plain, application/json, text/json
|
146
|
+
- **Accept**: text/plain, application/json, text/json, application/problem+json
|
142
147
|
|
143
148
|
|
144
149
|
## recommend_providers
|
@@ -147,7 +152,7 @@ This endpoint does not need any parameter.
|
|
147
152
|
|
148
153
|
Recommend Providers
|
149
154
|
|
150
|
-
Generate provider recommendations based on the
|
155
|
+
Generate provider recommendations based on signals about the user's location (phone number, countries, states).
|
151
156
|
|
152
157
|
### Examples
|
153
158
|
|
@@ -209,5 +214,5 @@ end
|
|
209
214
|
### HTTP request headers
|
210
215
|
|
211
216
|
- **Content-Type**: application/json, text/json, application/*+json
|
212
|
-
- **Accept**: text/plain, application/json, text/json
|
217
|
+
- **Accept**: text/plain, application/json, text/json, application/problem+json
|
213
218
|
|
data/docs/ProblemDetails.md
CHANGED
@@ -4,11 +4,11 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **type** | **String** |
|
8
|
-
| **title** | **String** |
|
9
|
-
| **status** | **Integer** |
|
10
|
-
| **detail** | **String** |
|
11
|
-
| **instance** | **String** |
|
7
|
+
| **type** | **String** | A URI reference that identifies the problem type. | [optional] |
|
8
|
+
| **title** | **String** | A short, human-readable summary of the error. | [optional] |
|
9
|
+
| **status** | **Integer** | The HTTP status code returned for the request. | [optional] |
|
10
|
+
| **detail** | **String** | A human-readable explanation specific of the problem. | [optional] |
|
11
|
+
| **instance** | **String** | A URI reference that identifies the specific occurrence of the problem. | [optional] |
|
12
12
|
|
13
13
|
## Example
|
14
14
|
|
data/docs/ProviderContract.md
CHANGED
@@ -6,6 +6,7 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **id** | **String** | The ID of the Provider for this contract. | |
|
8
8
|
| **name** | **String** | The Provider's Name as it appears in Trinsic's Dashboard and Widget | |
|
9
|
+
| **subtext** | **String** | The Provider's subtext recommended to be shown next to the name. This is flavor text, not a full, human-readable description of the provider. | |
|
9
10
|
| **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
11
|
| **logo_url** | **String** | A URL pointing to the Provider's logo on Trinsic's CDN. May be a PNG, JPG, or SVG image. | |
|
11
12
|
| **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. | |
|
@@ -13,11 +14,12 @@
|
|
13
14
|
| **regions** | **Array<String>** | The regions within which the Provider is available. | |
|
14
15
|
| **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
16
|
| **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
|
17
|
+
| **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 only applies to Providers which cannot guarantee the availability of results immediately after the user is redirected back to your application. | |
|
17
18
|
| **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
19
|
| **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
20
|
| **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
21
|
| **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. | |
|
22
|
+
| **available_fields** | [**Array<ContractField>**](ContractField.md) | Information about the fields that this Provider will return in verification results. | [optional] |
|
21
23
|
| **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
24
|
| **health** | [**ProviderHealth**](ProviderHealth.md) | The health for an integration to be able to successfully perform a verification session. | |
|
23
25
|
|
@@ -27,8 +29,9 @@
|
|
27
29
|
require 'trinsic_api'
|
28
30
|
|
29
31
|
instance = TrinsicApi::ProviderContract.new(
|
30
|
-
id:
|
32
|
+
id: usa-california-dmv,
|
31
33
|
name: CA DMV,
|
34
|
+
subtext: dmv.ca.gov,
|
32
35
|
description: dmv.ca.gov,
|
33
36
|
logo_url: https://content.trinsic.id/connect/integrations/ca-dmv.png,
|
34
37
|
available: true,
|
@@ -41,6 +44,7 @@ instance = TrinsicApi::ProviderContract.new(
|
|
41
44
|
requires_input: false,
|
42
45
|
has_trinsic_interface: true,
|
43
46
|
supports_advanced_provider_sessions: true,
|
47
|
+
available_fields: null,
|
44
48
|
sub_providers: null,
|
45
49
|
health: null
|
46
50
|
)
|
data/docs/ProviderInfo.md
CHANGED
@@ -7,6 +7,10 @@
|
|
7
7
|
| **id** | **String** | The ID of the provider | |
|
8
8
|
| **name** | **String** | The friendly, human-readable name of the provider | |
|
9
9
|
| **logo_url** | **String** | A URL pointing to the provider's logo | |
|
10
|
+
| **subtext** | **String** | The Provider's subtext recommended to be shown next to the name. This is flavor text, not a full, human-readable description of the provider. | |
|
11
|
+
| **description** | **String** | The Provider's description recommended to be shown next to the name. This is flavor text, not a full, human-readable description of the provider. | |
|
12
|
+
| **health** | **String** | The current health status of the provider | |
|
13
|
+
| **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] |
|
10
14
|
|
11
15
|
## Example
|
12
16
|
|
@@ -16,7 +20,11 @@ require 'trinsic_api'
|
|
16
20
|
instance = TrinsicApi::ProviderInfo.new(
|
17
21
|
id: yoti | clear | ...,
|
18
22
|
name: Yoti | CLEAR | ...,
|
19
|
-
logo_url: null
|
23
|
+
logo_url: null,
|
24
|
+
subtext: dmv.ca.gov,
|
25
|
+
description: dmv.ca.gov,
|
26
|
+
health: online | offline,
|
27
|
+
sub_providers: null
|
20
28
|
)
|
21
29
|
```
|
22
30
|
|
data/docs/ProviderInformation.md
CHANGED
@@ -4,9 +4,15 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **
|
8
|
-
| **
|
9
|
-
| **
|
7
|
+
| **id** | **String** | The ID of the provider | |
|
8
|
+
| **name** | **String** | The friendly, human-readable name of the provider | |
|
9
|
+
| **logo_url** | **String** | A URL pointing to the provider's logo | |
|
10
|
+
| **subtext** | **String** | The Provider's subtext recommended to be shown next to the name. This is flavor text, not a full, human-readable description of the provider. | |
|
11
|
+
| **provider_id** | **String** | The ID of the provider | |
|
12
|
+
| **provider_display_name** | **String** | The friendly, human-readable name of the provider | |
|
13
|
+
| **provider_logo** | **String** | A URL pointing to the provider's logo | |
|
14
|
+
| **health** | **String** | The current health status of the provider | |
|
15
|
+
| **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] |
|
10
16
|
|
11
17
|
## Example
|
12
18
|
|
@@ -14,9 +20,15 @@
|
|
14
20
|
require 'trinsic_api'
|
15
21
|
|
16
22
|
instance = TrinsicApi::ProviderInformation.new(
|
23
|
+
id: null,
|
24
|
+
name: null,
|
25
|
+
logo_url: null,
|
26
|
+
subtext: dmv.ca.gov,
|
17
27
|
provider_id: null,
|
18
28
|
provider_display_name: null,
|
19
|
-
provider_logo: null
|
29
|
+
provider_logo: null,
|
30
|
+
health: online | offline,
|
31
|
+
sub_providers: null
|
20
32
|
)
|
21
33
|
```
|
22
34
|
|
data/docs/ProviderInput.md
CHANGED
@@ -4,21 +4,21 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **indonesia_nik** | [**IndonesiaNikInput**](IndonesiaNikInput.md) | Input for the `
|
8
|
-
| **mexico_curp** | [**MexicoCurpInput**](MexicoCurpInput.md) | Input for the `
|
9
|
-
| **south_africa_nid** | [**SouthAfricaNidInput**](SouthAfricaNidInput.md) | Input for the `
|
10
|
-
| **kenya_nid** | [**KenyaNidInput**](KenyaNidInput.md) | Input for the `
|
11
|
-
| **nigeria_nin** | [**NigeriaNinInput**](NigeriaNinInput.md) | Input for the `
|
12
|
-
| **aadhaar** | [**AadhaarInput**](AadhaarInput.md) | Input for the `
|
13
|
-
| **bangladesh_national_id** | [**
|
14
|
-
| **brazil_cpf_check** | [**BrazilCpfCheckInput**](BrazilCpfCheckInput.md) | Input for the `
|
15
|
-
| **brazil_digital_cnh** | [**BrazilDigitalCnhInput**](BrazilDigitalCnhInput.md) | Input for the `
|
16
|
-
| **philippine_match** | [**PhilippineMatchInput**](PhilippineMatchInput.md) | Input for the `
|
17
|
-
| **philippine_qr** | [**PhilippineQRInput**](PhilippineQRInput.md) | Input for the `
|
7
|
+
| **indonesia_nik** | [**IndonesiaNikInput**](IndonesiaNikInput.md) | Input for the `indonesia-nik-lookup` provider | [optional] |
|
8
|
+
| **mexico_curp** | [**MexicoCurpInput**](MexicoCurpInput.md) | Input for the `mexico-curp-lookup` provider | [optional] |
|
9
|
+
| **south_africa_nid** | [**SouthAfricaNidInput**](SouthAfricaNidInput.md) | Input for the `south-africa-nid-lookup` provider | [optional] |
|
10
|
+
| **kenya_nid** | [**KenyaNidInput**](KenyaNidInput.md) | Input for the `kenya-nid-lookup` provider | [optional] |
|
11
|
+
| **nigeria_nin** | [**NigeriaNinInput**](NigeriaNinInput.md) | Input for the `nigeria-nin-lookup` provider | [optional] |
|
12
|
+
| **aadhaar** | [**AadhaarInput**](AadhaarInput.md) | Input for the `india-digilocker-aadhaar-match` provider | [optional] |
|
13
|
+
| **bangladesh_national_id** | [**BangladeshNidInput**](BangladeshNidInput.md) | Input for the `bangladesh-nid` provider | [optional] |
|
14
|
+
| **brazil_cpf_check** | [**BrazilCpfCheckInput**](BrazilCpfCheckInput.md) | Input for the `brazil-cpf-lookup` provider | [optional] |
|
15
|
+
| **brazil_digital_cnh** | [**BrazilDigitalCnhInput**](BrazilDigitalCnhInput.md) | Input for the `brazil-digital-cnh` provider | [optional] |
|
16
|
+
| **philippine_match** | [**PhilippineMatchInput**](PhilippineMatchInput.md) | Input for the `philippines-philsys-match` provider | [optional] |
|
17
|
+
| **philippine_qr** | [**PhilippineQRInput**](PhilippineQRInput.md) | Input for the `philippines-digital-national-id-qr` and `philippines-physical-national-id-qr` providers | [optional] |
|
18
18
|
| **smart_id** | [**SmartIdInput**](SmartIdInput.md) | Input for the `smart-id` provider | [optional] |
|
19
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] |
|
20
|
+
| **idin** | [**IdinInput**](IdinInput.md) | Input for the `netherlands-idin` provider | [optional] |
|
21
|
+
| **spid** | [**SpidInput**](SpidInput.md) | Input for the `italy-spid` provider | [optional] |
|
22
22
|
| **trinsic_test_database_lookup** | [**TrinsicTestDatabaseLookupInput**](TrinsicTestDatabaseLookupInput.md) | *TEST MODE ONLY.* Input for the `trinsic-test-database-lookup` provider | [optional] |
|
23
23
|
| **trinsic_test_sub_providers** | [**TrinsicTestSubProvidersInput**](TrinsicTestSubProvidersInput.md) | *TEST MODE ONLY.* Input for the `trinsic-test-sub-providers` provider | [optional] |
|
24
24
|
|
data/docs/RecommendRequest.md
CHANGED
@@ -5,6 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **recommendation_info** | [**RecommendationInfo**](RecommendationInfo.md) | Information about the user you wish to generate a recommendation for. | [optional] |
|
8
|
+
| **health** | **String** | Filter providers by health status. Valid values: \"online\", \"offline\", \"all\". Defaults to \"online\". | [optional] |
|
8
9
|
|
9
10
|
## Example
|
10
11
|
|
@@ -12,7 +13,8 @@
|
|
12
13
|
require 'trinsic_api'
|
13
14
|
|
14
15
|
instance = TrinsicApi::RecommendRequest.new(
|
15
|
-
recommendation_info: null
|
16
|
+
recommendation_info: null,
|
17
|
+
health: null
|
16
18
|
)
|
17
19
|
```
|
18
20
|
|
data/docs/RecommendResponse.md
CHANGED
@@ -4,9 +4,9 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **recognized** | [**Array<ProviderInformation>**](ProviderInformation.md) | The
|
8
|
-
| **relevant** | [**Array<ProviderInformation>**](ProviderInformation.md) | The
|
9
|
-
| **remainder** | [**Array<ProviderInformation>**](ProviderInformation.md) | The
|
7
|
+
| **recognized** | [**Array<ProviderInformation>**](ProviderInformation.md) | The providers which the user is known to have a credential with. | |
|
8
|
+
| **relevant** | [**Array<ProviderInformation>**](ProviderInformation.md) | The providers which the user is deemed sufficiently likely to have a credential with. | |
|
9
|
+
| **remainder** | [**Array<ProviderInformation>**](ProviderInformation.md) | The providers which the user is unlikely to have a credential with. This includes all providers available to your app which were not included in the Recognized or Relevant lists. | |
|
10
10
|
|
11
11
|
## Example
|
12
12
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **results_access_key** | **String** | The `ResultsAccessKey` returned when the Session was created |
|
7
|
+
| **results_access_key** | **String** | The `ResultsAccessKey` returned when the Session was created | |
|
8
8
|
|
9
9
|
## Example
|
10
10
|
|
data/docs/Session.md
CHANGED
@@ -9,7 +9,7 @@
|
|
9
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
10
|
| **error_code** | [**SessionErrorCode**](SessionErrorCode.md) | The reason for the Session's failure. Only present if `Success` is `false`. | [optional] |
|
11
11
|
| **created** | **Integer** | The unix timestamp, in seconds, when this session was created | |
|
12
|
-
| **updated** | **Integer** | The unix timestamp, in seconds, when this session's
|
12
|
+
| **updated** | **Integer** | The unix timestamp, in seconds, when this session's data was last updated | |
|
13
13
|
|
14
14
|
## Example
|
15
15
|
|
data/docs/SessionsApi.md
CHANGED
@@ -35,7 +35,7 @@ TrinsicApi.configure do |config|
|
|
35
35
|
end
|
36
36
|
|
37
37
|
api_instance = TrinsicApi::SessionsApi.new
|
38
|
-
session_id = '
|
38
|
+
session_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
39
39
|
|
40
40
|
begin
|
41
41
|
# Cancel Session
|
@@ -81,7 +81,7 @@ end
|
|
81
81
|
### HTTP request headers
|
82
82
|
|
83
83
|
- **Content-Type**: Not defined
|
84
|
-
- **Accept**: text/plain, application/json, text/json
|
84
|
+
- **Accept**: text/plain, application/json, text/json, application/problem+json
|
85
85
|
|
86
86
|
|
87
87
|
## create_advanced_provider_session
|
@@ -152,7 +152,7 @@ end
|
|
152
152
|
### HTTP request headers
|
153
153
|
|
154
154
|
- **Content-Type**: application/json, text/json, application/*+json
|
155
|
-
- **Accept**: text/plain, application/json, text/json
|
155
|
+
- **Accept**: text/plain, application/json, text/json, application/problem+json
|
156
156
|
|
157
157
|
|
158
158
|
## create_hosted_provider_session
|
@@ -223,7 +223,7 @@ end
|
|
223
223
|
### HTTP request headers
|
224
224
|
|
225
225
|
- **Content-Type**: application/json, text/json, application/*+json
|
226
|
-
- **Accept**: text/plain, application/json, text/json
|
226
|
+
- **Accept**: text/plain, application/json, text/json, application/problem+json
|
227
227
|
|
228
228
|
|
229
229
|
## create_widget_session
|
@@ -294,7 +294,7 @@ end
|
|
294
294
|
### HTTP request headers
|
295
295
|
|
296
296
|
- **Content-Type**: application/json, text/json, application/*+json
|
297
|
-
- **Accept**: text/plain, application/json, text/json
|
297
|
+
- **Accept**: text/plain, application/json, text/json, application/problem+json
|
298
298
|
|
299
299
|
|
300
300
|
## get_session
|
@@ -363,7 +363,7 @@ end
|
|
363
363
|
### HTTP request headers
|
364
364
|
|
365
365
|
- **Content-Type**: Not defined
|
366
|
-
- **Accept**: text/plain, application/json, text/json
|
366
|
+
- **Accept**: text/plain, application/json, text/json, application/problem+json
|
367
367
|
|
368
368
|
|
369
369
|
## get_session_result
|
@@ -434,7 +434,7 @@ end
|
|
434
434
|
### HTTP request headers
|
435
435
|
|
436
436
|
- **Content-Type**: application/json, text/json, application/*+json
|
437
|
-
- **Accept**: text/plain, application/json, text/json
|
437
|
+
- **Accept**: text/plain, application/json, text/json, application/problem+json
|
438
438
|
|
439
439
|
|
440
440
|
## list_sessions
|
@@ -511,7 +511,7 @@ end
|
|
511
511
|
### HTTP request headers
|
512
512
|
|
513
513
|
- **Content-Type**: Not defined
|
514
|
-
- **Accept**: text/plain, application/json, text/json
|
514
|
+
- **Accept**: text/plain, application/json, text/json, application/problem+json
|
515
515
|
|
516
516
|
|
517
517
|
## redact_session
|
@@ -520,7 +520,7 @@ end
|
|
520
520
|
|
521
521
|
Redact Session
|
522
522
|
|
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.
|
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.
|
524
524
|
|
525
525
|
### Examples
|
526
526
|
|
@@ -534,7 +534,7 @@ TrinsicApi.configure do |config|
|
|
534
534
|
end
|
535
535
|
|
536
536
|
api_instance = TrinsicApi::SessionsApi.new
|
537
|
-
session_id = '
|
537
|
+
session_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
538
538
|
|
539
539
|
begin
|
540
540
|
# Redact Session
|
@@ -579,7 +579,7 @@ nil (empty response body)
|
|
579
579
|
### HTTP request headers
|
580
580
|
|
581
581
|
- **Content-Type**: Not defined
|
582
|
-
- **Accept**: application/json
|
582
|
+
- **Accept**: application/problem+json
|
583
583
|
|
584
584
|
|
585
585
|
## refresh_step_content
|
@@ -604,7 +604,7 @@ end
|
|
604
604
|
api_instance = TrinsicApi::SessionsApi.new
|
605
605
|
acceptance_session_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
606
606
|
opts = {
|
607
|
-
refresh_step_content_request: TrinsicApi::RefreshStepContentRequest.new # RefreshStepContentRequest |
|
607
|
+
refresh_step_content_request: TrinsicApi::RefreshStepContentRequest.new({results_access_key: 'results_access_key_example'}) # RefreshStepContentRequest |
|
608
608
|
}
|
609
609
|
|
610
610
|
begin
|
@@ -652,5 +652,5 @@ end
|
|
652
652
|
### HTTP request headers
|
653
653
|
|
654
654
|
- **Content-Type**: application/json, text/json, application/*+json
|
655
|
-
- **Accept**: text/plain, application/json, text/json
|
655
|
+
- **Accept**: text/plain, application/json, text/json, application/problem+json
|
656
656
|
|
data/docs/SmartIdInput.md
CHANGED
@@ -5,6 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **smart_id_document_number** | **String** | The user's Smart ID Document Number | [optional] |
|
8
|
+
| **smart_id_number** | **String** | The user's Smart ID ETSI number or document number. | [optional] |
|
8
9
|
|
9
10
|
## Example
|
10
11
|
|
@@ -12,7 +13,8 @@
|
|
12
13
|
require 'trinsic_api'
|
13
14
|
|
14
15
|
instance = TrinsicApi::SmartIdInput.new(
|
15
|
-
smart_id_document_number: null
|
16
|
+
smart_id_document_number: null,
|
17
|
+
smart_id_number: null
|
16
18
|
)
|
17
19
|
```
|
18
20
|
|
data/docs/SubProviderMetadata.md
CHANGED
@@ -6,7 +6,8 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
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
8
|
| **name** | **String** | The name of the sub-provider | |
|
9
|
-
| **
|
9
|
+
| **subtext** | **String** | The Provider's subtext recommended to be shown next to the name. This is flavor text, not a full, human-readable description of the provider. | |
|
10
|
+
| **description** | **String** | The Provider's subtext recommended to be shown next to the name. This is flavor text, not a full, human-readable description of the provider. | |
|
10
11
|
| **logo_url** | **String** | A URL pointing to the logo on Trinsic's CDN. May be a PNG, JPG, or SVG image. | |
|
11
12
|
|
12
13
|
## Example
|
@@ -17,7 +18,8 @@ require 'trinsic_api'
|
|
17
18
|
instance = TrinsicApi::SubProviderMetadata.new(
|
18
19
|
id: null,
|
19
20
|
name: null,
|
20
|
-
|
21
|
+
subtext: dmv.ca.gov,
|
22
|
+
description: dmv.ca.gov,
|
21
23
|
logo_url: null
|
22
24
|
)
|
23
25
|
```
|