trinsic_api 2.0.3 → 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.
Files changed (52) hide show
  1. checksums.yaml +4 -4
  2. data/docs/AttachmentsApi.md +1 -1
  3. data/docs/BangladeshNidInput.md +3 -3
  4. data/docs/ContractField.md +20 -0
  5. data/docs/CreateAdvancedProviderSessionRequest.md +3 -3
  6. data/docs/CreateHostedProviderSessionRequest.md +1 -1
  7. data/docs/FieldAvailability.md +15 -0
  8. data/docs/NetworkApi.md +11 -6
  9. data/docs/ProviderContract.md +6 -2
  10. data/docs/ProviderInfo.md +9 -1
  11. data/docs/ProviderInformation.md +16 -4
  12. data/docs/ProviderInput.md +12 -12
  13. data/docs/RecommendRequest.md +3 -1
  14. data/docs/RecommendResponse.md +3 -3
  15. data/docs/Session.md +1 -1
  16. data/docs/SessionsApi.md +1 -1
  17. data/docs/SmartIdInput.md +3 -1
  18. data/docs/SubProviderMetadata.md +4 -2
  19. data/lib/trinsic_api/api/attachments_api.rb +2 -2
  20. data/lib/trinsic_api/api/network_api.rb +5 -2
  21. data/lib/trinsic_api/api/sessions_api.rb +2 -2
  22. data/lib/trinsic_api/models/bangladesh_nid_input.rb +87 -3
  23. data/lib/trinsic_api/models/contract_field.rb +288 -0
  24. data/lib/trinsic_api/models/create_advanced_provider_session_request.rb +16 -16
  25. data/lib/trinsic_api/models/create_hosted_provider_session_request.rb +1 -1
  26. data/lib/trinsic_api/models/document_type.rb +2 -1
  27. data/lib/trinsic_api/models/field_availability.rb +41 -0
  28. data/lib/trinsic_api/models/integration_capability.rb +2 -1
  29. data/lib/trinsic_api/models/provider_contract.rb +42 -2
  30. data/lib/trinsic_api/models/provider_info.rb +98 -4
  31. data/lib/trinsic_api/models/provider_information.rb +155 -4
  32. data/lib/trinsic_api/models/provider_input.rb +12 -12
  33. data/lib/trinsic_api/models/recommend_request.rb +16 -5
  34. data/lib/trinsic_api/models/recommend_response.rb +3 -3
  35. data/lib/trinsic_api/models/session.rb +1 -1
  36. data/lib/trinsic_api/models/smart_id_input.rb +16 -5
  37. data/lib/trinsic_api/models/sub_provider_metadata.rb +29 -2
  38. data/lib/trinsic_api/version.rb +1 -1
  39. data/lib/trinsic_api.rb +2 -0
  40. data/spec/api/attachments_api_spec.rb +1 -1
  41. data/spec/api/network_api_spec.rb +2 -1
  42. data/spec/api/sessions_api_spec.rb +1 -1
  43. data/spec/models/contract_field_spec.rb +42 -0
  44. data/spec/models/create_advanced_provider_session_request_spec.rb +4 -4
  45. data/spec/models/field_availability_spec.rb +30 -0
  46. data/spec/models/provider_contract_spec.rb +12 -0
  47. data/spec/models/provider_info_spec.rb +24 -0
  48. data/spec/models/provider_information_spec.rb +36 -0
  49. data/spec/models/recommend_request_spec.rb +6 -0
  50. data/spec/models/smart_id_input_spec.rb +6 -0
  51. data/spec/models/sub_provider_metadata_spec.rb +6 -0
  52. metadata +64 -56
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: f61cc97f7dfdac403ad569a71c22e10fb441ea4351721b86c498328c751a7faf
4
- data.tar.gz: 18c5b192be5da02584f9d897f5bfb04ca905cb5422fe3589ceba2f803992b8c1
3
+ metadata.gz: 25bf4a13299ac364eb63f78819c1e90c41f80d58c7d18f9d85b7e6c91901c37e
4
+ data.tar.gz: 2b47ccd6f77de82e6c09de7e6880f52fa31a65b9fde5ba92efa4418533c5c30d
5
5
  SHA512:
6
- metadata.gz: 58bbbe3ee0b94cc333dfe8c64ddba9924b4838aa1fcc3ed52c8b992d026d1c542715b8026bb685a5d6cc47efd0e6617bff6cfc4aca1e89d8c72a8894e5bdb05b
7
- data.tar.gz: 1824adf318dd3dee303b728955e9e8e09954302797c07514875f9aa1c6098cc6ca33a1fb8fe76bcdd4c611138374b9169896e19482742309b5e718554df9b0d4
6
+ metadata.gz: e746926505f49345d88e77b261ac4013106e37c6d8b95dfc94ec8fbe11832e390f52554bcdffeed7c18e03560e805a46ae13f58c37818a3377e9eff35d10d32b
7
+ data.tar.gz: 3a414b2496bb80365a8c4bb069aedbcaf21a8d433300101972051d801501f4c31549a9eba4c1f060691c6ae00303701464bfbbc5fea7ceaf70a886dca2a89396
@@ -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. 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.
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
 
@@ -4,9 +4,9 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
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] |
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
10
  | **photo_byes** | **String** | The raw bytes of the photo file collected from the user. | [optional] |
11
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
12
 
@@ -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
 
@@ -0,0 +1,15 @@
1
+ # TrinsicApi::FieldAvailability
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'trinsic_api'
12
+
13
+ instance = TrinsicApi::FieldAvailability.new()
14
+ ```
15
+
data/docs/NetworkApi.md CHANGED
@@ -77,7 +77,7 @@ This endpoint does not need any parameter.
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
- This endpoint does not need any parameter.
131
+ | Name | Type | Description | Notes |
132
+ | ---- | ---- | ----------- | ----- |
133
+ | **health** | **String** | Filter providers by health status. Valid values: \&quot;online\&quot;, \&quot;offline\&quot;, \&quot;all\&quot;. Defaults to \&quot;all\&quot;. | [optional] |
129
134
 
130
135
  ### Return type
131
136
 
@@ -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 given signals (phone number, countries, states).
155
+ Generate provider recommendations based on signals about the user's location (phone number, countries, states).
151
156
 
152
157
  ### Examples
153
158
 
@@ -6,6 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **id** | **String** | The ID of the Provider for this contract. | |
8
8
  | **name** | **String** | The Provider&#39;s Name as it appears in Trinsic&#39;s Dashboard and Widget | |
9
+ | **subtext** | **String** | The Provider&#39;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&#39;s description as it appears in Trinsic&#39;s Widget. This is flavor text, not a full, human-readable description of the provider. | |
10
11
  | **logo_url** | **String** | A URL pointing to the Provider&#39;s logo on Trinsic&#39;s CDN. May be a PNG, JPG, or SVG image. | |
11
12
  | **available** | **Boolean** | Whether the Provider is available for use in your App. If &#x60;false&#x60;, you will need to contact Trinsic to enable this Provider for your App. | |
@@ -13,11 +14,12 @@
13
14
  | **regions** | **Array&lt;String&gt;** | The regions within which the Provider is available. | |
14
15
  | **launch_method** | [**IntegrationLaunchMethod**](IntegrationLaunchMethod.md) | Relevant only to Advanced Provider Sessions. The &#x60;LaunchMethod&#x60; which must be supported to launch the Provider Session in Advanced Provider Sessions. | |
15
16
  | **collection_method** | [**ResultCollectionMethod**](ResultCollectionMethod.md) | Relevant only to Advanced Provider Sessions. The &#x60;CollectionMethod&#x60; which must be supported to launch the Provider Session in Advanced Provider Sessions. | |
16
- | **results_may_be_delayed_after_redirect** | **Boolean** | If &#x60;true&#x60;, then the results for this Provider may not be available immediately after the user is redirected back to your application. In this case, the &#x60;GetSessionResults&#x60; API must be called until results are available. This is an uncommon scenario, and typically only applies to Providers which use a biometric check or traditional document scan. | |
17
+ | **results_may_be_delayed_after_redirect** | **Boolean** | If &#x60;true&#x60;, then the results for this Provider may not be available immediately after the user is redirected back to your application. In this case, the &#x60;GetSessionResults&#x60; API must be called until results are available. This is an uncommon scenario, and 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 &#x60;RefreshStepContent&#x60; capability. For example, Samsung Wallet&#39;s deep links expire every 30 seconds, and must be refreshed periodically for a resilient user flow. | |
18
19
  | **requires_input** | **Boolean** | Relevant to Hosted Provider Sessions and Advanced Provider Sessions. If &#x60;true&#x60;, this Provider requires provider-specific input on Session creation. If this input is not provided, Trinsic&#39;s Hosted UI will be invoked to collect the input from the user. | |
19
20
  | **has_trinsic_interface** | **Boolean** | Whether there exists a Trinsic-hosted UI for this Provider. This is &#x60;true&#x60; for any Provider which is not a simple, OIDC-like redirect flow. | |
20
21
  | **supports_advanced_provider_sessions** | **Boolean** | Whether this Provider can be fully whitelabeled/OEMed through the Advanced Provider Sessions API. If &#x60;false&#x60;, the Provider may still be launched through Advanced Provider Sessions; however, it will necessarily require a Trinsic-hosted UI to function. | |
22
+ | **available_fields** | [**Array&lt;ContractField&gt;**](ContractField.md) | Information about the fields that this Provider will return in verification results. | [optional] |
21
23
  | **sub_providers** | [**Array&lt;SubProviderMetadata&gt;**](SubProviderMetadata.md) | Metadata about the sub-providers which are available for this Provider. For example, Italy&#39;s SPID is a Provider which aggregates access to multiple sub-providers. | [optional] |
22
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: ca-mdl,
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&#39;s logo | |
10
+ | **subtext** | **String** | The Provider&#39;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&#39;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&lt;SubProviderMetadata&gt;**](SubProviderMetadata.md) | Metadata about the sub-providers which are available for this Provider. For example, Italy&#39;s SPID is a Provider which aggregates access to multiple sub-providers. | [optional] |
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
 
@@ -4,9 +4,15 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **provider_id** | **String** | | [readonly] |
8
- | **provider_display_name** | **String** | | [readonly] |
9
- | **provider_logo** | **String** | | [readonly] |
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&#39;s logo | |
10
+ | **subtext** | **String** | The Provider&#39;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&#39;s logo | |
14
+ | **health** | **String** | The current health status of the provider | |
15
+ | **sub_providers** | [**Array&lt;SubProviderMetadata&gt;**](SubProviderMetadata.md) | Metadata about the sub-providers which are available for this Provider. For example, Italy&#39;s SPID is a Provider which aggregates access to multiple sub-providers. | [optional] |
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
 
@@ -4,21 +4,21 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **indonesia_nik** | [**IndonesiaNikInput**](IndonesiaNikInput.md) | Input for the &#x60;f-indonesia-nik&#x60; provider | [optional] |
8
- | **mexico_curp** | [**MexicoCurpInput**](MexicoCurpInput.md) | Input for the &#x60;f-mexico-curp&#x60; provider | [optional] |
9
- | **south_africa_nid** | [**SouthAfricaNidInput**](SouthAfricaNidInput.md) | Input for the &#x60;f-south-africa-nid&#x60; provider | [optional] |
10
- | **kenya_nid** | [**KenyaNidInput**](KenyaNidInput.md) | Input for the &#x60;f-kenya-nid&#x60; provider | [optional] |
11
- | **nigeria_nin** | [**NigeriaNinInput**](NigeriaNinInput.md) | Input for the &#x60;f-nigeria-nin&#x60; provider | [optional] |
12
- | **aadhaar** | [**AadhaarInput**](AadhaarInput.md) | Input for the &#x60;f-india-aadhaar-match&#x60; provider | [optional] |
7
+ | **indonesia_nik** | [**IndonesiaNikInput**](IndonesiaNikInput.md) | Input for the &#x60;indonesia-nik-lookup&#x60; provider | [optional] |
8
+ | **mexico_curp** | [**MexicoCurpInput**](MexicoCurpInput.md) | Input for the &#x60;mexico-curp-lookup&#x60; provider | [optional] |
9
+ | **south_africa_nid** | [**SouthAfricaNidInput**](SouthAfricaNidInput.md) | Input for the &#x60;south-africa-nid-lookup&#x60; provider | [optional] |
10
+ | **kenya_nid** | [**KenyaNidInput**](KenyaNidInput.md) | Input for the &#x60;kenya-nid-lookup&#x60; provider | [optional] |
11
+ | **nigeria_nin** | [**NigeriaNinInput**](NigeriaNinInput.md) | Input for the &#x60;nigeria-nin-lookup&#x60; provider | [optional] |
12
+ | **aadhaar** | [**AadhaarInput**](AadhaarInput.md) | Input for the &#x60;india-digilocker-aadhaar-match&#x60; provider | [optional] |
13
13
  | **bangladesh_national_id** | [**BangladeshNidInput**](BangladeshNidInput.md) | Input for the &#x60;bangladesh-nid&#x60; provider | [optional] |
14
- | **brazil_cpf_check** | [**BrazilCpfCheckInput**](BrazilCpfCheckInput.md) | Input for the &#x60;g-brazil-cpf&#x60; provider | [optional] |
15
- | **brazil_digital_cnh** | [**BrazilDigitalCnhInput**](BrazilDigitalCnhInput.md) | Input for the &#x60;g-brazil-digital-cnh&#x60; provider | [optional] |
16
- | **philippine_match** | [**PhilippineMatchInput**](PhilippineMatchInput.md) | Input for the &#x60;b-philsys-biometric&#x60; provider | [optional] |
17
- | **philippine_qr** | [**PhilippineQRInput**](PhilippineQRInput.md) | Input for the &#x60;b-philippine-qr-digital-national-id&#x60; and &#x60;b-philippine-qr-ephill-id&#x60; providers | [optional] |
14
+ | **brazil_cpf_check** | [**BrazilCpfCheckInput**](BrazilCpfCheckInput.md) | Input for the &#x60;brazil-cpf-lookup&#x60; provider | [optional] |
15
+ | **brazil_digital_cnh** | [**BrazilDigitalCnhInput**](BrazilDigitalCnhInput.md) | Input for the &#x60;brazil-digital-cnh&#x60; provider | [optional] |
16
+ | **philippine_match** | [**PhilippineMatchInput**](PhilippineMatchInput.md) | Input for the &#x60;philippines-philsys-match&#x60; provider | [optional] |
17
+ | **philippine_qr** | [**PhilippineQRInput**](PhilippineQRInput.md) | Input for the &#x60;philippines-digital-national-id-qr&#x60; and &#x60;philippines-physical-national-id-qr&#x60; providers | [optional] |
18
18
  | **smart_id** | [**SmartIdInput**](SmartIdInput.md) | Input for the &#x60;smart-id&#x60; provider | [optional] |
19
19
  | **mobile_id** | [**MobileIdInput**](MobileIdInput.md) | Input for the &#x60;mobile-id&#x60; provider | [optional] |
20
- | **idin** | [**IdinInput**](IdinInput.md) | Input for the &#x60;idin&#x60; provider | [optional] |
21
- | **spid** | [**SpidInput**](SpidInput.md) | Input for the &#x60;spid&#x60; provider | [optional] |
20
+ | **idin** | [**IdinInput**](IdinInput.md) | Input for the &#x60;netherlands-idin&#x60; provider | [optional] |
21
+ | **spid** | [**SpidInput**](SpidInput.md) | Input for the &#x60;italy-spid&#x60; provider | [optional] |
22
22
  | **trinsic_test_database_lookup** | [**TrinsicTestDatabaseLookupInput**](TrinsicTestDatabaseLookupInput.md) | *TEST MODE ONLY.* Input for the &#x60;trinsic-test-database-lookup&#x60; provider | [optional] |
23
23
  | **trinsic_test_sub_providers** | [**TrinsicTestSubProvidersInput**](TrinsicTestSubProvidersInput.md) | *TEST MODE ONLY.* Input for the &#x60;trinsic-test-sub-providers&#x60; provider | [optional] |
24
24
 
@@ -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: \&quot;online\&quot;, \&quot;offline\&quot;, \&quot;all\&quot;. Defaults to \&quot;online\&quot;. | [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
 
@@ -4,9 +4,9 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **recognized** | [**Array&lt;ProviderInformation&gt;**](ProviderInformation.md) | The list of providers that were recognized in Trinsic&#39;s network. These are providers that already verified this user | |
8
- | **relevant** | [**Array&lt;ProviderInformation&gt;**](ProviderInformation.md) | The list of providers that although not recognized, are relevant to the user&#39;s identity. The user may have been verified by these providers | |
9
- | **remainder** | [**Array&lt;ProviderInformation&gt;**](ProviderInformation.md) | The list of providers that are not recognized and are not relevant to the user&#39;s identity | |
7
+ | **recognized** | [**Array&lt;ProviderInformation&gt;**](ProviderInformation.md) | The providers which the user is known to have a credential with. | |
8
+ | **relevant** | [**Array&lt;ProviderInformation&gt;**](ProviderInformation.md) | The providers which the user is deemed sufficiently likely to have a credential with. | |
9
+ | **remainder** | [**Array&lt;ProviderInformation&gt;**](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
 
data/docs/Session.md CHANGED
@@ -9,7 +9,7 @@
9
9
  | **success** | **Boolean** | Whether the Session has completed successfully. If this is &#x60;false&#x60;, the Session is either not yet done, or has failed. Inspect &#x60;Done&#x60; and &#x60;ErrorCode&#x60; for more information. If this is &#x60;true&#x60;, the Session has completed successfully. | |
10
10
  | **error_code** | [**SessionErrorCode**](SessionErrorCode.md) | The reason for the Session&#39;s failure. Only present if &#x60;Success&#x60; is &#x60;false&#x60;. | [optional] |
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&#39;s state last changed | |
12
+ | **updated** | **Integer** | The unix timestamp, in seconds, when this session&#39;s data was last updated | |
13
13
 
14
14
  ## Example
15
15
 
data/docs/SessionsApi.md CHANGED
@@ -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. Identity data that a user has chosen to save in their passkey-protected wallet will not be deleted.
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
 
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&#39;s Smart ID Document Number | [optional] |
8
+ | **smart_id_number** | **String** | The user&#39;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
 
@@ -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
- | **description** | **String** | Flavor text for the sub-provider | |
9
+ | **subtext** | **String** | The Provider&#39;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&#39;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&#39;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
- description: null,
21
+ subtext: dmv.ca.gov,
22
+ description: dmv.ca.gov,
21
23
  logo_url: null
22
24
  )
23
25
  ```
@@ -20,7 +20,7 @@ module TrinsicApi
20
20
  @api_client = api_client
21
21
  end
22
22
  # Get Attachment
23
- # Exchange an Attachment Access Key (from `IdentityData.Attachments`) for the raw contents of the attachment. 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.
23
+ # 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.
24
24
  # @param [Hash] opts the optional parameters
25
25
  # @option opts [GetAttachmentRequest] :get_attachment_request
26
26
  # @return [GetAttachmentResponse]
@@ -30,7 +30,7 @@ module TrinsicApi
30
30
  end
31
31
 
32
32
  # Get Attachment
33
- # Exchange an Attachment Access Key (from &#x60;IdentityData.Attachments&#x60;) 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.
33
+ # Exchange an Attachment Access Key (from &#x60;IdentityData.AttachmentAccessKeys&#x60;) for the raw contents of the attachment. Use this API to fetch document (front, back, portrait) or other (selfie) images from a verification, if relevant. In some cases, attachments may not be immediately available after a verification is completed. If so, this endpoint will return an HTTP 503 code, and you should try again later.
34
34
  # @param [Hash] opts the optional parameters
35
35
  # @option opts [GetAttachmentRequest] :get_attachment_request
36
36
  # @return [Array<(GetAttachmentResponse, Integer, Hash)>] GetAttachmentResponse data, response status code and response headers
@@ -79,6 +79,7 @@ module TrinsicApi
79
79
  # List Providers
80
80
  # List all identity providers available for use
81
81
  # @param [Hash] opts the optional parameters
82
+ # @option opts [String] :health Filter providers by health status. Valid values: \&quot;online\&quot;, \&quot;offline\&quot;, \&quot;all\&quot;. Defaults to \&quot;all\&quot;.
82
83
  # @return [ListProvidersResponse]
83
84
  def list_providers(opts = {})
84
85
  data, _status_code, _headers = list_providers_with_http_info(opts)
@@ -88,6 +89,7 @@ module TrinsicApi
88
89
  # List Providers
89
90
  # List all identity providers available for use
90
91
  # @param [Hash] opts the optional parameters
92
+ # @option opts [String] :health Filter providers by health status. Valid values: \&quot;online\&quot;, \&quot;offline\&quot;, \&quot;all\&quot;. Defaults to \&quot;all\&quot;.
91
93
  # @return [Array<(ListProvidersResponse, Integer, Hash)>] ListProvidersResponse data, response status code and response headers
92
94
  def list_providers_with_http_info(opts = {})
93
95
  if @api_client.config.debugging
@@ -98,6 +100,7 @@ module TrinsicApi
98
100
 
99
101
  # query parameters
100
102
  query_params = opts[:query_params] || {}
103
+ query_params[:'health'] = opts[:'health'] if !opts[:'health'].nil?
101
104
 
102
105
  # header parameters
103
106
  header_params = opts[:header_params] || {}
@@ -134,7 +137,7 @@ module TrinsicApi
134
137
  end
135
138
 
136
139
  # Recommend Providers
137
- # Generate provider recommendations based on the given signals (phone number, countries, states).
140
+ # Generate provider recommendations based on signals about the user's location (phone number, countries, states).
138
141
  # @param [Hash] opts the optional parameters
139
142
  # @option opts [RecommendRequest] :recommend_request
140
143
  # @return [RecommendResponse]
@@ -144,7 +147,7 @@ module TrinsicApi
144
147
  end
145
148
 
146
149
  # Recommend Providers
147
- # Generate provider recommendations based on the given signals (phone number, countries, states).
150
+ # Generate provider recommendations based on signals about the user&#39;s location (phone number, countries, states).
148
151
  # @param [Hash] opts the optional parameters
149
152
  # @option opts [RecommendRequest] :recommend_request
150
153
  # @return [Array<(RecommendResponse, Integer, Hash)>] RecommendResponse data, response status code and response headers
@@ -491,7 +491,7 @@ module TrinsicApi
491
491
  end
492
492
 
493
493
  # Redact Session
494
- # Redact a Session, removing all identity data from Trinsic's servers. Every application has a redaction period that dictates how long we will hold on to your users' PII data. Once a session falls outside the redaction cutoff date, all PII will automatically be removed from that session. You can utilize this endpoint to redact a session immediately. Identity data that a user has chosen to save in their passkey-protected wallet will not be deleted.
494
+ # 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.
495
495
  # @param session_id [String]
496
496
  # @param [Hash] opts the optional parameters
497
497
  # @return [nil]
@@ -501,7 +501,7 @@ module TrinsicApi
501
501
  end
502
502
 
503
503
  # Redact Session
504
- # Redact a Session, removing all identity data from Trinsic&#39;s servers. Every application has a redaction period that dictates how long we will hold on to your users&#39; PII data. Once a session falls outside the redaction cutoff date, all PII will automatically be removed from that session. You can utilize this endpoint to redact a session immediately. Identity data that a user has chosen to save in their passkey-protected wallet will not be deleted.
504
+ # Redact a Session, removing all identity data from Trinsic&#39;s servers. Every application has a redaction period that dictates how long we will hold on to your users&#39; 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.
505
505
  # @param session_id [String]
506
506
  # @param [Hash] opts the optional parameters
507
507
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -65,9 +65,6 @@ module TrinsicApi
65
65
  # List of attributes with nullable: true
66
66
  def self.openapi_nullable
67
67
  Set.new([
68
- :'national_id_number',
69
- :'date_of_birth',
70
- :'name',
71
68
  :'photo_byes',
72
69
  :'photo_image_mime_type'
73
70
  ])
@@ -91,14 +88,20 @@ module TrinsicApi
91
88
 
92
89
  if attributes.key?(:'national_id_number')
93
90
  self.national_id_number = attributes[:'national_id_number']
91
+ else
92
+ self.national_id_number = nil
94
93
  end
95
94
 
96
95
  if attributes.key?(:'date_of_birth')
97
96
  self.date_of_birth = attributes[:'date_of_birth']
97
+ else
98
+ self.date_of_birth = nil
98
99
  end
99
100
 
100
101
  if attributes.key?(:'name')
101
102
  self.name = attributes[:'name']
103
+ else
104
+ self.name = nil
102
105
  end
103
106
 
104
107
  if attributes.key?(:'photo_byes')
@@ -115,6 +118,34 @@ module TrinsicApi
115
118
  def list_invalid_properties
116
119
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
117
120
  invalid_properties = Array.new
121
+ if @national_id_number.nil?
122
+ invalid_properties.push('invalid value for "national_id_number", national_id_number cannot be nil.')
123
+ end
124
+
125
+ if @national_id_number.to_s.length > 17
126
+ invalid_properties.push('invalid value for "national_id_number", the character length must be smaller than or equal to 17.')
127
+ end
128
+
129
+ if @national_id_number.to_s.length < 10
130
+ invalid_properties.push('invalid value for "national_id_number", the character length must be great than or equal to 10.')
131
+ end
132
+
133
+ if @date_of_birth.nil?
134
+ invalid_properties.push('invalid value for "date_of_birth", date_of_birth cannot be nil.')
135
+ end
136
+
137
+ if @name.nil?
138
+ invalid_properties.push('invalid value for "name", name cannot be nil.')
139
+ end
140
+
141
+ if @name.to_s.length > 80
142
+ invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 80.')
143
+ end
144
+
145
+ if @name.to_s.length < 1
146
+ invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.')
147
+ end
148
+
118
149
  invalid_properties
119
150
  end
120
151
 
@@ -122,9 +153,62 @@ module TrinsicApi
122
153
  # @return true if the model is valid
123
154
  def valid?
124
155
  warn '[DEPRECATED] the `valid?` method is obsolete'
156
+ return false if @national_id_number.nil?
157
+ return false if @national_id_number.to_s.length > 17
158
+ return false if @national_id_number.to_s.length < 10
159
+ return false if @date_of_birth.nil?
160
+ return false if @name.nil?
161
+ return false if @name.to_s.length > 80
162
+ return false if @name.to_s.length < 1
125
163
  true
126
164
  end
127
165
 
166
+ # Custom attribute writer method with validation
167
+ # @param [Object] national_id_number Value to be assigned
168
+ def national_id_number=(national_id_number)
169
+ if national_id_number.nil?
170
+ fail ArgumentError, 'national_id_number cannot be nil'
171
+ end
172
+
173
+ if national_id_number.to_s.length > 17
174
+ fail ArgumentError, 'invalid value for "national_id_number", the character length must be smaller than or equal to 17.'
175
+ end
176
+
177
+ if national_id_number.to_s.length < 10
178
+ fail ArgumentError, 'invalid value for "national_id_number", the character length must be great than or equal to 10.'
179
+ end
180
+
181
+ @national_id_number = national_id_number
182
+ end
183
+
184
+ # Custom attribute writer method with validation
185
+ # @param [Object] date_of_birth Value to be assigned
186
+ def date_of_birth=(date_of_birth)
187
+ if date_of_birth.nil?
188
+ fail ArgumentError, 'date_of_birth cannot be nil'
189
+ end
190
+
191
+ @date_of_birth = date_of_birth
192
+ end
193
+
194
+ # Custom attribute writer method with validation
195
+ # @param [Object] name Value to be assigned
196
+ def name=(name)
197
+ if name.nil?
198
+ fail ArgumentError, 'name cannot be nil'
199
+ end
200
+
201
+ if name.to_s.length > 80
202
+ fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 80.'
203
+ end
204
+
205
+ if name.to_s.length < 1
206
+ fail ArgumentError, 'invalid value for "name", the character length must be great than or equal to 1.'
207
+ end
208
+
209
+ @name = name
210
+ end
211
+
128
212
  # Checks equality by comparing each attribute.
129
213
  # @param [Object] Object to be compared
130
214
  def ==(o)