trinsic_api 2.0.0.pre.alpha3 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52a9b11625e2f73927d0a96e3c33c2755eae31d9c04a162ab7a85b91be2f6fa6
-  data.tar.gz: 189f8f249163f376410a00d52c13f3997d09a8ce19e27cce24cbfbeb96e91454
+  metadata.gz: c4f23ecceaf01bbc42f2fa2089457277132aa516d5820a316da9d9ea75f3cfb6
+  data.tar.gz: 10caa0a74ff4142f0c536c2a95adc0cc04888d80f2f3fd357af99a87a9c2560b
 SHA512:
-  metadata.gz: b44904314be04019690dc752bd2943229a7570a7abaf618ac8da70a5ec72597ff7387c8621c7d5d440b6aa23f1e00ee69eb1180eaa6a28e0ccb3bb048a3e3ec2
-  data.tar.gz: 2ead6f95554841b749d19d97a5e49319b8962e018f2ad61ec1a6a6f5debb4ebda1953994420af4154212dfefc702bdf777bd789490b2f9f87da14fb153e25155
+  metadata.gz: 4024fb98584c58df4d3cb55d4e3330a68db481f8ce495b9ff7ae669a0105454a9902bd4eb8d036b555f125d1838acd590c1e94d50c5127905a866c58958c76e5
+  data.tar.gz: c3766c8b8116a393e621f711ba475fb3659f48874d7531ef810884d3285f84cc5628d652b7262c33664e2e1a0572ee83e6e62fffd16277a5957e6d03d90b3b4d

data/README.md

@@ -38,7 +38,7 @@ attachments = TrinsicApi::AttachmentsApi.new
 network = TrinsicApi::NetworkApi.new
 sessions = TrinsicApi::SessionsApi.new
 
-sessions.create_session({})
+sessions.create_widget_session({})
 ```
 
 You can find a full Ruby server example in the [samples](https://github.com/trinsic-id/sdk/tree/main/api-ruby/samples) folder.

data/docs/AttachmentsApi.md

@@ -13,7 +13,7 @@ All URIs are relative to *https://api.trinsic.id*
 
 Get Attachment
 
-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.
+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.
 
 ### Examples
 

data/docs/BrazilDigitalCnhInput.md

@@ -5,8 +5,8 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **cpf_number** | **String** | The user's 11-digit, numeric CPF Number |  |
-| **digital_cnh_file** | **String** | The raw bytes of the digital CNH file collected from the user.                TODO: Lucas or JP help me describe these below vvvvvvvv  This can be:  - An image containing a physical or digital QR code  - A PDF file exported from the CNH app  - Some scary third thing? | [optional] |
-| **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] |
+| **digital_cnh_file** | **String** | The raw bytes of the digital CNH file collected from the user.              TODO: Lucas or JP help me describe these below vvvvvvvv This can be: - An image containing a physical or digital QR code - A PDF file exported from the CNH app - Some scary third thing? | [optional] |
+| **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] |
 | **facial_biometry_photo** | **String** | The raw bytes of the image of the user's face, collected for biometric comparison. | [optional] |
 
 ## Example

data/docs/CreateAdvancedProviderSessionRequest.md

@@ -6,9 +6,9 @@
 | ---- | ---- | ----------- | ----- |
 | **provider** | **String** | The ID of the provider to launch |  |
 | **provider_input** | [**ProviderInput**](ProviderInput.md) | Provider-specific input for those providers which require it. | [optional] |
-| **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] |
-| **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> |  |
-| **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] |
+| **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] |
+| **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> |  |
+| **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] |
 
 ## Example
 

data/docs/CreateHostedProviderSessionResponse.md

@@ -5,7 +5,8 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **session_id** | **String** | The ID of the newly-created Acceptance Session |  |
-| **launch_url** | **String** | The URL that should be used to launch the Hosted Provider Session on your user's device.                There are two recommended ways to do so:  - Redirect their browser to the `LaunchUrl` as a top-level navigation  - Open a popup window and navigate it to the `LaunchUrl`                This URL is sensitive and as such can only be obtained once. If you need to obtain it again, you will need to create a new Acceptance Session. | [optional] |
+| **launch_url** | **String** | The URL that should be used to launch the Hosted Provider Session on your user's device.              There are two recommended ways to do so: - Redirect their browser to the `LaunchUrl` as a top-level navigation - Open a popup window and navigate it to the `LaunchUrl`              This URL is sensitive and as such can only be obtained once. If you need to obtain it again, you will need to create a new Acceptance Session. |  |
+| **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. |  |
 
 ## Example
 
@@ -14,7 +15,8 @@ require 'trinsic_api'
 
 instance = TrinsicApi::CreateHostedProviderSessionResponse.new(
   session_id: null,
-  launch_url: https://api.trinsic.id/api/session/launch?clientToken=...
+  launch_url: https://api.trinsic.id/api/session/launch?clientToken=...,
+  results_access_key: 417zNGHMJp6Ht2jCoktTLNGDRZEt4BqTwwQ8Q9ZaQz8aS4Jd7nD1xff2WLhPS69j5q9QT4gvgV79Gv7QtaXwu5YC9Utr35...
 )
 ```
 

data/docs/CreateWidgetSessionRequest.md

@@ -4,9 +4,9 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **redirect_url** | **String** | The URL to redirect the user to after the widget session is complete.                *Note*: this should NOT be set if you intend to use Trinsic's Web UI SDK to launch the Widget  as an embedded iFrame or popup; in that case, session resolution is handled by our SDK, not via redirect. | [optional] |
+| **redirect_url** | **String** | The URL to redirect the user to after the widget session is complete.              *Note*: this should NOT be set if you intend to use Trinsic's Web UI SDK to launch the Widget as an embedded iFrame or popup; in that case, session resolution is handled by our SDK, not via redirect. | [optional] |
 | **providers** | **Array<String>** | The list of allowed identity providers. If not specified, all available providers will be allowed. | [optional] |
-| **known_identity_data** | [**KnownIdentityData**](KnownIdentityData.md) | Known identity data of an individual being verified.                Provide this to Trinsic during Session creation to enable improved identity provider selection recommendations. | [optional] |
+| **recommendation_info** | [**RecommendationInfo**](RecommendationInfo.md) | Data that you already know about the user being verified.   This data is used to improve the user experience during provider selection, by surfacing the most relevant providers first. | [optional] |
 
 ## Example
 
@@ -16,7 +16,7 @@ require 'trinsic_api'
 instance = TrinsicApi::CreateWidgetSessionRequest.new(
   redirect_url: null,
   providers: null,
-  known_identity_data: null
+  recommendation_info: null
 )
 ```
 

data/docs/CreateWidgetSessionResponse.md

@@ -5,7 +5,8 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **session_id** | **String** | The ID of the newly-created Acceptance Session |  |
-| **launch_url** | **String** | The URL that should be used to invoke the Acceptance Session on your user's device.                You can use our frontend SDKs to launch the user into the Acceptance Session, or you can redirect the user's browser to this URL.                This URL is sensitive and as such can only be obtained once. If you need to obtain it again, you will need to create a new Acceptance Session. | [optional] |
+| **launch_url** | **String** | The URL that should be used to invoke the Acceptance Session on your user's device.              You can use our frontend SDKs to launch the user into the Acceptance Session, or you can redirect the user's browser to this URL.              This URL is sensitive and as such can only be obtained once. If you need to obtain it again, you will need to create a new Acceptance Session. |  |
+| **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. |  |
 
 ## Example
 
@@ -14,7 +15,8 @@ require 'trinsic_api'
 
 instance = TrinsicApi::CreateWidgetSessionResponse.new(
   session_id: null,
-  launch_url: https://api.trinsic.id/api/session/launch?clientToken=...
+  launch_url: https://api.trinsic.id/api/session/launch?clientToken=...,
+  results_access_key: 417zNGHMJp6Ht2jCoktTLNGDRZEt4BqTwwQ8Q9ZaQz8aS4Jd7nD1xff2WLhPS69j5q9QT4gvgV79Gv7QtaXwu5YC9Utr35...
 )
 ```
 

data/docs/IdentityData.md

@@ -5,6 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **originating_provider_id** | **String** |  | [optional] |
+| **originating_sub_provider_id** | **String** |  | [optional] |
 | **person** | [**PersonData**](PersonData.md) |  | [optional] |
 | **document** | [**DocumentData**](DocumentData.md) |  | [optional] |
 | **attachment_access_keys** | [**AttachmentAccessKeys**](AttachmentAccessKeys.md) |  | [optional] |
@@ -16,6 +17,7 @@ require 'trinsic_api'
 
 instance = TrinsicApi::IdentityData.new(
   originating_provider_id: null,
+  originating_sub_provider_id: null,
   person: null,
   document: null,
   attachment_access_keys: null

data/docs/IdinInput.md

@@ -0,0 +1,18 @@
+# TrinsicApi::IdinInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **sub_provider_id** | **String** | The ID of the specific bank to invoke with IDIN.              If not specified, the user will be prompted to select a bank. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::IdinInput.new(
+  sub_provider_id: null
+)
+```
+

data/docs/IntegrationStep.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **method** | [**IntegrationLaunchMethod**](IntegrationLaunchMethod.md) | The launch method to perform |  |
 | **content** | **String** | Step type-specific content related to the step: a URL for `LaunchBrowser`, a deeplink for `DeeplinkToMobile` or a string to show to the user for `ShowContent`. |  |
-| **refresh** | [**StepRefreshInfo**](StepRefreshInfo.md) | If non-null, contains metadata about how to refresh the value of `content`. |  |
+| **refresh** | [**StepRefreshInfo**](StepRefreshInfo.md) | If non-null, contains metadata about how to refresh the value of `content`. | [optional] |
 
 ## Example
 

data/docs/Language.md

@@ -0,0 +1,15 @@
+# TrinsicApi::Language
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::Language.new()
+```
+

data/docs/ListProviderContractsResponse.md

@@ -0,0 +1,18 @@
+# TrinsicApi::ListProviderContractsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **provider_contracts** | [**Array<ProviderContract>**](ProviderContract.md) | Contracts for all Providers available to your App, filtered by your App's current test mode setting. |  |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::ListProviderContractsResponse.new(
+  provider_contracts: null
+)
+```
+

data/docs/MobileIdInput.md

@@ -0,0 +1,22 @@
+# TrinsicApi::MobileIdInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mobile_id_phone_number** | **String** | The user's phone number in E.164 format | [optional] |
+| **mobile_id_national_identity_number** | **String** | The user's National ID number | [optional] |
+| **mobile_id_language** | [**Language**](Language.md) | The user's language -- LIT, EST, ENG, or RUS | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::MobileIdInput.new(
+  mobile_id_phone_number: null,
+  mobile_id_national_identity_number: null,
+  mobile_id_language: null
+)
+```
+

data/docs/NetworkApi.md

@@ -4,15 +4,82 @@ All URIs are relative to *https://api.trinsic.id*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**list_providers**](NetworkApi.md#list_providers) | **GET** /api/v1/network/providers | List Identity Providers |
+| [**list_provider_contracts**](NetworkApi.md#list_provider_contracts) | **GET** /api/v1/network/providers/contracts | List Provider Contracts |
+| [**list_providers**](NetworkApi.md#list_providers) | **GET** /api/v1/network/providers | List Providers |
 | [**recommend_providers**](NetworkApi.md#recommend_providers) | **POST** /api/v1/network/recommend | Recommend Providers |
 
 
+## list_provider_contracts
+
+> <ListProviderContractsResponse> list_provider_contracts
+
+List Provider Contracts
+
+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.
+
+### Examples
+
+```ruby
+require 'time'
+require 'trinsic_api'
+# setup authorization
+TrinsicApi.configure do |config|
+  # Configure Bearer authorization: Bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = TrinsicApi::NetworkApi.new
+
+begin
+  # List Provider Contracts
+  result = api_instance.list_provider_contracts
+  p result
+rescue TrinsicApi::ApiError => e
+  puts "Error when calling NetworkApi->list_provider_contracts: #{e}"
+end
+```
+
+#### Using the list_provider_contracts_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListProviderContractsResponse>, Integer, Hash)> list_provider_contracts_with_http_info
+
+```ruby
+begin
+  # List Provider Contracts
+  data, status_code, headers = api_instance.list_provider_contracts_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListProviderContractsResponse>
+rescue TrinsicApi::ApiError => e
+  puts "Error when calling NetworkApi->list_provider_contracts_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ListProviderContractsResponse**](ListProviderContractsResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/plain, application/json, text/json
+
+
 ## list_providers
 
 > <ListProvidersResponse> list_providers
 
-List Identity Providers
+List Providers
 
 List all identity providers available for use
 
@@ -30,7 +97,7 @@ end
 api_instance = TrinsicApi::NetworkApi.new
 
 begin
-  # List Identity Providers
+  # List Providers
   result = api_instance.list_providers
   p result
 rescue TrinsicApi::ApiError => e
@@ -46,7 +113,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # List Identity Providers
+  # List Providers
   data, status_code, headers = api_instance.list_providers_with_http_info
   p status_code # => 2xx
   p headers # => { ... }

data/docs/ProviderContract.md

@@ -0,0 +1,48 @@
+# TrinsicApi::ProviderContract
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The ID of the Provider for this contract. |  |
+| **name** | **String** | The Provider's Name as it appears in Trinsic's Dashboard and Widget |  |
+| **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. |  |
+| **logo_url** | **String** | A URL pointing to the Provider's logo on Trinsic's CDN.              May be a PNG, JPG, or SVG image. |  |
+| **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. |  |
+| **geography** | **Array<String>** | The geographies within the Regions the Provider is available. |  |
+| **regions** | **Array<String>** | The regions within which the Provider is available. |  |
+| **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. |  |
+| **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. |  |
+| **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. |  |
+| **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. |  |
+| **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. |  |
+| **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. |  |
+| **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. |  |
+| **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] |
+| **status** | [**ProviderHealth**](ProviderHealth.md) | The current status of the provider and if it is available to launch. If the status is disabled, there is an issue that prevents a provider being able to launch a session. |  |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::ProviderContract.new(
+  id: ca-mdl,
+  name: CA DMV,
+  description: dmv.ca.gov,
+  logo_url: https://content.trinsic.id/connect/integrations/ca-dmv.png,
+  available: true,
+  geography: ["CA"],
+  regions: ["United States"],
+  launch_method: null,
+  collection_method: null,
+  results_may_be_delayed_after_redirect: false,
+  has_refreshable_content: false,
+  requires_input: false,
+  has_trinsic_interface: true,
+  supports_advanced_provider_sessions: true,
+  sub_providers: null,
+  status: null
+)
+```
+

data/docs/ProviderHealth.md

@@ -0,0 +1,15 @@
+# TrinsicApi::ProviderHealth
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::ProviderHealth.new()
+```
+

data/docs/ProviderInfo.md

@@ -7,7 +7,6 @@
 | **id** | **String** | The ID of the provider |  |
 | **name** | **String** | The friendly, human-readable name of the provider |  |
 | **logo_url** | **String** | A URL pointing to the provider's logo |  |
-| **child_provider_ids** | **Array<String>** | List of child provider id's where the provider allows deep-launching of a specific provider. | [optional] |
 
 ## Example
 
@@ -17,8 +16,7 @@ require 'trinsic_api'
 instance = TrinsicApi::ProviderInfo.new(
   id: yoti | clear | ...,
   name: Yoti | CLEAR | ...,
-  logo_url: null,
-  child_provider_ids: null
+  logo_url: null
 )
 ```
 

data/docs/ProviderInformation.md

@@ -4,9 +4,9 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **provider_id** | **String** |  |  |
-| **provider_display_name** | **String** |  |  |
-| **provider_logo** | **String** |  |  |
+| **provider_id** | **String** |  | [readonly] |
+| **provider_display_name** | **String** |  | [readonly] |
+| **provider_logo** | **String** |  | [readonly] |
 
 ## Example
 

data/docs/ProviderInput.md

@@ -4,17 +4,23 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **indonesia_nik** | [**IndonesiaNikInput**](IndonesiaNikInput.md) | Input for the `f-indonesia-nik` integration | [optional] |
-| **mexico_curp** | [**MexicoCurpInput**](MexicoCurpInput.md) | Input for the `f-mexico-curp` integration | [optional] |
-| **south_africa_nid** | [**SouthAfricaNidInput**](SouthAfricaNidInput.md) | Input for the `f-south-africa-nid` integration | [optional] |
-| **kenya_nid** | [**KenyaNidInput**](KenyaNidInput.md) | Input for the `f-kenya-nid` integration | [optional] |
-| **nigeria_nin** | [**NigeriaNinInput**](NigeriaNinInput.md) | Input for the `f-nigeria-nin` integration | [optional] |
-| **aadhaar** | [**AadhaarInput**](AadhaarInput.md) | Input for the `f-india-aadhaar-match` integration | [optional] |
-| **bangladesh_national_id** | [**BangladeshNationalIdInput**](BangladeshNationalIdInput.md) | Input for the `bangladesh-nid` integration | [optional] |
-| **brazil_cpf_check** | [**BrazilCpfCheckInput**](BrazilCpfCheckInput.md) | Input for the `g-brazil-cpf` integration | [optional] |
-| **brazil_digital_cnh** | [**BrazilDigitalCnhInput**](BrazilDigitalCnhInput.md) | Input for the `g-brazil-digital-cnh` integration | [optional] |
-| **philippine_match** | [**PhilippineMatchInput**](PhilippineMatchInput.md) | Input for the `b-philsys-biometric` integration | [optional] |
-| **philippine_qr** | [**PhilippineQRInput**](PhilippineQRInput.md) | Input for the `b-philippine-qr-digital-national-id` and `b-philippine-qr-ephill-id` integrations | [optional] |
+| **indonesia_nik** | [**IndonesiaNikInput**](IndonesiaNikInput.md) | Input for the `f-indonesia-nik` provider | [optional] |
+| **mexico_curp** | [**MexicoCurpInput**](MexicoCurpInput.md) | Input for the `f-mexico-curp` provider | [optional] |
+| **south_africa_nid** | [**SouthAfricaNidInput**](SouthAfricaNidInput.md) | Input for the `f-south-africa-nid` provider | [optional] |
+| **kenya_nid** | [**KenyaNidInput**](KenyaNidInput.md) | Input for the `f-kenya-nid` provider | [optional] |
+| **nigeria_nin** | [**NigeriaNinInput**](NigeriaNinInput.md) | Input for the `f-nigeria-nin` provider | [optional] |
+| **aadhaar** | [**AadhaarInput**](AadhaarInput.md) | Input for the `f-india-aadhaar-match` provider | [optional] |
+| **bangladesh_national_id** | [**BangladeshNationalIdInput**](BangladeshNationalIdInput.md) | Input for the `bangladesh-nid` provider | [optional] |
+| **brazil_cpf_check** | [**BrazilCpfCheckInput**](BrazilCpfCheckInput.md) | Input for the `g-brazil-cpf` provider | [optional] |
+| **brazil_digital_cnh** | [**BrazilDigitalCnhInput**](BrazilDigitalCnhInput.md) | Input for the `g-brazil-digital-cnh` provider | [optional] |
+| **philippine_match** | [**PhilippineMatchInput**](PhilippineMatchInput.md) | Input for the `b-philsys-biometric` provider | [optional] |
+| **philippine_qr** | [**PhilippineQRInput**](PhilippineQRInput.md) | Input for the `b-philippine-qr-digital-national-id` and `b-philippine-qr-ephill-id` providers | [optional] |
+| **smart_id** | [**SmartIdInput**](SmartIdInput.md) | Input for the `smart-id` provider | [optional] |
+| **mobile_id** | [**MobileIdInput**](MobileIdInput.md) | Input for the `mobile-id` provider | [optional] |
+| **idin** | [**IdinInput**](IdinInput.md) | Input for the `idin` provider | [optional] |
+| **spid** | [**SpidInput**](SpidInput.md) | Input for the `spid` provider | [optional] |
+| **trinsic_test_database_lookup** | [**TrinsicTestDatabaseLookupInput**](TrinsicTestDatabaseLookupInput.md) | *TEST MODE ONLY.*              Input for the `trinsic-test-database-lookup` provider | [optional] |
+| **trinsic_test_sub_providers** | [**TrinsicTestSubProvidersInput**](TrinsicTestSubProvidersInput.md) | *TEST MODE ONLY.*              Input for the `trinsic-test-sub-providers` provider | [optional] |
 
 ## Example
 
@@ -32,7 +38,13 @@ instance = TrinsicApi::ProviderInput.new(
   brazil_cpf_check: null,
   brazil_digital_cnh: null,
   philippine_match: null,
-  philippine_qr: null
+  philippine_qr: null,
+  smart_id: null,
+  mobile_id: null,
+  idin: null,
+  spid: null,
+  trinsic_test_database_lookup: null,
+  trinsic_test_sub_providers: null
 )
 ```
 

data/docs/RecommendRequest.md

@@ -4,11 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **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 | [optional] |
-| **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] |
-| **subdivisions** | **Array<String>** | If one of the countries has subdivisions, for example the US states, you can specify a list of these to further refine the recommendation (e.g., CA, UT, NY) | [optional] |
-| **ip_addresses** | **Array<String>** | Provide the IP addresses of the user you wish to generate a recommendation for. Will be used to look up the user's geographic location. | [optional] |
-| **include_disabled_providers** | **Boolean** | If true, the recommendation will include providers that are disabled for the app | [optional] |
+| **recommendation_info** | [**RecommendationInfo**](RecommendationInfo.md) | Information about the user you wish to generate a recommendation for. | [optional] |
 
 ## Example
 
@@ -16,11 +12,7 @@
 require 'trinsic_api'
 
 instance = TrinsicApi::RecommendRequest.new(
-  phone_number: null,
-  countries: null,
-  subdivisions: null,
-  ip_addresses: null,
-  include_disabled_providers: null
+  recommendation_info: null
 )
 ```
 

data/docs/RecommendationInfo.md

@@ -0,0 +1,24 @@
+# TrinsicApi::RecommendationInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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] |
+| **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] |
+| **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] |
+| **ip_addresses** | **Array<String>** | Any IP addresses related to the user.              Will be used to determine the user's geographic location. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::RecommendationInfo.new(
+  phone_number: null,
+  countries: null,
+  subdivisions: null,
+  ip_addresses: null
+)
+```
+

data/docs/ResultCollection.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **method** | [**ResultCollectionMethod**](ResultCollectionMethod.md) | The method by which the results of the Acceptance Session should be collected. |  |
-| **results_access_key** | **String** | If the method is `PollResult`, this is the key that should be used to poll for the results. | [optional] |
+| **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. |  |
 
 ## Example
 
@@ -14,7 +14,7 @@ require 'trinsic_api'
 
 instance = TrinsicApi::ResultCollection.new(
   method: null,
-  results_access_key: null
+  results_access_key: 417zNGHMJp6Ht2jCoktTLNGDRZEt4BqTwwQ8Q9ZaQz8aS4Jd7nD1xff2WLhPS69j5q9QT4gvgV79Gv7QtaXwu5YC9Utr35...
 )
 ```
 

data/docs/Session.md

@@ -5,9 +5,9 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** |  |  |
-| **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. |  |
-| **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. |  |
-| **error_code** | [**SessionErrorCode**](SessionErrorCode.md) | The reason for the Session's failure.                Only present if `Success` is `false`. | [optional] |
+| **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. |  |
+| **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. |  |
+| **error_code** | [**SessionErrorCode**](SessionErrorCode.md) | The reason for the Session's failure.              Only present if `Success` is `false`. | [optional] |
 | **created** | **Integer** | The unix timestamp, in seconds, when this session was created |  |
 | **updated** | **Integer** | The unix timestamp, in seconds, when this session's state last changed |  |
 

data/docs/SessionsApi.md

@@ -90,7 +90,7 @@ end
 
 Create Advanced Provider Session
 
-Verify a user's identity with a specific provider, handling additional user interaction in your own UI.    Signal which kinds of user interactions your UI can handle using the `Capabilities` field.    If `FallbackToHostedUi` is `true`, Trinsic's hosted UI will automatically be invoked to handle any capabilities you do not support.
+Verify a user's identity with a specific provider, handling additional user interaction in your own UI.   Signal which kinds of user interactions your UI can handle using the `Capabilities` field.   If `FallbackToHostedUi` is `true`, Trinsic's hosted UI will automatically be invoked to handle any capabilities you do not support.
 
 ### Examples
 
@@ -520,7 +520,7 @@ end
 
 Redact Session
 
-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.
+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.
 
 ### Examples
 

data/docs/SmartIdInput.md

@@ -0,0 +1,18 @@
+# TrinsicApi::SmartIdInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **smart_id_document_number** | **String** | The user's Smart ID Document Number | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::SmartIdInput.new(
+  smart_id_document_number: null
+)
+```
+