trinsic_api 2.2.0 → 2.3.0.pre.alpha2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7119195ef1973bb58ec167091a9fb2b4bec432da992452638f76af0163dff5b4
-  data.tar.gz: d725f104318f759292c70adf177d7e0a0909d97a5946720d28a9eed09e2e3108
+  metadata.gz: ceb20a76b3ebff0814c4e9ef9a7043835e84d821a8121a43af33379a1593a76c
+  data.tar.gz: 4752bcc20ae9699e9882c01285f4b8336eb8d7b93e345c65d8b4c17b7a0d93f7
 SHA512:
-  metadata.gz: 29575cae410be8e818ff5918930730731b4efe8616023f7a99f2e1936c5e116c87849d4b6c295920e2fedcb355f9b0231d1bbba417ad3d27c15b6e4739e1189a
-  data.tar.gz: 1296cfb9a8eaa46d654431b010eb714c7b73f6890e2b28d48ac60e0162ca82e9e9b479512114ac95a5ecacd5a98d9ddcbcaf11c250dae95c01774b38789deb3a
+  metadata.gz: 044ebe2fbdd4e9d184823d96bfdaefaba43cf88eb620473a55153575f1eeb54e3d3fe2620f3ad9c29c6b27678e46f9252d518c5796d4f7069e819a3b989cbf4e
+  data.tar.gz: 3aefba01cfb157792d5a64f130d3d01c8f14f08205b38b5ee75cf9f625c5a3ed30205f70ef27348e6f74c079df43f041b64ecbf090db15158bdad2040d63382c

data/docs/AddRedirectUriResponse.md

@@ -0,0 +1,18 @@
+# TrinsicApi::AddRedirectUriResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::AddRedirectUriResponse.new(
+  id: null
+)
+```
+

data/docs/AttachmentAccessKeys.md

@@ -8,6 +8,7 @@
 | **document_front** | **String** |  | [optional] |
 | **document_back** | **String** |  | [optional] |
 | **document_portrait** | **String** |  | [optional] |
+| **document_signature** | **String** |  | [optional] |
 | **provider** | [**ProviderAttachments**](ProviderAttachments.md) |  |  |
 
 ## Example
@@ -20,6 +21,7 @@ instance = TrinsicApi::AttachmentAccessKeys.new(
   document_front: null,
   document_back: null,
   document_portrait: null,
+  document_signature: null,
   provider: null
 )
 ```

data/docs/ContractField.md

@@ -5,6 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **name** | **String** | The name of the field as it appears in verification results. |  |
+| **scope** | **String** | The scope of the field as it appears in verification results. |  |
 | **outputted** | [**FieldAvailability**](FieldAvailability.md) | Indicates when this field will be present in verification results. |  |
 
 ## Example
@@ -14,6 +15,7 @@ require 'trinsic_api'
 
 instance = TrinsicApi::ContractField.new(
   name: person.givenName,
+  scope: person.givenName,
   outputted: null
 )
 ```

data/docs/ContractIdentifierField.md

@@ -0,0 +1,22 @@
+# TrinsicApi::ContractIdentifierField
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **scope** | **String** | The scope of the identifier as it appears in verification results. |  |
+| **outputted** | [**FieldAvailability**](FieldAvailability.md) | Indicates when this field will be present in verification results. |  |
+| **description** | **String** | A human-readable description of the identifier, written by Trinsic. |  |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::ContractIdentifierField.new(
+  scope: vatNumber,
+  outputted: null,
+  description: Italian fiscal number from the SPID identity
+)
+```
+

data/docs/CreateHostedProviderSessionResponse.md

@@ -15,7 +15,7 @@ require 'trinsic_api'
 
 instance = TrinsicApi::CreateHostedProviderSessionResponse.new(
   session_id: null,
-  launch_url: https://api.trinsic.id/api/session/launch?clientToken=...,
+  launch_url: https://verify.trinsic.id/api/session/launch?clientToken=...,
   results_access_key: 417zNGHMJp6Ht2jCoktTLNGDRZEt4BqTwwQ8Q9ZaQz8aS4Jd7nD1xff2WLhPS69j5q9QT4gvgV79Gv7QtaXwu5YC9Utr35...
 )
 ```

data/docs/CreateVerificationProfileResponse.md

@@ -0,0 +1,18 @@
+# TrinsicApi::CreateVerificationProfileResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The ID of the verification profile |  |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::CreateVerificationProfileResponse.new(
+  id: null
+)
+```
+

data/docs/CreateWidgetSessionResponse.md

@@ -15,7 +15,7 @@ require 'trinsic_api'
 
 instance = TrinsicApi::CreateWidgetSessionResponse.new(
   session_id: null,
-  launch_url: https://api.trinsic.id/api/session/launch?clientToken=...,
+  launch_url: https://verify.trinsic.id/api/session/launch?clientToken=...,
   results_access_key: 417zNGHMJp6Ht2jCoktTLNGDRZEt4BqTwwQ8Q9ZaQz8aS4Jd7nD1xff2WLhPS69j5q9QT4gvgV79Gv7QtaXwu5YC9Utr35...
 )
 ```

data/docs/EnvironmentRedirectUrisAddRequest.md

@@ -0,0 +1,18 @@
+# TrinsicApi::EnvironmentRedirectUrisAddRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **uri** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::EnvironmentRedirectUrisAddRequest.new(
+  uri: null
+)
+```
+

data/docs/EnvironmentRedirectUrisApi.md

@@ -0,0 +1,222 @@
+# TrinsicApi::EnvironmentRedirectUrisApi
+
+All URIs are relative to *https://api.trinsic.id*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**add**](EnvironmentRedirectUrisApi.md#add) | **POST** /api/valpha/environments/redirect-uris | Add Redirect URI |
+| [**delete**](EnvironmentRedirectUrisApi.md#delete) | **DELETE** /api/valpha/environments/redirect-uris/{id} | Delete Redirect URI |
+| [**list**](EnvironmentRedirectUrisApi.md#list) | **GET** /api/valpha/environments/redirect-uris | List Redirect URIs |
+
+
+## add
+
+> <AddRedirectUriResponse> add(opts)
+
+Add Redirect URI
+
+Add a new redirect uri to the environment.
+
+### 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::EnvironmentRedirectUrisApi.new
+opts = {
+  environment_redirect_uris_add_request: TrinsicApi::EnvironmentRedirectUrisAddRequest.new({uri: 'uri_example'}) # EnvironmentRedirectUrisAddRequest | Request for uri to add to the environment. Must be absolute, not relative. Wildcard \"*\" accepted.
+}
+
+begin
+  # Add Redirect URI
+  result = api_instance.add(opts)
+  p result
+rescue TrinsicApi::ApiError => e
+  puts "Error when calling EnvironmentRedirectUrisApi->add: #{e}"
+end
+```
+
+#### Using the add_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AddRedirectUriResponse>, Integer, Hash)> add_with_http_info(opts)
+
+```ruby
+begin
+  # Add Redirect URI
+  data, status_code, headers = api_instance.add_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AddRedirectUriResponse>
+rescue TrinsicApi::ApiError => e
+  puts "Error when calling EnvironmentRedirectUrisApi->add_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **environment_redirect_uris_add_request** | [**EnvironmentRedirectUrisAddRequest**](EnvironmentRedirectUrisAddRequest.md) | Request for uri to add to the environment. Must be absolute, not relative. Wildcard \&quot;*\&quot; accepted. | [optional] |
+
+### Return type
+
+[**AddRedirectUriResponse**](AddRedirectUriResponse.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
+
+
+## delete
+
+> delete(id)
+
+Delete Redirect URI
+
+Delete a redirect uri from the environment.
+
+### 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::EnvironmentRedirectUrisApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The id of the redirect uri to delete.
+
+begin
+  # Delete Redirect URI
+  api_instance.delete(id)
+rescue TrinsicApi::ApiError => e
+  puts "Error when calling EnvironmentRedirectUrisApi->delete: #{e}"
+end
+```
+
+#### Using the delete_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> delete_with_http_info(id)
+
+```ruby
+begin
+  # Delete Redirect URI
+  data, status_code, headers = api_instance.delete_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue TrinsicApi::ApiError => e
+  puts "Error when calling EnvironmentRedirectUrisApi->delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The id of the redirect uri to delete. |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/problem+json
+
+
+## list
+
+> <ListEnvironmentRedirectUrisResponse> list(opts)
+
+List Redirect URIs
+
+List redirect URIs within the environment.
+
+### 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::EnvironmentRedirectUrisApi.new
+opts = {
+  page: 56, # Integer | Number of pages of uris to return.
+  page_size: 56 # Integer | Size of the list to be returned. Accepted range from 1 to 100
+}
+
+begin
+  # List Redirect URIs
+  result = api_instance.list(opts)
+  p result
+rescue TrinsicApi::ApiError => e
+  puts "Error when calling EnvironmentRedirectUrisApi->list: #{e}"
+end
+```
+
+#### Using the list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListEnvironmentRedirectUrisResponse>, Integer, Hash)> list_with_http_info(opts)
+
+```ruby
+begin
+  # List Redirect URIs
+  data, status_code, headers = api_instance.list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListEnvironmentRedirectUrisResponse>
+rescue TrinsicApi::ApiError => e
+  puts "Error when calling EnvironmentRedirectUrisApi->list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | **Integer** | Number of pages of uris to return. | [optional][default to 1] |
+| **page_size** | **Integer** | Size of the list to be returned. Accepted range from 1 to 100 | [optional][default to 20] |
+
+### Return type
+
+[**ListEnvironmentRedirectUrisResponse**](ListEnvironmentRedirectUrisResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/plain, application/json, text/json, application/problem+json
+

data/docs/FaydaProviderOutput.md

@@ -0,0 +1,18 @@
+# TrinsicApi::FaydaProviderOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **sub** | **String** | A unique eKYC identifying token used to match the original eKYC token received from the provider when the user was initially registered.              Since Fayda does not return identifying data, it is the responsibility of the relying party to keep the unique user token received from Fayda when the user was initially registered to do a comparison of the subs to verify that it is the same person. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::FaydaProviderOutput.new(
+  sub: null
+)
+```
+

data/docs/Identifier.md

@@ -0,0 +1,22 @@
+# TrinsicApi::Identifier
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **identifier** | **String** |  |  |
+| **scope** | **String** |  |  |
+| **description** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::Identifier.new(
+  identifier: null,
+  scope: null,
+  description: null
+)
+```
+

data/docs/IdentityData.md

@@ -10,6 +10,8 @@
 | **document** | [**DocumentData**](DocumentData.md) |  | [optional] |
 | **match** | [**MatchData**](MatchData.md) |  | [optional] |
 | **attachment_access_keys** | [**AttachmentAccessKeys**](AttachmentAccessKeys.md) |  | [optional] |
+| **provider_output** | [**ProviderOutput**](ProviderOutput.md) |  | [optional] |
+| **identifiers** | [**Array<Identifier>**](Identifier.md) |  |  |
 
 ## Example
 
@@ -22,7 +24,9 @@ instance = TrinsicApi::IdentityData.new(
   person: null,
   document: null,
   match: null,
-  attachment_access_keys: null
+  attachment_access_keys: null,
+  provider_output: null,
+  identifiers: null
 )
 ```
 

data/docs/IntegrationStep.md

@@ -15,7 +15,7 @@ require 'trinsic_api'
 
 instance = TrinsicApi::IntegrationStep.new(
   method: null,
-  content: https://api.trinsic.id/api/session/launch?clientToken=...,
+  content: https://verify.trinsic.id/api/session/launch?clientToken=...,
   refresh: null
 )
 ```

data/docs/KenyaNidBiometric2Input.md

@@ -0,0 +1,22 @@
+# TrinsicApi::KenyaNidBiometric2Input
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id_number** | **String** | The user's Kenyan National ID number | [optional] |
+| **liveness_images** | **Array<String>** | An array of exactly 8 images required for biometric liveness verification. The first 7 images should be liveness frames captured during the liveness detection process, and the last image (8th) should be a selfie of the user. All images must be in JPEG format and each image must be less than 15MB in size. | [optional] |
+| **test_selfie** | **String** | Test selfie for test environment (optional, maximum 15MB). Must be JPEG format. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::KenyaNidBiometric2Input.new(
+  id_number: null,
+  liveness_images: null,
+  test_selfie: null
+)
+```
+

data/docs/KenyaNidInput.md

@@ -9,7 +9,7 @@
 | **last_name** | **String** | The user's middle name as it appears in their National ID (optional) |  |
 | **date_of_birth** | **Date** | The user's date of birth, in `YYYY-MM-DD` format |  |
 | **gender** | **String** | The user's gender as it appears in their National ID (e.g., male, female) |  |
-| **national_id_number** | **String** | The user's South Kenya National ID number |  |
+| **national_id_number** | **String** | The user's Kenya National ID number |  |
 
 ## Example
 

data/docs/KenyaNidLookup2Input.md

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

data/docs/KenyaNidMatch2Input.md

@@ -0,0 +1,28 @@
+# TrinsicApi::KenyaNidMatch2Input
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id_number** | **String** | The user's Kenyan National ID number | [optional] |
+| **given_name** | **String** | The user's first name as it appears in their National ID | [optional] |
+| **family_name** | **String** | The user's last name as it appears in their National ID | [optional] |
+| **middle_name** | **String** | The user's middle name as it appears in their National ID (optional) | [optional] |
+| **date_of_birth** | **Date** | The user's date of birth, in `YYYY-MM-DD` format | [optional] |
+| **sex** | [**SexV1**](SexV1.md) | The user's sex as it appears in their National ID | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::KenyaNidMatch2Input.new(
+  id_number: null,
+  given_name: null,
+  family_name: null,
+  middle_name: null,
+  date_of_birth: null,
+  sex: null
+)
+```
+

data/docs/ListEnvironmentRedirectUrisResponse.md

@@ -0,0 +1,20 @@
+# TrinsicApi::ListEnvironmentRedirectUrisResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **uris** | [**Array<RedirectUriResponse>**](RedirectUriResponse.md) | List of redirect uris within the environment. |  |
+| **more** | **Boolean** | Whether there are additional pages of uris to retrieve |  |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::ListEnvironmentRedirectUrisResponse.new(
+  uris: null,
+  more: true
+)
+```
+

data/docs/ListVerificationProfilesResponse.md

@@ -0,0 +1,20 @@
+# TrinsicApi::ListVerificationProfilesResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **verification_profiles** | [**Array<VerificationProfileResponse>**](VerificationProfileResponse.md) |  |  |
+| **more** | **Boolean** | Whether there are additional pages of verification profiles to retrieve |  |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::ListVerificationProfilesResponse.new(
+  verification_profiles: null,
+  more: true
+)
+```
+

data/docs/MexicoCurpProviderOutput.md

@@ -0,0 +1,18 @@
+# TrinsicApi::MexicoCurpProviderOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **curp_status** | **String** | Curp status for the subject.              Possible values: - AN: Alta Normal (Normal registration) - Active - AH: Alta con Homonimia (Registration with homonymy) - Active - RCC: Registro de cambio afectando a CURP (Change affecting CURP) - Active - RCN: Registro de cambio no afectando a CURP (Change not affecting CURP) - Active - BAP: Baja por documento apócrifo (Low due to apocryphal document) - Inactive - BSU: Baja sin uso (Low curp without use) - Inactive - BD: Baja por defunción (Low curp due to death) - Inactive - BDM: Baja administrativa (Low, due to administrative process) - Inactive - BDP: Baja por adopción (Low, due to adoption) - Inactive - BJD: Baja Judicial (Low for judicial reasons) - Inactive | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::MexicoCurpProviderOutput.new(
+  curp_status: null
+)
+```
+

data/docs/NigeriaNinInput.md

@@ -10,7 +10,7 @@
 | **phone_number** | **String** | The user's phone number (optional) | [optional] |
 | **date_of_birth** | **Date** | The user's date of birth, in `YYYY-MM-DD` format |  |
 | **gender** | **String** | The user's gender as it appears in their National ID (e.g., male, female) | [optional] |
-| **national_id_number** | **String** | The user's South African National ID number |  |
+| **national_id_number** | **String** | The user's National ID number |  |
 
 ## Example
 

data/docs/PhilippinesDigitalNidProviderOutput.md

@@ -0,0 +1,18 @@
+# TrinsicApi::PhilippinesDigitalNidProviderOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **philsys_card_number** | **String** | The PhilSys card number. |  |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::PhilippinesDigitalNidProviderOutput.new(
+  philsys_card_number: null
+)
+```
+

data/docs/PhilippinesPhysicalNidProviderOutput.md

@@ -0,0 +1,18 @@
+# TrinsicApi::PhilippinesPhysicalNidProviderOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **philsys_card_number** | **String** | The PhilSys card number. |  |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::PhilippinesPhysicalNidProviderOutput.new(
+  philsys_card_number: null
+)
+```
+

data/docs/ProviderContract.md

@@ -21,6 +21,7 @@
 | **supports_advanced_provider_sessions** | **Boolean** | Whether this Provider can be fully whitelabeled/OEMed through the Direct Provider Sessions API.              If `false`, the Provider may still be launched through Direct Provider Sessions; however, it will necessarily require a Trinsic-hosted UI to function. |  |
 | **supports_direct_provider_sessions** | **Boolean** | Whether this Provider can be fully whitelabeled/OEMed through the Direct Provider Sessions API.              If `false`, the Provider may still be launched through Direct Provider Sessions; however, it will necessarily require a Trinsic-hosted UI to function. |  |
 | **available_fields** | [**Array<ContractField>**](ContractField.md) | Information about the fields that this Provider will return in verification results. | [optional] |
+| **available_identifiers** | [**Array<ContractIdentifierField>**](ContractIdentifierField.md) | Information about the identifiers this Provider returns in verification results. | [optional] |
 | **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] |
 | **health** | [**ProviderHealth**](ProviderHealth.md) | The health for an integration to be able to successfully perform a verification session. |  |
 
@@ -47,6 +48,7 @@ instance = TrinsicApi::ProviderContract.new(
   supports_advanced_provider_sessions: true,
   supports_direct_provider_sessions: true,
   available_fields: null,
+  available_identifiers: null,
   sub_providers: null,
   health: null
 )