trinsic_api 2.1.1.pre.alpha1 → 2.2.0.pre.alpha1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a346d0651e7c914f39cdef64d102ac58d2a2cc2daf632abc1b32d5122d206e1c
-  data.tar.gz: 73e7f867e74146e7016868de55ef50a6a4873b97f10fb8c6535448aef5838e50
+  metadata.gz: 1606f679ee6a3a00fd03d49a806262a05f341b274e73896f92d1399ea41189ae
+  data.tar.gz: 53386531142f18cf674f449b2936a68401ee7ea38f4725538cf04e150d7bcad3
 SHA512:
-  metadata.gz: 8ad1af9364ec817ad3700e70bf4d55f07bcb41a86f43389c6a87321779e7d6b5794b685483d1d7c6e16a921e186986da500e47e2f275c6e3e8790a0a41ffc928
-  data.tar.gz: b7c0e7e868aa712a840c35727c5a8b1f52bad5ddd9085c798ee9309686a75dd70423104ab186ae9886578198fa43bed8977d4ea7f570749fd4345ef354733251
+  metadata.gz: 72dc95e2cc0ca0624bf7e809b4cf51b9421f7b914a7dd73b9e9eac8b3378833b971660632690d9ebcc5fba1f4616ecf03a5b1d773c4d28c09e6d0eeaf67090a4
+  data.tar.gz: 5edb021eec2b2e0ed975b3730202d61f3fcba4d340dcfc4b652b53a9b09f8ca67448e08261f0a68574f964b46226a80ffc85f15dfea2abbe09913828621a609b

data/docs/AppleWalletInput.md

@@ -0,0 +1,18 @@
+# TrinsicApi::AppleWalletInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **exchange_mechanism** | [**MdlExchangeMechanism**](MdlExchangeMechanism.md) | The exchange mechanism to use for this Apple Wallet verification.              Use `DigitalCredentialsApi` for Digital Credentials API on web, or `NativeApp` for a native iOS app. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::AppleWalletInput.new(
+  exchange_mechanism: null
+)
+```
+

data/docs/AttachmentsApi.md

@@ -28,7 +28,7 @@ end
 
 api_instance = TrinsicApi::AttachmentsApi.new
 opts = {
-  get_attachment_request: TrinsicApi::GetAttachmentRequest.new({attachment_access_key: 'attachment_access_key_example'}) # GetAttachmentRequest | 
+  get_attachment_request: TrinsicApi::GetAttachmentRequest.new({attachment_access_key: 'attachment_access_key_example', session_id: '00000000-0000-0000-0000-000000000000'}) # GetAttachmentRequest | 
 }
 
 begin

data/docs/{CreateAdvancedProviderSessionRequest.md → CreateDirectProviderSessionRequest.md}

@@ -1,12 +1,13 @@
-# TrinsicApi::CreateAdvancedProviderSessionRequest
+# TrinsicApi::CreateDirectProviderSessionRequest
 
 ## Properties
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **provider** | **String** | The ID of the provider to launch |  |
+| **verification_profile_id** | **String** | The ID of the Verification Profile to use for this session. |  |
 | **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> |  |
+| **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/direct-provider-sessions\">the guide on Direct 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] |
 | **provider_input** | [**ProviderInput**](ProviderInput.md) | Provider-specific input for those providers which require it. | [optional] |
 
@@ -15,8 +16,9 @@
 ```ruby
 require 'trinsic_api'
 
-instance = TrinsicApi::CreateAdvancedProviderSessionRequest.new(
+instance = TrinsicApi::CreateDirectProviderSessionRequest.new(
   provider: null,
+  verification_profile_id: null,
   redirect_url: null,
   capabilities: null,
   fallback_to_hosted_ui: null,

data/docs/{CreateAdvancedProviderSessionResponse.md → CreateDirectProviderSessionResponse.md}

@@ -1,4 +1,4 @@
-# TrinsicApi::CreateAdvancedProviderSessionResponse
+# TrinsicApi::CreateDirectProviderSessionResponse
 
 ## Properties
 
@@ -13,7 +13,7 @@
 ```ruby
 require 'trinsic_api'
 
-instance = TrinsicApi::CreateAdvancedProviderSessionResponse.new(
+instance = TrinsicApi::CreateDirectProviderSessionResponse.new(
   session_id: 00000000-0000-0000-0000-000000000000,
   result_collection: null,
   next_step: null

data/docs/CreateHostedProviderSessionRequest.md

@@ -5,8 +5,9 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **provider** | **String** | The ID of the provider to launch |  |
+| **verification_profile_id** | **String** | The ID of the Verification Profile to use for this session. |  |
 | **redirect_url** | **String** | The Redirect URL to which the user should be sent after the session is complete. |  |
-| **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] |
+| **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 Direct Session endpoint instead. | [optional] |
 
 ## Example
 
@@ -15,6 +16,7 @@ require 'trinsic_api'
 
 instance = TrinsicApi::CreateHostedProviderSessionRequest.new(
   provider: null,
+  verification_profile_id: null,
   redirect_url: null,
   provider_input: null
 )

data/docs/CreateMdlExchangeRequest.md

@@ -0,0 +1,32 @@
+# TrinsicApi::CreateMdlExchangeRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **verification_profile_id** | **String** | The ID of the VerificationProfile to use for this mDL exchange. |  |
+| **provider** | **String** | The ID of the provider to use for this mDL exchange. |  |
+| **exchange_mechanism** | [**MdlExchangeMechanism**](MdlExchangeMechanism.md) | The mechanism by which the mDL exchange will occur (web, native SDK, etc.) |  |
+| **document_type** | **String** | The document type to request from the wallet.              Typically, this is one of the following values:              - `org.iso.18013.5.1.mDL` (Mobile Driver's License) - `com.google.wallet.idcard.1` (Google Wallet ID Pass) |  |
+| **name_spaces** | **Hash<String, Hash<String, Boolean>>** | The namespaces and fields to request from the mDL.              This is a nested map / dictionary. The outer dictionary's keys are namespaces (e.g. \"org.iso.18013.5.1\"). The inner dictionary's keys are field names within each namespace, with boolean values indicating whether the specified field will be retained post-verification. |  |
+| **digital_credentials_api_host** | **String** | If using the `DigitalCredentialsApi` exchange mechanism, this is the hostname on which the Digital Credentials API will be called.              For example, if the user is on the page `https://foo.example.com/verify-mdl`, the proper value to use is `foo.example.com`.              Present for ease of testing only. May be removed as this API is stabilized. | [optional] |
+| **android_native_app_package_name** | **String** | If using the `NativeApp` exchange mechanism with the `google-wallet` provider, this is the package name of the Android App which will execute the mDL exchange.              This should be set to the package name of your app.              Present for ease of testing only. May be removed as this API is stabilized. | [optional] |
+| **android_native_app_signing_certificate_fingerprint** | **String** | If using the `NativeApp` exchange mechanism with the `google-wallet` provider, this is the SHA-256 fingerprint of the signing certificate used to sign the Android App which will execute the mDL exchange.              Present for ease of testing only. May be removed as this API is stabilized. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::CreateMdlExchangeRequest.new(
+  verification_profile_id: null,
+  provider: google-wallet,
+  exchange_mechanism: null,
+  document_type: org.iso.18013.5.1.mDL,
+  name_spaces: {"org.iso.18013.5.1":{"given_name":true,"family_name":true,"birth_date":true,"age_over_21":true}},
+  digital_credentials_api_host: verify.trinsic.id,
+  android_native_app_package_name: id.trinsic.example,
+  android_native_app_signing_certificate_fingerprint: 96:77:82:71:A3:FC:26:54:4C:8E:06:70:B7:BA:5D:E2:A5:36:F1:ED:8F:8A:70:81:26:98:EC:87:86:0F:D4:42
+)
+```
+

data/docs/CreateMdlExchangeResponse.md

@@ -0,0 +1,22 @@
+# TrinsicApi::CreateMdlExchangeResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **exchange_id** | **String** | The ID of the mDL exchange which was created. |  |
+| **request_object_base64_url** | **String** | The request object for this mDL exchange.              Pass this into a Trinsic mDL SDK (Web, iOS, Android) exactly as-is to initiate the mDL exchange. |  |
+| **exchange_context** | **String** | The encrypted exchange context for this mDL exchange.              This must be passed back to the API during finalization, alongside the response token from the wallet. |  |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::CreateMdlExchangeResponse.new(
+  exchange_id: null,
+  request_object_base64_url: null,
+  exchange_context: null
+)
+```
+

data/docs/CreateWidgetSessionRequest.md

@@ -4,7 +4,8 @@
 
 | 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] |
+| **verification_profile_id** | **String** | The ID of the Verification Profile to use for this session. |  |
+| **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 a 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] |
 | **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] |
 
@@ -14,6 +15,7 @@
 require 'trinsic_api'
 
 instance = TrinsicApi::CreateWidgetSessionRequest.new(
+  verification_profile_id: null,
   redirect_url: null,
   providers: null,
   recommendation_info: null

data/docs/ExternalMdlFieldData.md

@@ -0,0 +1,20 @@
+# TrinsicApi::ExternalMdlFieldData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**MdlFieldDataType**](MdlFieldDataType.md) | The type of data contained in `value`. |  |
+| **value** | **String** | The string-encoded value of the field. |  |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::ExternalMdlFieldData.new(
+  type: null,
+  value: 123 Fake St
+)
+```
+

data/docs/FinalizeMdlExchangeRequest.md

@@ -0,0 +1,24 @@
+# TrinsicApi::FinalizeMdlExchangeRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **verification_profile_id** | **String** | The ID of the VerificationProfile which was used to create the mDL exchange. |  |
+| **exchange_id** | **String** | The ID of the mDL exchange to finalize. |  |
+| **exchange_context** | **String** | The encrypted exchange context which was returned when the mDL exchange was created. |  |
+| **response_token** | **String** | The response token returned by Trinsic's SDK after a successful mDL exchange. |  |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::FinalizeMdlExchangeRequest.new(
+  verification_profile_id: null,
+  exchange_id: null,
+  exchange_context: null,
+  response_token: null
+)
+```
+

data/docs/FinalizeMdlExchangeResponse.md

@@ -0,0 +1,24 @@
+# TrinsicApi::FinalizeMdlExchangeResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **exchange_id** | **String** | The Exchange ID of the mDL exchange which was just finalized. |  |
+| **created_session** | [**Session**](Session.md) | The AcceptanceSession which was created as a result of finalizing this mDL exchange. |  |
+| **mdl_data** | [**MdlIdentityData**](MdlIdentityData.md) | The identity data from the mDL exchange, in a semi-normalized format.              Supports all possible fields and namespaces, but does not map them to Trinsic's common data model. | [optional] |
+| **normalized_identity_data** | [**IdentityData**](IdentityData.md) | The identity data from the mDL exchange, normalized into Trinsic's common data model. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::FinalizeMdlExchangeResponse.new(
+  exchange_id: null,
+  created_session: null,
+  mdl_data: null,
+  normalized_identity_data: null
+)
+```
+

data/docs/GetAttachmentRequest.md

@@ -5,6 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **attachment_access_key** | **String** | The Attachment Access Key to exchange for the raw file contents of the related Attachment |  |
+| **session_id** | **String** | The ID of the Acceptance Session for which the Attachment is being requested. |  |
 
 ## Example
 
@@ -12,7 +13,8 @@
 require 'trinsic_api'
 
 instance = TrinsicApi::GetAttachmentRequest.new(
-  attachment_access_key: null
+  attachment_access_key: null,
+  session_id: 00000000-0000-0000-0000-000000000000
 )
 ```
 

data/docs/GoogleWalletInput.md

@@ -0,0 +1,18 @@
+# TrinsicApi::GoogleWalletInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **exchange_mechanism** | [**MdlExchangeMechanism**](MdlExchangeMechanism.md) | The exchange mechanism to use for this Google Wallet verification.              Use `DigitalCredentialsApi` for Digital Credentials API on web, or `NativeApp` for a native Android app. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::GoogleWalletInput.new(
+  exchange_mechanism: null
+)
+```
+

data/docs/IdentityData.md

@@ -8,6 +8,7 @@
 | **originating_sub_provider_id** | **String** |  | [optional] |
 | **person** | [**PersonData**](PersonData.md) |  | [optional] |
 | **document** | [**DocumentData**](DocumentData.md) |  | [optional] |
+| **match** | [**MatchData**](MatchData.md) |  | [optional] |
 | **attachment_access_keys** | [**AttachmentAccessKeys**](AttachmentAccessKeys.md) |  | [optional] |
 
 ## Example
@@ -20,6 +21,7 @@ instance = TrinsicApi::IdentityData.new(
   originating_sub_provider_id: null,
   person: null,
   document: null,
+  match: null,
   attachment_access_keys: null
 )
 ```

data/docs/{IndonesiaDukcapilBiometricMatchInput.md → IndonesiaDukcapilMatchInput.md}

@@ -1,4 +1,4 @@
-# TrinsicApi::IndonesiaDukcapilBiometricMatchInput
+# TrinsicApi::IndonesiaDukcapilMatchInput
 
 ## Properties
 
@@ -9,7 +9,7 @@
 | **nik_id_number** | **String** | The user's Indonesia NIK ID number | [optional] |
 | **email** | **String** | The email address of the individual.              Either email or phone number must be provided. | [optional] |
 | **phone_number** | **String** | The phone number of the individual.              Either email or phone number must be provided. | [optional] |
-| **selfie_image** | **String** | The raw bytes of the selfie image of the individual.              Must be JPEG format; 1MB maximum. | [optional] |
+| **selfie_image** | **String** | The raw bytes of the selfie image of the individual.              Must be JPEG or PNG format; 10MB maximum. | [optional] |
 | **document_image** | **String** | The raw bytes of the image of the individual's KTP government ID.              Must be JPEG format; 1MB maximum.              Optional. | [optional] |
 | **consent_given_at** | **Time** | The timestamp when consent was given by the user for the verification. | [optional] |
 
@@ -18,7 +18,7 @@
 ```ruby
 require 'trinsic_api'
 
-instance = TrinsicApi::IndonesiaDukcapilBiometricMatchInput.new(
+instance = TrinsicApi::IndonesiaDukcapilMatchInput.new(
   full_name: null,
   date_of_birth: null,
   nik_id_number: null,

data/docs/Match.md

@@ -0,0 +1,20 @@
+# TrinsicApi::Match
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **probability_value** | **Float** |  | [optional] |
+| **boolean_value** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::Match.new(
+  probability_value: null,
+  boolean_value: null
+)
+```
+

data/docs/MatchData.md

@@ -0,0 +1,36 @@
+# TrinsicApi::MatchData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **national_id_number** | [**Match**](Match.md) |  | [optional] |
+| **full_name** | [**Match**](Match.md) |  | [optional] |
+| **given_name** | [**Match**](Match.md) |  | [optional] |
+| **middle_name** | [**Match**](Match.md) |  | [optional] |
+| **family_name** | [**Match**](Match.md) |  | [optional] |
+| **sex** | [**Match**](Match.md) |  | [optional] |
+| **date_of_birth** | [**Match**](Match.md) |  | [optional] |
+| **face_match** | [**Match**](Match.md) |  | [optional] |
+| **liveness** | [**Match**](Match.md) |  | [optional] |
+| **image_authenticity** | [**Match**](Match.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::MatchData.new(
+  national_id_number: null,
+  full_name: null,
+  given_name: null,
+  middle_name: null,
+  family_name: null,
+  sex: null,
+  date_of_birth: null,
+  face_match: null,
+  liveness: null,
+  image_authenticity: null
+)
+```
+

data/docs/MdlApi.md

@@ -0,0 +1,151 @@
+# TrinsicApi::MdlApi
+
+All URIs are relative to *https://api.trinsic.id*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_mdl_exchange**](MdlApi.md#create_mdl_exchange) | **POST** /api/valpha/mdl/exchanges/create | Create mDL Exchange |
+| [**finalize_mdl_exchange**](MdlApi.md#finalize_mdl_exchange) | **POST** /api/valpha/mdl/exchanges/finalize | Finalize mDL Exchange |
+
+
+## create_mdl_exchange
+
+> <CreateMdlExchangeResponse> create_mdl_exchange(opts)
+
+Create mDL Exchange
+
+Creates a new mDL Exchange, returning an exchange ID, request object string, and context string.              mDL Exchanges are ephemeral until completion -- no state is stored within Trinsic until the exchange is finalized.              This API currently only supports Google Wallet on Android via Web or Native. Apple Wallet support is coming soon.
+
+### 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::MdlApi.new
+opts = {
+  create_mdl_exchange_request: TrinsicApi::CreateMdlExchangeRequest.new({verification_profile_id: 'verification_profile_id_example', provider: 'google-wallet', exchange_mechanism: TrinsicApi::MdlExchangeMechanism::NATIVE_APP, document_type: 'org.iso.18013.5.1.mDL', name_spaces: { key: { key: false}}}) # CreateMdlExchangeRequest | 
+}
+
+begin
+  # Create mDL Exchange
+  result = api_instance.create_mdl_exchange(opts)
+  p result
+rescue TrinsicApi::ApiError => e
+  puts "Error when calling MdlApi->create_mdl_exchange: #{e}"
+end
+```
+
+#### Using the create_mdl_exchange_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateMdlExchangeResponse>, Integer, Hash)> create_mdl_exchange_with_http_info(opts)
+
+```ruby
+begin
+  # Create mDL Exchange
+  data, status_code, headers = api_instance.create_mdl_exchange_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateMdlExchangeResponse>
+rescue TrinsicApi::ApiError => e
+  puts "Error when calling MdlApi->create_mdl_exchange_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_mdl_exchange_request** | [**CreateMdlExchangeRequest**](CreateMdlExchangeRequest.md) |  | [optional] |
+
+### Return type
+
+[**CreateMdlExchangeResponse**](CreateMdlExchangeResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, text/json, application/*+json
+- **Accept**: text/plain, application/json, text/json, application/problem+json
+
+
+## finalize_mdl_exchange
+
+> <FinalizeMdlExchangeResponse> finalize_mdl_exchange(opts)
+
+Finalize mDL Exchange
+
+Finalizes an mDL Exchange, processing the results
+
+### 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::MdlApi.new
+opts = {
+  finalize_mdl_exchange_request: TrinsicApi::FinalizeMdlExchangeRequest.new({verification_profile_id: 'verification_profile_id_example', exchange_id: 'exchange_id_example', exchange_context: 'exchange_context_example', response_token: 'response_token_example'}) # FinalizeMdlExchangeRequest | 
+}
+
+begin
+  # Finalize mDL Exchange
+  result = api_instance.finalize_mdl_exchange(opts)
+  p result
+rescue TrinsicApi::ApiError => e
+  puts "Error when calling MdlApi->finalize_mdl_exchange: #{e}"
+end
+```
+
+#### Using the finalize_mdl_exchange_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<FinalizeMdlExchangeResponse>, Integer, Hash)> finalize_mdl_exchange_with_http_info(opts)
+
+```ruby
+begin
+  # Finalize mDL Exchange
+  data, status_code, headers = api_instance.finalize_mdl_exchange_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <FinalizeMdlExchangeResponse>
+rescue TrinsicApi::ApiError => e
+  puts "Error when calling MdlApi->finalize_mdl_exchange_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **finalize_mdl_exchange_request** | [**FinalizeMdlExchangeRequest**](FinalizeMdlExchangeRequest.md) |  | [optional] |
+
+### Return type
+
+[**FinalizeMdlExchangeResponse**](FinalizeMdlExchangeResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, text/json, application/*+json
+- **Accept**: text/plain, application/json, text/json, application/problem+json
+

data/docs/MdlCertificateData.md

@@ -0,0 +1,26 @@
+# TrinsicApi::MdlCertificateData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **serial_number** | **String** | The serial number of the certificate |  |
+| **common_name** | **String** | The common name (CN) of the certificate |  |
+| **state_or_province_name** | **String** | The state or province name (ST) of the certificate.              May be an empty string for certificates which are not state-specific (e.g., Google Wallet's ID Pass certificates). |  |
+| **not_before** | **Time** | The date before which this certificate is not valid. |  |
+| **not_after** | **Time** | The date after which this certificate is not valid. |  |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::MdlCertificateData.new(
+  serial_number: null,
+  common_name: null,
+  state_or_province_name: null,
+  not_before: null,
+  not_after: null
+)
+```
+

data/docs/MdlExchangeMechanism.md

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

data/docs/MdlFieldDataType.md

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

data/docs/MdlIdentityData.md

@@ -0,0 +1,22 @@
+# TrinsicApi::MdlIdentityData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **iaca_root_certificate** | [**MdlCertificateData**](MdlCertificateData.md) | Information about the IACA Root Certificate which signed the Issuer Certificate for this mDL. |  |
+| **document_signer_certificate** | [**MdlCertificateData**](MdlCertificateData.md) | Information about the Document Signer Certificate which signed the mDL presented by the user. |  |
+| **name_spaces** | **Hash<String, Hash<String, ExternalMdlFieldData>>** | The namespaces, and fields within those namespaces, which were present in the processed mDL. |  |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::MdlIdentityData.new(
+  iaca_root_certificate: null,
+  document_signer_certificate: null,
+  name_spaces: {"org.iso.18013.5.1":{"family_name":{"type":"String","value":"DOE"},"given_name":{"type":"String","value":"JOHN"},"birth_date":{"type":"String","value":"2000-03-27"},"age_over_21":{"type":"Boolean","value":"true"}}}
+)
+```
+