trinsic_api 2.2.0 → 2.3.0.pre.alpha2

data/docs/ProviderInput.md

@@ -4,11 +4,15 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **kenya_biometric2** | [**KenyaNidBiometric2Input**](KenyaNidBiometric2Input.md) | Input for the `kenya-nid-match-biometric-2` provider | [optional] |
 | **indonesia_nik** | [**IndonesiaNikInput**](IndonesiaNikInput.md) | Input for the `indonesia-nik-lookup` provider | [optional] |
 | **indonesia_dukcapil_match** | [**IndonesiaDukcapilMatchInput**](IndonesiaDukcapilMatchInput.md) | Input for the `indonesia-dukcapil-match` provider | [optional] |
 | **mexico_curp** | [**MexicoCurpInput**](MexicoCurpInput.md) | Input for the `mexico-curp-lookup` provider | [optional] |
 | **south_africa_nid** | [**SouthAfricaNidInput**](SouthAfricaNidInput.md) | Input for the `south-africa-nid-lookup` provider | [optional] |
 | **kenya_nid** | [**KenyaNidInput**](KenyaNidInput.md) | Input for the `kenya-nid-lookup` provider | [optional] |
+| **kenya_nid_match2** | [**KenyaNidMatch2Input**](KenyaNidMatch2Input.md) | Input for the `kenya-nid-match-2` provider | [optional] |
+| **kenya_nid_lookup2** | [**KenyaNidLookup2Input**](KenyaNidLookup2Input.md) | Input for the `kenya-nid-lookup-2` provider | [optional] |
+| **south_africa_nid_lookup2** | [**SouthAfricaNidLookup2Input**](SouthAfricaNidLookup2Input.md) | Input for the `south-africa-nid-lookup-2` provider | [optional] |
 | **nigeria_nin** | [**NigeriaNinInput**](NigeriaNinInput.md) | Input for the `nigeria-nin-lookup` provider | [optional] |
 | **aadhaar** | [**AadhaarInput**](AadhaarInput.md) | Input for the `india-digilocker-aadhaar-match` provider | [optional] |
 | **bangladesh_national_id** | [**BangladeshNidInput**](BangladeshNidInput.md) | Input for the `bangladesh-nid` provider | [optional] |
@@ -31,11 +35,15 @@
 require 'trinsic_api'
 
 instance = TrinsicApi::ProviderInput.new(
+  kenya_biometric2: null,
   indonesia_nik: null,
   indonesia_dukcapil_match: null,
   mexico_curp: null,
   south_africa_nid: null,
   kenya_nid: null,
+  kenya_nid_match2: null,
+  kenya_nid_lookup2: null,
+  south_africa_nid_lookup2: null,
   nigeria_nin: null,
   aadhaar: null,
   bangladesh_national_id: null,

data/docs/ProviderOutput.md

@@ -0,0 +1,26 @@
+# TrinsicApi::ProviderOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **italy_spid** | [**SpidProviderOutput**](SpidProviderOutput.md) |  | [optional] |
+| **mexico_curp_lookup** | [**MexicoCurpProviderOutput**](MexicoCurpProviderOutput.md) |  | [optional] |
+| **ethiopia_fayda** | [**FaydaProviderOutput**](FaydaProviderOutput.md) |  | [optional] |
+| **philippines_physical_national_id_qr** | [**PhilippinesPhysicalNidProviderOutput**](PhilippinesPhysicalNidProviderOutput.md) |  | [optional] |
+| **philippines_digital_national_id_qr** | [**PhilippinesDigitalNidProviderOutput**](PhilippinesDigitalNidProviderOutput.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::ProviderOutput.new(
+  italy_spid: null,
+  mexico_curp_lookup: null,
+  ethiopia_fayda: null,
+  philippines_physical_national_id_qr: null,
+  philippines_digital_national_id_qr: null
+)
+```
+

data/docs/RedirectUriResponse.md

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

data/docs/SexV1.md

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

data/docs/SouthAfricaNidInput.md

@@ -7,7 +7,7 @@
 | **full_name** | **String** | The user's full name as it appears in their National ID |  |
 | **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 African National ID number |  |
+| **national_id_number** | **String** | The user's National ID number |  |
 
 ## Example
 

data/docs/SouthAfricaNidLookup2Input.md

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

data/docs/SpidBillingInformation.md

@@ -0,0 +1,22 @@
+# TrinsicApi::SpidBillingInformation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **is_billable** | **Boolean** | Whether this SPID verification has resulted in a billable event. |  |
+| **verification_type** | **String** | The billable verification type for this SPID verification.              Possible values: \"Authentication\" | \"Registration\" |  |
+| **verification_level** | **Integer** | The billable verification level for this SPID verification.              Possible values: 1 | 2 | 3 |  |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::SpidBillingInformation.new(
+  is_billable: true,
+  verification_type: "Authentication",
+  verification_level: 1
+)
+```
+

data/docs/SpidInput.md

@@ -5,6 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **sub_provider_id** | **String** | The ID of the specific IDP to invoke within SPID.              If not specified, the user will be prompted to select an IDP. | [optional] |
+| **billing_tracking_secret** | **String** | Only applicable if period-based billing is enabled for your Verification Profile. Contact Trinsic to enable this.              A secret UTF-8 string between 32 and 64 characters in length, used to enable privacy-preserving tracking of unique user verifications during a billing period.              WARNING: This value must NOT change during the course of a billing period for a given Verification Profile, or double-billing may occur. If multiple Verification Profiles are configured to use the same Trinsic-managed SPID Service Provider, the same Billing Tracking Secret must be provided across all such Verification Profiles. | [optional] |
 
 ## Example
 
@@ -12,7 +13,8 @@
 require 'trinsic_api'
 
 instance = TrinsicApi::SpidInput.new(
-  sub_provider_id: null
+  sub_provider_id: null,
+  billing_tracking_secret: null
 )
 ```
 

data/docs/SpidProviderOutput.md

@@ -0,0 +1,44 @@
+# TrinsicApi::SpidProviderOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **billing_information** | [**SpidBillingInformation**](SpidBillingInformation.md) | Information about the billable status of this SPID Verification.              Present only if your account has period-based billing enabled for SPID. Contact Trinsic to enable this. | [optional] |
+| **identity_provider_entity_id** | **String** | The SPID Entity ID of the Identity Provider which issued the SPID identity.              This is an HTTPS URI which uniquely identifies the IdP within the SPID federation.              A normalized / simplified representation of this value is present in the `originatingSubProviderId` field in Trinsic's normalized data model. |  |
+| **spid_code** | **String** | The identifier of the user's SPID credential.              This uniquely identifies the credential within the SPID federation. |  |
+| **spid_credential_expiration_date** | **Date** | Expiration date of the user's SPID credential.              This is not the same as the expiration date of the underlying identity document (such as a passport) which was used to create the SPID identity. | [optional] |
+| **place_of_birth** | **String** | The user's place of birth. | [optional] |
+| **county_of_birth** | **String** | The user's county of birth. | [optional] |
+| **raw_id_card** | **String** | The raw, space-separated string value for the \"IdCard\" field from the SPID identity.              Trinsic additionally parses this field and uses it to populate the `Document` object in the normalized data model. | [optional] |
+| **email** | **String** | The email address of the user. | [optional] |
+| **digital_address** | **String** | The digital address of the user. | [optional] |
+| **fiscal_number** | **String** | Fiscal tax number for the subject. | [optional] |
+| **iva_code** | **String** | VAT number for the subject. | [optional] |
+| **company_name** | **String** | The name of the company which the user is associated with. | [optional] |
+| **company_fiscal_number** | **String** | The fiscal tax number of the company which the user is associated with. | [optional] |
+| **registered_office** | **String** | The registered office address of the company which the user is associated with. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::SpidProviderOutput.new(
+  billing_information: null,
+  identity_provider_entity_id: null,
+  spid_code: null,
+  spid_credential_expiration_date: null,
+  place_of_birth: null,
+  county_of_birth: null,
+  raw_id_card: null,
+  email: null,
+  digital_address: null,
+  fiscal_number: null,
+  iva_code: null,
+  company_name: null,
+  company_fiscal_number: null,
+  registered_office: null
+)
+```
+

data/docs/VerificationProfileResponse.md

@@ -0,0 +1,28 @@
+# TrinsicApi::VerificationProfileResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The ID of the verification profile |  |
+| **_alias** | **String** | An alias of the verification profile shown to developers and administrators. |  |
+| **brand_name** | **String** | The brand name of the verification profile shown to end-users. |  |
+| **logo_url** | **String** | The URL of the verification profile's logo. |  |
+| **primary_color** | **String** | The primary color of the verification profile. |  |
+| **enabled_providers** | **Array<String>** | The providers that are currently enabled for the verification profile. |  |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::VerificationProfileResponse.new(
+  id: null,
+  _alias: null,
+  brand_name: null,
+  logo_url: null,
+  primary_color: null,
+  enabled_providers: null
+)
+```
+

data/docs/VerificationProfilesApi.md

@@ -0,0 +1,231 @@
+# TrinsicApi::VerificationProfilesApi
+
+All URIs are relative to *https://api.trinsic.id*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_verification_profile**](VerificationProfilesApi.md#create_verification_profile) | **POST** /api/valpha/verification-profiles | Create Verification Profile |
+| [**get_verification_profile_by_id**](VerificationProfilesApi.md#get_verification_profile_by_id) | **GET** /api/valpha/verification-profiles/{id} | Get Verification Profile |
+| [**list_verification_profiles**](VerificationProfilesApi.md#list_verification_profiles) | **GET** /api/valpha/verification-profiles | List Verification Profiles |
+
+
+## create_verification_profile
+
+> <CreateVerificationProfileResponse> create_verification_profile(_alias, brand_name, opts)
+
+Create Verification Profile
+
+Creates a new verification profile within your organization.
+
+### 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::VerificationProfilesApi.new
+_alias = '_alias_example' # String | An alias of the verification profile shown to developers and administrators.
+brand_name = 'brand_name_example' # String | The brand name of the verification profile shown to end-users.
+opts = {
+  primary_color: 'primary_color_example', # String | The primary color of the verification profile. Must be a 6-character hex string prefixed with a '#' character. Example: #000000
+  providers: ['inner_example'], # Array<String> | The list of providers you'd like to select for this profile. We will not currently enable any providers.
+  logo: File.new('/path/to/some/file') # File | The logo of the verification profile.
+}
+
+begin
+  # Create Verification Profile
+  result = api_instance.create_verification_profile(_alias, brand_name, opts)
+  p result
+rescue TrinsicApi::ApiError => e
+  puts "Error when calling VerificationProfilesApi->create_verification_profile: #{e}"
+end
+```
+
+#### Using the create_verification_profile_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateVerificationProfileResponse>, Integer, Hash)> create_verification_profile_with_http_info(_alias, brand_name, opts)
+
+```ruby
+begin
+  # Create Verification Profile
+  data, status_code, headers = api_instance.create_verification_profile_with_http_info(_alias, brand_name, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateVerificationProfileResponse>
+rescue TrinsicApi::ApiError => e
+  puts "Error when calling VerificationProfilesApi->create_verification_profile_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_alias** | **String** | An alias of the verification profile shown to developers and administrators. |  |
+| **brand_name** | **String** | The brand name of the verification profile shown to end-users. |  |
+| **primary_color** | **String** | The primary color of the verification profile. Must be a 6-character hex string prefixed with a &#39;#&#39; character. Example: #000000 | [optional] |
+| **providers** | [**Array&lt;String&gt;**](String.md) | The list of providers you&#39;d like to select for this profile. We will not currently enable any providers. | [optional] |
+| **logo** | **File** | The logo of the verification profile. | [optional] |
+
+### Return type
+
+[**CreateVerificationProfileResponse**](CreateVerificationProfileResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: multipart/form-data
+- **Accept**: text/plain, application/json, text/json, application/problem+json
+
+
+## get_verification_profile_by_id
+
+> <VerificationProfileResponse> get_verification_profile_by_id(id)
+
+Get Verification Profile
+
+Gets a specific verification profile by ID.
+
+### 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::VerificationProfilesApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+
+begin
+  # Get Verification Profile
+  result = api_instance.get_verification_profile_by_id(id)
+  p result
+rescue TrinsicApi::ApiError => e
+  puts "Error when calling VerificationProfilesApi->get_verification_profile_by_id: #{e}"
+end
+```
+
+#### Using the get_verification_profile_by_id_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<VerificationProfileResponse>, Integer, Hash)> get_verification_profile_by_id_with_http_info(id)
+
+```ruby
+begin
+  # Get Verification Profile
+  data, status_code, headers = api_instance.get_verification_profile_by_id_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <VerificationProfileResponse>
+rescue TrinsicApi::ApiError => e
+  puts "Error when calling VerificationProfilesApi->get_verification_profile_by_id_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**VerificationProfileResponse**](VerificationProfileResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/plain, application/json, text/json, application/problem+json
+
+
+## list_verification_profiles
+
+> <ListVerificationProfilesResponse> list_verification_profiles(opts)
+
+List Verification Profiles
+
+List the verification profiles for the current organization and 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::VerificationProfilesApi.new
+opts = {
+  page: 56, # Integer | 
+  page_size: 56 # Integer | Size of the list to be returned. Accepted range from 1 to 100
+}
+
+begin
+  # List Verification Profiles
+  result = api_instance.list_verification_profiles(opts)
+  p result
+rescue TrinsicApi::ApiError => e
+  puts "Error when calling VerificationProfilesApi->list_verification_profiles: #{e}"
+end
+```
+
+#### Using the list_verification_profiles_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListVerificationProfilesResponse>, Integer, Hash)> list_verification_profiles_with_http_info(opts)
+
+```ruby
+begin
+  # List Verification Profiles
+  data, status_code, headers = api_instance.list_verification_profiles_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListVerificationProfilesResponse>
+rescue TrinsicApi::ApiError => e
+  puts "Error when calling VerificationProfilesApi->list_verification_profiles_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | **Integer** |  | [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
+
+[**ListVerificationProfilesResponse**](ListVerificationProfilesResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/plain, application/json, text/json, application/problem+json
+