trinsic_api 3.0.1 → 3.1.0.pre.preview1

data/docs/DigilockerAadhaarProviderOutput.md

@@ -0,0 +1,30 @@
+# TrinsicApi::DigilockerAadhaarProviderOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **document_type** | **String** | The document type from which the identity data was retrieved. | [optional] |
+| **timestamp** | **Time** | The timestamp when the signed document was generated and verified. | [optional] |
+| **time_to_live** | **Time** | The validity expiration timestamp for the verification document. | [optional] |
+| **aadhaar_number_last_four** | **String** | The Aadhaar number (UID) value for the individual.              This is only the last four digits of the Aadhaar number. | [optional] |
+| **claims** | [**AadhaarClaims**](AadhaarClaims.md) | The claims extracted from the Aadhaar document. | [optional] |
+| **localized_claims** | [**AadhaarLocalizedClaims**](AadhaarLocalizedClaims.md) | The localized claims extracted from the Aadhaar document. | [optional] |
+| **document_signature_validated** | **Boolean** | Whether our own validation of the Aadhaar document signature and certificate chain succeeded.              When the signed document (e.g. Digilocker XML) is available, we validate it using the standard CCA/SafeScrypt chain. When the document is not returned, the signature cannot be validated and this is false. Some providers (e.g. Signzy) also supply a separate DSC validation indicator in the webhook payload; that is independent of this flag, which reflects only our validation. |  |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::DigilockerAadhaarProviderOutput.new(
+  document_type: ADHAR,
+  timestamp: 2025-06-01T20:43:54.472+05:30,
+  time_to_live: null,
+  aadhaar_number_last_four: 1234,
+  claims: null,
+  localized_claims: null,
+  document_signature_validated: true
+)
+```
+

data/docs/ElSalvadorDuiLookupInput.md

@@ -0,0 +1,20 @@
+# TrinsicApi::ElSalvadorDuiLookupInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **document_number** | **String** | The DUI (Documento Único de Identidad) number for the holder.              Nine numeric digits after sanitization. Commonly printed as ########-# (hyphen before the final digit). The input will automatically be sanitized of dots, hyphens, spaces, or other non-alphanumeric characters before lookup.              The ninth digit is a check digit. This is not publicly documented by the Salvadoran government, but the algorithm is available in the public domain for those who seek it. | [optional] |
+| **date_of_birth** | **Date** | The DUI holder's date of birth. Required to match the correct person in official records. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::ElSalvadorDuiLookupInput.new(
+  document_number: 123456789,
+  date_of_birth: Fri Dec 01 00:00:00 UTC 1995
+)
+```
+

data/docs/ElSalvadorDuiProviderOutput.md

@@ -0,0 +1,22 @@
+# TrinsicApi::ElSalvadorDuiProviderOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **full_name** | **String** | Full name as it appears on the DUI (Documento Único de Identidad), as returned by Verifik from official records administered by the Registro Nacional de las Personas Naturales (RNPN). |  |
+| **document_number** | **String** | The DUI (Documento Único de Identidad) document number as returned by Verifik for the matched record.              Nine numeric digits after sanitization. Commonly printed as ########-# (hyphen before the final digit). The output will be stripped of the hyphen and will preserve leading zeros.              The ninth digit is a check digit. This is not publicly documented by the Salvadoran government, but the algorithm is available in the public domain for those who seek it. |  |
+| **date_of_birth** | **Date** | The date of birth that was supplied for the lookup and confirmed as matching the DUI record. |  |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::ElSalvadorDuiProviderOutput.new(
+  full_name: Juan Pérez,
+  document_number: 123456789,
+  date_of_birth: Fri Dec 01 00:00:00 UTC 1995
+)
+```
+

data/docs/FaydaProviderAddress.md

@@ -0,0 +1,22 @@
+# TrinsicApi::FaydaProviderAddress
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **region** | **String** | The region, which is the primary administrative division of the address.              This attribute is only available if registered directly. | [optional] |
+| **zone** | **String** | The zone, which is the administrative area within the region.              This attribute is only available if registered directly. | [optional] |
+| **woreda** | **String** | The woreda, which is the local district within the zone.              This attribute is only available if registered directly. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::FaydaProviderAddress.new(
+  region: Addis Ababa,
+  zone: Bole,
+  woreda: 03
+)
+```
+

data/docs/FaydaProviderOutput.md

@@ -4,7 +4,16 @@
 
 | 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] |
+| **sub** | **String** | A unique eKYC identifying token used to match the original eKYC token received from the provider when the individual was initially registered.              Since Fayda does not return identifying data, it is the responsibility of the relying party to keep the unique individual token received from Fayda when the individual was initially registered to do a comparison of the subs to verify that it is the same person. | [optional] |
+| **name** | **String** | The full name of the verified individual.              This may be an English or Arabic name if the individual only has it one language, otherwise this will be null and the other names will be populated. | [optional] |
+| **english_name** | **String** | The full English name of the verified individual. | [optional] |
+| **arabic_name** | **String** | The full Arabic name of the verified individual. | [optional] |
+| **birthdate** | **Date** | The date of birth of the verified individual.              This attribute is only available if registered directly. | [optional] |
+| **gender** | **String** | The sex of the verified individual.              Possible values: - Unknown - NotApplicable - Male - Female              This attribute is only available if registered directly. | [optional] |
+| **nationality** | **String** | The nationality of the verified individual as an ISO 3166-1 alpha-2 country code.              This attribute is only available if registered directly. | [optional] |
+| **phone_number** | **String** | The phone number of the verified individual.              This attribute is only available if registered directly. | [optional] |
+| **email** | **String** | The email address of the verified individual.              This attribute is only available if registered directly. | [optional] |
+| **address** | [**FaydaProviderAddress**](FaydaProviderAddress.md) | The address of the verified individual.              This attribute is only available if registered directly. | [optional] |
 
 ## Example
 
@@ -12,7 +21,16 @@
 require 'trinsic_api'
 
 instance = TrinsicApi::FaydaProviderOutput.new(
-  sub: F50278D6-7C38-4284-83CD-549BBC818F5C
+  sub: F50278D6-7C38-4284-83CD-549BBC818F5C,
+  name: Yohannes Tesfaye,
+  english_name: Yohannes Tesfaye,
+  arabic_name: يوهانس تيسفاي,
+  birthdate: Thu Jan 31 00:00:00 UTC 1985,
+  gender: Male,
+  nationality: ET,
+  phone_number: +251911234567,
+  email: yohannes@example.com,
+  address: null
 )
 ```
 

data/docs/FinnishTrustNetworkProviderOutput.md

@@ -0,0 +1,38 @@
+# TrinsicApi::FinnishTrustNetworkProviderOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **full_name** | **String** | The full name of the individual. | [optional] |
+| **date_of_birth** | **Date** | The date of birth of the individual. | [optional] |
+| **personal_identification_code** | **String** | The 11-digit Finnish Personal Identification Code (Henkilötunnus) of the verified individual.              This is in the format DDMMYYCZZZQ, where: - DDMMYY is the date of birth - C is a symbol which determines the century of birth - ZZZ is an individual number, indicating gender - Q is a checksum character              If ZZZ is even, the individual is female. If ZZZ is odd, the individual is male.              If C is '+', the individual was born in the 19th century (1800-1899). If C is '-', 'U', 'V', 'W', 'X', or 'Y', the individual was born in the 20th century (1900-1999). If C is 'A', 'B', 'C', 'D', 'E', or 'F', the individual was born in the 21st century (2000-2099). | [optional] |
+| **unique_identification_number** | **String** | The 9-digit Finnish Unique Identification Number (FINUID, or sähköinen asiointitunnus SATU) of the verified individual. This number is typically used for online transactions and unlike the Finnish Personal Identification Code, does not reveal personal information such as birthdate.              The first 8 digits are randomly generated and the last character is a check control. | [optional] |
+| **given_name** | **String** | The given name of the individual. | [optional] |
+| **family_name** | **String** | The family name of the individual. | [optional] |
+| **level_of_assurance** | **String** | The level of assurance (LOA) for the verification.              The LOA refers to the degree of confidence in the claimed identity of a person. The European Digital Identity Framework (EUDI) measures the confidence of the digital identity's verification and authentication strength by a set of requirements for different levels. To learn more, see: https://ec.europa.eu/digital-building-blocks/sites/spaces/DIGITAL/pages/467110081/eIDAS+Levels+of+Assurance              Possible values: - Low: The individual has self asserted their identity and multifactor authentication is not required. - Substantial: The individual has performed either a remote or in-person identity verification and multifactor authentication is required. - High: The individual has performed an in-person identity proofing with an authorized representative and has strong cryptographic authentication requirements such as using a smart card. | [optional] |
+| **bank** | **String** | The bank used to perform the identification for the verified individual. | [optional] |
+| **phone_number** | **String** | The phone number of the verified individual.              This is only returned if the individual authenticated with MobileID (Mobiilivarmenne). | [optional] |
+| **organization_name** | **String** | The organization name that the individual is associated with.              This is returned for requests that contain the organization scope. | [optional] |
+| **vat_number** | **String** | The VAT number of the organization that the individual is associated with.              This is returned for requests that contain the organization scope. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::FinnishTrustNetworkProviderOutput.new(
+  full_name: Ove Henriksen,
+  date_of_birth: Sun Aug 15 00:00:00 UTC 1943,
+  personal_identification_code: 300690-543X,
+  unique_identification_number: 30069054X,
+  given_name: Ove,
+  family_name: Henriksen,
+  level_of_assurance: High,
+  bank: opbank,
+  phone_number: +358401234567,
+  organization_name: Acme Company,
+  vat_number: FI07654321
+)
+```
+

data/docs/FranceIdentiteInput.md

@@ -0,0 +1,18 @@
+# TrinsicApi::FranceIdentiteInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **preview_raw18013_request** | [**Raw18013RequestInput**](Raw18013RequestInput.md) | The raw 18013-7 exchange request to use for this verification.              If set, this overrides any default configuration on your Verification Profile. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::FranceIdentiteInput.new(
+  preview_raw18013_request: null
+)
+```
+

data/docs/FranceIdentiteProviderOutput.md

@@ -0,0 +1,18 @@
+# TrinsicApi::FranceIdentiteProviderOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **raw18013_output** | [**MdlOutput**](MdlOutput.md) | The raw output of the 18013-7 exchange performed through France Identité. |  |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::FranceIdentiteProviderOutput.new(
+  raw18013_output: null
+)
+```
+

data/docs/FrejaIndirectProviderOutput.md

@@ -0,0 +1,24 @@
+# TrinsicApi::FrejaIndirectProviderOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **first_name** | **String** | The first name of the verified individual |  |
+| **last_name** | **String** | The last name of the verified individual |  |
+| **personal_number** | **String** | The value returned by Freja in the \"ssn\" field.              The actual value of this field depends on the country of origin used to create the Freja credential. It is typically a Social Security Number, National Identification Number, or equivalent personal identifier. |  |
+| **personal_number_country** | **String** | The 2-digit ISO country code of the country which issued the personal number. |  |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::FrejaIndirectProviderOutput.new(
+  first_name: John,
+  last_name: Doe,
+  personal_number: 200003276624,
+  personal_number_country: SE
+)
+```
+

data/docs/FrejaProviderOutput.md

@@ -4,10 +4,24 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **first_name** | **String** | The first name of the verified individual |  |
-| **last_name** | **String** | The last name of the verified individual |  |
-| **personal_number** | **String** | The value returned by Freja in the \"ssn\" field.              The actual value of this field depends on the country of origin used to create the Freja credential. It is typically a Social Security Number, National Identification Number, or equivalent personal identifier. |  |
-| **personal_number_country** | **String** | The 2-digit ISO country code of the country which issued the personal number. |  |
+| **name** | **String** | The individual's full name. | [optional] |
+| **given_name** | **String** | The individual's first name. | [optional] |
+| **family_name** | **String** | The individual's last name. | [optional] |
+| **date_of_birth** | **Date** | The date of birth of the individual.              Formatted as an ISO 8601 Date. | [optional] |
+| **email** | **String** | The individual's primary email address within Freja. | [optional] |
+| **email_verified** | **Boolean** | A boolean which indicates whether the individual's primary email address has been verified by Freja. | [optional] |
+| **all_email_addresses** | **Array<String>** | An array of all associated email addresses of the individual. | [optional] |
+| **primary_physical_address** | [**OutputFrejaAddress**](OutputFrejaAddress.md) | The individual's primary address on file. | [optional] |
+| **all_physical_addresses** | [**Array<OutputFrejaAddress>**](OutputFrejaAddress.md) | A list of all associated addresses of the individual. | [optional] |
+| **age** | **Integer** | The individual's age in years. | [optional] |
+| **phone_number** | **String** | The individual's phone number in the E.164 format. | [optional] |
+| **phone_number_verified** | **Boolean** | Whether the individual's phone number has been verified by Freja. | [optional] |
+| **personal_identity_number** | **String** | The individual's personal identity number. The actual value of this field depends on the country of origin used to create the Freja credential. It is typically a Social Security Number, National Identification Number, or equivalent personal identifier. | [optional] |
+| **country** | **String** | The ISO 3166-1 alpha-2 country code associated with the individual's country of origin. | [optional] |
+| **document** | [**OutputFrejaDocument**](OutputFrejaDocument.md) | The underlying document, such as a passport, used to create the Freja credential. | [optional] |
+| **registration_level** | **String** | The Freja registration level associated with this individual. This can be BASIC, EXTENDED, or PLUS. * BASIC: Individual has a registered account with Freja. * EXTENDED: Individual has an official identity document verified by Freja. * PLUS: Individual has undergone in-person verification with Freja. | [optional] |
+| **relying_party_user_id** | **String** | The relying party identifier for this individual. This is an identifier specific to the individual and the relying party (your service). | [optional] |
+| **transaction_reference** | **String** | The Freja transaction reference for this verification. This is an identifier specific to the verification transaction. | [optional] |
 
 ## Example
 
@@ -15,10 +29,24 @@
 require 'trinsic_api'
 
 instance = TrinsicApi::FrejaProviderOutput.new(
-  first_name: John,
-  last_name: Doe,
-  personal_number: 200003276624,
-  personal_number_country: SE
+  name: Ada Lovelace,
+  given_name: Ada,
+  family_name: Lovelace,
+  date_of_birth: Mon Jan 01 00:00:00 UTC 1990,
+  email: ada.lovelace@example.com,
+  email_verified: true,
+  all_email_addresses: ["ada.lovelace@example.com","ada@example.org"],
+  primary_physical_address: null,
+  all_physical_addresses: [{"line1":"123 Residential St","city":"Townsville","postalCode":"12345","country":"US"},{"line1":"456 Billing St","city":"Citysville","postalCode":"67890","country":"US"}],
+  age: 35,
+  phone_number: +1234567890,
+  phone_number_verified: true,
+  personal_identity_number: A1234567890,
+  country: SE,
+  document: null,
+  registration_level: EXTENDED,
+  relying_party_user_id: FA9C4BAF97489D51B5A97B41F46AB1B514D66757DBBE8AA66EAD010262B2CCE3,
+  transaction_reference: hstRVGtMdQ-HLN8huVYY3HOfq0RS7BSZhgANDyk80UF-JLh8q8lS9Y7tVM44HLkg
 )
 ```
 

data/docs/FrenchNumeriqueGivenName.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **full_given_name** | **String** | Full given name(s) as recorded on the user's French identity document. If the user has multiple given names, they are separated by a single space. | [optional] |
+| **full_given_name** | **String** | Full given name(s) as recorded on the individual's French identity document. If the individual has multiple given names, they are separated by a single space. | [optional] |
 | **first_name** | **String** | First/primary given name (premier prénom). | [optional] |
 | **middle_name** | **String** | Middle name(s) (prénoms secondaires), separated by spaces if multiple. | [optional] |
 

data/docs/FrenchNumeriqueProviderOutput.md

@@ -5,24 +5,24 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **given_name** | [**FrenchNumeriqueGivenName**](FrenchNumeriqueGivenName.md) | Given name information including the full given name and its structured components (first name and middle name(s)). | [optional] |
-| **family_name** | **String** | Birth name (nom de naissance) as recorded on the user's French identity document. In France, this is the family name given at birth and may differ from the usage name. | [optional] |
+| **family_name** | **String** | Birth name (nom de naissance) as recorded on the individual's French identity document. In France, this is the family name given at birth and may differ from the usage name. | [optional] |
 | **preferred_surname** | **String** | Usage surname (\"nom d'usage\") - according to French law, this is the surname used in daily life. This is typically a married name or other preferred surname, as opposed to FamilyName which is the birth surname (\"nom de naissance\"). | [optional] |
-| **birthdate** | **String** | Date of birth in YYYY-MM-DD format, as recorded on the user's French identity document. | [optional] |
+| **birthdate** | **String** | Date of birth in YYYY-MM-DD format, as recorded on the individual's French identity document. | [optional] |
 | **nationality** | [**FrenchNumeriqueNationality**](FrenchNumeriqueNationality.md) | Nationality information with ISO 3166 alpha-3 code and French label. The label is provided in French (e.g., \"Française\" for French nationality). | [optional] |
 | **sex** | **String** | Sex - \"Male\" or \"Female\". | [optional] |
-| **majority** | **Boolean** | Majority status (majorité) indicating whether the user has reached the French age of legal majority (18 years old). This value is computed by the provider from the user's birthdate. | [optional] |
+| **majority** | **Boolean** | Majority status (majorité) indicating whether the individual has reached the French age of legal majority (18 years old). This value is computed by the provider from the individual's birthdate. | [optional] |
 | **phone_number** | [**FrenchNumeriquePhone**](FrenchNumeriquePhone.md) | Phone number information including the full phone number and its structured components (country prefix and national number). | [optional] |
 | **phone_number_verified** | **Boolean** | Whether the phone number has been verified by the provider. | [optional] |
-| **email** | **String** | Email address registered in the user's digital identity account. | [optional] |
+| **email** | **String** | Email address registered in the individual's digital identity account. | [optional] |
 | **email_verified** | **Boolean** | Whether the email address has been verified by the provider. | [optional] |
 | **birthplace** | **String** | National Institute of Statistics and Economic Studies (INSEE) official geographic code (COG) of the birthplace. This is a 5-digit French administrative code identifying the commune (municipality) of birth. For births in metropolitan France, the first two digits represent the department.              See: https://www.insee.fr/fr/information/2560452 | [optional] |
 | **birthplace_label** | **String** | Name of the birthplace commune (municipality). If applicable, this includes the full name of the arrondissement (borough). | [optional] |
-| **birth_country** | **String** | National Institute of Statistics and Economic Studies (INSEE) official geographic code (COG) for the user's country of birth.              LaPoste returns this as a 5-character numeric string. This is a country/territory COG, so it always starts with \"99\" (99xxx). France is coded as 99100.              See full list here: https://www.insee.fr/fr/information/2560452 | [optional] |
+| **birth_country** | **String** | National Institute of Statistics and Economic Studies (INSEE) official geographic code (COG) for the individual's country of birth.              LaPoste returns this as a 5-character numeric string. This is a country/territory COG, so it always starts with \"99\" (99xxx). France is coded as 99100.              See full list here: https://www.insee.fr/fr/information/2560452 | [optional] |
 | **birth_country_iso** | **String** | Birth country as an ISO 3166 alpha-3 code. | [optional] |
 | **birth_country_label** | **String** | Label of the birth country, in English. | [optional] |
 | **birth_department** | **String** | Number of the department of birth (e.g., \"75\" for Paris, \"2A\" for Corse-du-Sud).              See full list here: https://en.wikipedia.org/wiki/Departments_of_France | [optional] |
-| **digital_identity_creation_date** | **Date** | Date when the user's digital identity was created. | [optional] |
-| **digital_identity_expiration_date** | **Date** | Date when the digital identity expires. It is valid for 5 years from the date of identity verification. Users are notified ~1 month before and must re-verify identity via the app or in-person at La Poste. After expiration, the identity is deactivated but can be renewed within 1 year; otherwise deleted. | [optional] |
+| **digital_identity_creation_date** | **Date** | Date when the individual's digital identity was created. | [optional] |
+| **digital_identity_expiration_date** | **Date** | Date when the digital identity expires. It is valid for 5 years from the date of identity verification. Individuals are notified ~1 month before and must re-verify identity via the app or in-person at La Poste. After expiration, the identity is deactivated but can be renewed within 1 year; otherwise deleted. | [optional] |
 | **identity_document_type** | **String** | Type of identity document used for verification. Can be \"ID_CARD\", \"PASSPORT\", or \"RESIDENCE_PERMIT\". | [optional] |
 | **identity_document_number** | **String** | Identity document number as it appears on the ID Card, Passport or Residence Permit. | [optional] |
 | **identity_document_emitting_date** | **Date** | Date when the identity document was issued. | [optional] |

data/docs/GetProviderResponse.md

@@ -0,0 +1,18 @@
+# TrinsicApi::GetProviderResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **provider** | [**Provider**](Provider.md) | The provider available to this organization |  |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::GetProviderResponse.new(
+  provider: null
+)
+```
+

data/docs/GoogleWalletInput.md

@@ -5,6 +5,7 @@
 | 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] |
+| **preview_raw18013_request** | [**Raw18013RequestInput**](Raw18013RequestInput.md) | **Preview feature: not suitable for production use cases**              The raw 18013-7 exchange request to use for this verification.              If set, this overrides any default configuration on your Verification Profile.              NOTE: This parameter has no effect in live mode for Google Wallet verifications. Dynamic requests are currently only supported in test mode for Google Wallet. | [optional] |
 
 ## Example
 
@@ -12,7 +13,8 @@
 require 'trinsic_api'
 
 instance = TrinsicApi::GoogleWalletInput.new(
-  exchange_mechanism: null
+  exchange_mechanism: null,
+  preview_raw18013_request: null
 )
 ```
 

data/docs/GuatemalaCuiLookupInput.md

@@ -0,0 +1,18 @@
+# TrinsicApi::GuatemalaCuiLookupInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **document_number** | **String** | The Guatemalan Código Único de Identificación (CUI) number.              Assigned and maintained by RENAP (Registro Nacional de las Personas). Official format: exactly 13 numeric digits. 8 RENAP-assigned serial digits, 1 verifier digit (dígito verificador), and 4 geographic digits for department and municipality of birth. The CUI is printed on the Documento Personal de Identificación (DPI) in three groups (4–5–4) separated by spaces.              Trinsic normalizes to digits-only before lookup, automatically removing spaces, dots, hyphens, and other non-alphanumeric characters.              No verifier algorithm appears in publicly accessible RENAP resources. Community-maintained validators often use modulus-11 (non-official). | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::GuatemalaCuiLookupInput.new(
+  document_number: 1234567890101
+)
+```
+

data/docs/GuatemalaCuiProviderOutput.md

@@ -0,0 +1,36 @@
+# TrinsicApi::GuatemalaCuiProviderOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **full_name** | **String** | Full name, including given and family names of the CUI holder. |  |
+| **given_name** | **String** | Given name(s) of the CUI holder. |  |
+| **family_name** | **String** | Family name(s) of the CUI holder, including maternal and paternal names. |  |
+| **date_of_birth** | **Date** | Date of birth of the CUI holder. | [optional] |
+| **document_number** | **String** | The Guatemalan Código Único de Identificación (CUI) number.              Assigned and maintained by RENAP (Registro Nacional de las Personas). Official format: exactly 13 numeric digits. 8 RENAP-assigned serial digits, 1 verifier digit (dígito verificador), and 4 geographic digits for department and municipality of birth. The CUI is printed on the Documento Personal de Identificación (DPI) in three groups (4–5–4) separated by spaces.              Trinsic normalizes to digits-only when returning the result, automatically removing spaces, dots, hyphens, and other non-alphanumeric characters.              No verifier algorithm appears in publicly accessible RENAP resources. Community-maintained validators often use modulus-11 (non-official). |  |
+| **serial_digits** | **String** | The first 8 digits of the CUI: the portion RENAP assigns from its registration system, before the verifier digit and the four-place geographic codes. Called the “serial” numbers in community-maintained validators. |  |
+| **verifier_digit** | **String** | The 9th digit of the CUI (verifier digit / dígito verificador). No verifier algorithm appears in publicly accessible RENAP resources.              However, community-maintained validators often use modulus-11 (non-official). |  |
+| **geographic_digits** | **String** | The last four digits encode birthplace department and municipality. There is not a publicly accessible dataset from RENAP for geographic codes. The INE (Instituto Nacional de Estadística y Censos) provides a dictionary of variables (Educación Formal 2024) that includes statistical codes for decoding departments and municipalities. Be careful using these resources, as these codes are not official RENAP codes. They may not always map to the correct department and municipality for consular registrations, naturalizations, foreign residents, and other edge cases.              For the dataset, see: https://datos.ine.gob.gt/dataset/educacion-formal-2024 under \"Diccionario de Variables (Educación Formal 2024)\" |  |
+| **sex** | **String** | Sex of the CUI holder.              Possible values: - Male - Female - Unknown |  |
+| **array_name** | **Array<String>** | All names of the CUI holder, as an array of strings (e.g. given and family name parts). |  |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::GuatemalaCuiProviderOutput.new(
+  full_name: JUAN CARLOS PEREZ GARCIA,
+  given_name: JUAN CARLOS,
+  family_name: PEREZ GARCIA,
+  date_of_birth: Wed Jan 13 00:00:00 UTC 1999,
+  document_number: 1234567890101,
+  serial_digits: 12345678,
+  verifier_digit: 9,
+  geographic_digits: 0101,
+  sex: Male,
+  array_name: ["JUAN","CARLOS","PEREZ","GARCIA"]
+)
+```
+

data/docs/IndiaPanLookupInput.md

@@ -0,0 +1,18 @@
+# TrinsicApi::IndiaPanLookupInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **permanent_account_number** | **String** | Permanent Account Number (PAN) to verify. PAN is a ten-character tax identifier issued by the Income Tax Department of India. |  |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::IndiaPanLookupInput.new(
+  permanent_account_number: null
+)
+```
+

data/docs/IndiaPanLookupProviderOutput.md

@@ -0,0 +1,32 @@
+# TrinsicApi::IndiaPanLookupProviderOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **permanent_account_number** | **String** | Permanent Account Number (PAN) that was looked up.              PAN is a ten-character identifier issued by the Income Tax Department of India. | [optional] |
+| **structured_permanent_account_number** | [**IndiaPanStructuredNumber**](IndiaPanStructuredNumber.md) | PAN split into structural parts for the canonical ten-character format.              Covers alphabetic series, assessee category, name prefix letter, serial number, and check letter. | [optional] |
+| **full_name** | **String** | Full name of the entity subject to income tax.              NOTE: Only available when PAN status is VALID. | [optional] |
+| **given_name** | **String** | Given name of the individual.              NOTE: Only available when PAN status is VALID and the verification is for an individual person. | [optional] |
+| **middle_name** | **String** | Middle name of the individual.              NOTE: Only available when PAN status is VALID and the verification is for an individual person. | [optional] |
+| **family_name** | **String** | Family name of the individual.              NOTE: Only available when PAN status is VALID and the verification is for an individual person. | [optional] |
+| **date_of_birth** | **String** | Date of birth of the individual.              NOTE: Only available when PAN status is VALID and the verification is for an individual person. | [optional] |
+| **pan_status** | **String** | PAN card status from Signzy for the lookup.              Possible values: - VALID - FAKE - DEACTIVATED - DELETED - INVALID - AMALGAMATION - ACQUISITION - DEATH - DISSOLUTION - LIQUIDATED - MERGER - PARTITION - SPLIT - UNDER LIQUIDATION - INOPERATIVE | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::IndiaPanLookupProviderOutput.new(
+  permanent_account_number: ABCPS1234Z,
+  structured_permanent_account_number: null,
+  full_name: Rajesh Kumar Sharma,
+  given_name: Rajesh,
+  middle_name: Kumar,
+  family_name: Sharma,
+  date_of_birth: 1943-08-15,
+  pan_status: VALID
+)
+```
+

data/docs/IndiaPanStructuredNumber.md

@@ -0,0 +1,28 @@
+# TrinsicApi::IndiaPanStructuredNumber
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **series_code** | **String** | Three-letter block issued by the Income Tax Department of India.              Ties the number to a specific Income Tax Office or jurisdiction using an internal labeling system.              Position: - Characters 1 through 3 of the PAN              Possible values: - Any three-letter block of uppercase Latin letters |  |
+| **assessee_category_code** | **String** | Code that represents the entity that is subject to income tax in India.              Position: - Character 4 of the PAN              Possible values: - \"A\" for Association of Persons (AOP) - \"B\" for Body of Individuals (BOI) - \"C\" for Company - \"F\" for Firm - \"G\" for Government - \"H\" for Hindu Undivided Family (HUF) - \"J\" for Artificial Juridical Person - \"L\" for Local Authority - \"P\" for Individual - \"T\" for Trust |  |
+| **assessee_category_name** | **String** | Human-readable label for the assessee category when it matches a known code.              Possible values: - Association of Persons (AOP) - Body of Individuals (BOI) - Company - Firm - Government - Hindu Undivided Family (HUF) - Artificial Juridical Person - Local Authority - Individual - Trust              Omitted when the letter is not a standard category code. | [optional] |
+| **name_prefix_letter** | **String** | First letter of the name of the entity that is subject to income tax in India.              Position: - Character 5 of the PAN.              Format: - When AssesseeCategoryCode is P, this character is the first letter of the individual's   family name as recorded for the PAN. - When AssesseeCategoryCode is A, B, C, F, G, H, J, L, or T, this character is the first letter   of the name of the association, body, company, firm, government, HUF, local authority, or   trust.              Possible values: - Any uppercase Latin letter |  |
+| **serial_number** | **String** | Sequential four-digit field assigned by the Income Tax Department of India.              Each PAN receives a unique serial within the given series code and assessee category.              Position: - Characters 6 through 9 of the PAN.              Possible values: - Four-digit strings 0001 through 9999 inclusive, using only digits 0 through 9 |  |
+| **check_letter** | **String** | Alphabetic check character for the first nine characters of the PAN.              The algorithm has not been made publicly available by the Income Tax Department of India.              Position: - Character 10 of the PAN.              Possible values: - One uppercase Latin letter A through Z |  |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::IndiaPanStructuredNumber.new(
+  series_code: ABC,
+  assessee_category_code: P,
+  assessee_category_name: Individual,
+  name_prefix_letter: S,
+  serial_number: 1234,
+  check_letter: Z
+)
+```
+

data/docs/KenyaNidBiometric2Input.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id_number** | **String** | The user's Kenyan National ID number | [optional] |
+| **id_number** | **String** | The Kenya National ID Number (Nambari ya Kitambulisho) or Unique Personal Identifier (Maisha Namba).              This is the primary unique identifier for Kenyan citizens in all government systems, issued by the National Registration Bureau (NRB). The format is either 8 digits for National ID or 9 digits for Maisha Namba UPI (the new format since 2023). | [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] |
 

data/docs/KenyaNidLookup2Input.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id_number** | **String** | The user's National ID number | [optional] |
+| **id_number** | **String** | The Kenya National ID Number (Nambari ya Kitambulisho) or Unique Personal Identifier (Maisha Namba).              This is the primary unique identifier for Kenyan citizens in all government systems, issued by the National Registration Bureau (NRB). The format is either 8 digits for National ID or 9 digits for Maisha Namba UPI (the new format since 2023). | [optional] |
 
 ## Example
 

data/docs/KenyaNidLookup2ProviderOutput.md

@@ -10,7 +10,7 @@
 | **sex** | **String** | The sex of the ID holder as recorded on the National ID.              Possible values: - Male - Female |  |
 | **date_of_birth** | **Date** | The date of birth of the ID holder as recorded in IPRS. | [optional] |
 | **citizenship** | **String** | Citizenship status as recorded in the IPRS civil registry database.              For the Kenya National ID lookup, this value will always be \"Kenyan\" as the National ID is only issued to Kenyan citizens. Non-citizens residing in Kenya are issued different identification documents (Alien ID cards, refugee documentation, etc.) which are not supported by this provider. |  |
-| **id_number** | **String** | The Kenya National ID Number (Nambari ya Kitambulisho).              This is the primary unique identifier for Kenyan citizens in all government systems, issued by the National Registration Bureau (NRB). The format is 1 to 9 numeric digits (regex: /^[0-9]{1,9}$/). This number is assigned upon first registration at age 18 (or upon naturalization for new citizens) and remains constant for life. |  |
+| **id_number** | **String** | The Kenya National ID Number (Nambari ya Kitambulisho) or Unique Personal Identifier (Maisha Namba).              This is the primary unique identifier for Kenyan citizens in all government systems, issued by the National Registration Bureau (NRB). The format is either 8 digits for National ID or 9 digits for Maisha Namba UPI (the new format since 2023). |  |
 | **serial_number** | **String** | The physical card serial number printed on the Kenya National ID card.              This is distinct from the ID Number and serves as a card issuance tracking identifier maintained by IPRS. This value changes each time a new physical card is issued (loss, damage, renewal). |  |
 | **date_of_issue** | **Date** | The date the National ID was issued by the National Registration Bureau (NRB). | [optional] |
 | **place_of_birth** | [**KenyaNidLookup2Address**](KenyaNidLookup2Address.md) | Place of birth as recorded in Kenya's civil registry (IPRS).              This is structured according to Kenya's pre-2010 administrative hierarchy (District > Division > Location). | [optional] |

data/docs/KenyaNidMatch2Input.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id_number** | **String** | The user's Kenyan National ID number | [optional] |
+| **id_number** | **String** | The Kenya National ID Number (Nambari ya Kitambulisho) or Unique Personal Identifier (Maisha Namba).              This is the primary unique identifier for Kenyan citizens in all government systems, issued by the National Registration Bureau (NRB). The format is either 8 digits for National ID or 9 digits for Maisha Namba UPI (the new format since 2023). | [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] |

data/docs/KoreaTelcoMatchInput.md

@@ -0,0 +1,28 @@
+# TrinsicApi::KoreaTelcoMatchInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **phone_number** | **String** | Phone number without dashes, e.g. \"010XXXXXXXX\". |  |
+| **full_name** | **String** | Full legal name (UTF-8), e.g. \"홍길동\" or \"Hong Gildong\". |  |
+| **date_of_birth** | **Date** | Date of birth. |  |
+| **sex** | [**KoreaTelcoMatchSex**](KoreaTelcoMatchSex.md) | Sex. Must be Male or Female. |  |
+| **carrier** | [**MobileCarrier**](MobileCarrier.md) | Mobile carrier. Lgu = LG U+, Skt = SK Telecom, Kt = KT. |  |
+| **operating_system** | [**MobileOperatingSystem**](MobileOperatingSystem.md) | Device operating system. |  |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::KoreaTelcoMatchInput.new(
+  phone_number: null,
+  full_name: null,
+  date_of_birth: null,
+  sex: null,
+  carrier: null,
+  operating_system: null
+)
+```
+