trinsic_api 3.0.2.pre.preview → 3.1.0.pre.preview1

data/docs/FaydaProviderOutput.md

@@ -4,10 +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
 
@@ -18,7 +24,13 @@ instance = TrinsicApi::FaydaProviderOutput.new(
   sub: F50278D6-7C38-4284-83CD-549BBC818F5C,
   name: Yohannes Tesfaye,
   english_name: Yohannes Tesfaye,
-  arabic_name: يوهانس تيسفاي
+  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

@@ -10,9 +10,9 @@
 | **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 user has self asserted their identity and multifactor authentication is not required. - Substantial: The user has performed either a remote or in-person identity verification and multifactor authentication is required. - High: The user has performed an in-person identity proofing with an authorized representative and has strong cryptographic authentication requirements such as using a smart card. | [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 user authenticated with MobileID (Mobiilivarmenne). | [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] |
 

data/docs/FrejaProviderOutput.md

@@ -20,7 +20,7 @@
 | **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 user identifier for this individual. This is an identifier specific to the individual and the relying party (your service). | [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

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/GoogleWalletInput.md

@@ -5,7 +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. | [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
 

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
+)
+```
+

data/docs/KoreaTelcoMatchProviderOutput.md

@@ -0,0 +1,22 @@
+# TrinsicApi::KoreaTelcoMatchProviderOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **phone_number** | **String** | The verified phone number as submitted by the relying party. |  |
+| **tele_type** | **String** | The mobile carrier used for verification. Possible values: <list type=\"bullet\"><item><description>Lgu</description></item><item><description>Skt</description></item><item><description>Kt</description></item></list> |  |
+| **result_code** | **String** | The RaonSecure result code returned by the carrier verification system. \"0000\" indicates a successful match.              Common error codes: - \"0000\": Successful match - \"0001\": Identity Verification Failed - Verification Information Mismatch (General) - \"0002\": Identity Verification Failed - Unable to Verify Phone Number - \"0004\": Identity Verification Failed - Date of Birth Verification Error - \"0005\": Identity Verification Failed - Gender Verification Error - \"0006\": Identity Verification Failed - Name Verification Error - \"0009\": Identity Verification Failed - Device OS Mismatch |  |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::KoreaTelcoMatchProviderOutput.new(
+  phone_number: 01012345678,
+  tele_type: Skt,
+  result_code: 0000
+)
+```
+

data/docs/KoreaTelcoMatchSex.md

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

data/docs/LloydsSmartIdProviderOutput.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **remember_me_id** | **String** | The unique id for your service of the individual. This is not shared between different services so if the user logs into a different service, the user will have a new id for the other service. | [optional] |
+| **remember_me_id** | **String** | A Yoti-generated unique ID for this individual, consistent across repeat shares and different for each Relying Party. | [optional] |
 | **email** | **String** | The email address of the individual | [optional] |
 | **given_name** | **String** | The given name of the individual. This can correspond to first and middle names in English. | [optional] |
 | **family_name** | **String** | The family name of the individual | [optional] |
@@ -12,7 +12,7 @@
 | **date_of_birth** | **Date** | The date of birth of the individual. Unverified date of birth may be safe to use. For example, Aadhaar card provides date of birth, but due to certain limitations of verifying Aadhaar, Yoti is unable to verify this property so it is listed as \"unverified\". | [optional] |
 | **gender** | **String** | The gender of the individual. Depending on the source or country, gender may not be verified. This is a setting that can be configured while setting up scopes.              Unverified gender may be safe to use. For example, Aadhaar card provides gender, but due to certain limitations of verifying Aadhaar, Yoti is unable to verify this property so it is listed as \"unverified\". In some countries Possible values: - \"MALE\" - \"FEMALE\" - \"TRANSGENDER\" - \"OTHER\" | [optional] |
 | **nationality** | **String** | The nationality of the individual as a ISO alpha-3 code | [optional] |
-| **mobile_number** | **String** | The mobile phone number of the individual. This number was verified with a one time password (OTP) during the user's registration with Yoti. In some cases, Yoti may do additional checks against its sources to confirm the user's identity. | [optional] |
+| **mobile_number** | **String** | The mobile phone number of the individual. This number was verified with a one time password (OTP) during the individual's registration with Yoti. In some cases, Yoti may do additional checks against its sources to confirm the individual's identity. | [optional] |
 | **structured_postal_address** | [**YotiStructuredPostalAddress**](YotiStructuredPostalAddress.md) | A structured postal address for the individual that comes from the underlying document or can be manually added. In the case of being manually added, the address is considered \"unverified\". Unverified addresses may be safe to use. For example, Aadhaar card provides an address, but due to certain limitations of verifying Aadhaar, Yoti is unable to verify this property so it is listed as \"unverified\". | [optional] |
 | **postal_address** | **String** | The whole address for the individual that comes from the underlying document or can be manually added. In the case of being manually added, the address is considered \"unverified\". The format of this will be different for each country. Refer to `StructuredPostalAddress` for a detailed version of the address. | [optional] |
 | **document_details** | [**YotiDocumentDetails**](YotiDocumentDetails.md) | The details of the underlying document used to help create the Yoti credential | [optional] |

data/docs/MdlOutput.md

@@ -5,8 +5,8 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **iaca_root_certificate** | [**MdlOutputCertificateData**](MdlOutputCertificateData.md) | Information about the IACA Root Certificate which signed (directly or indirectly) the Document Signer Certificate for this mDL. |  |
-| **document_signer_certificate** | [**MdlOutputCertificateData**](MdlOutputCertificateData.md) | Information about the Document Signer Certificate which signed the mDL presented by the user. |  |
-| **document_type** | **String** | The document type of the mDL presented by the user.              Common values: - \"org.iso.18013.5.1.mDL\" for ISO 18013-5 mDLs - \"com.google.wallet.idcard.1\" for Google Wallet ID Cards |  |
+| **document_signer_certificate** | [**MdlOutputCertificateData**](MdlOutputCertificateData.md) | Information about the Document Signer Certificate which signed the mDL presented by the individual. |  |
+| **document_type** | **String** | The document type of the mDL presented by the individual.              Common values: - \"org.iso.18013.5.1.mDL\" for ISO 18013-5 mDLs - \"com.google.wallet.idcard.1\" for Google Wallet ID Cards |  |
 | **name_spaces** | **Hash<String, Hash<String, MdlOutputFieldData>>** | The namespaces, and fields within those namespaces, which were present in the processed mDL. |  |
 
 ## Example

data/docs/MitIdProviderOutput.md

@@ -6,15 +6,15 @@
 | ---- | ---- | ----------- | ----- |
 | **full_name** | **String** | The full name of the individual. | [optional] |
 | **date_of_birth** | **Date** | The date of birth of the individual. | [optional] |
-| **unique_identifier** | **String** | A stable unique identifier representing the user in MitID's system. It is recommended to use this identifier instead of using the civil registration number (CPR number) directly. | [optional] |
+| **unique_identifier** | **String** | A stable unique identifier representing the individual in MitID's system. It is recommended to use this identifier instead of using the civil registration number (CPR number) directly. | [optional] |
 | **authentication_assurance_level** | **String** | The authentication assurance level (AAL) for the verification. The National Institute of Standards and Technology (NIST) measures the confidence in a digital identity's authentication strength set by a set of requirements for different levels. More information can be found here: https://pages.nist.gov/800-63-4/sp800-63b/aal/#AAL_SEC4 Possible values:              -  https://data.gov.dk/concept/core/nsis/Low - (Level 1) Provides basic confidence that the authenticator is either single factor or multifactor authentication. - https://data.gov.dk/concept/core/nsis/Substantial - (Level 2) Provides high confidence that the authenticator uses two distinct authentication factors that use secure authentication protocols. - https://data.gov.dk/concept/core/nsis/High - (Level 3) Provides very high confidence that the authenticator uses an non-exportable private key and another authentication factor.              **Note**: These urls are not valid anymore, but they still contain the level of assurance name. | [optional] |
-| **identity_authentication_level** | **String** | The identity assurance level (IAL) for the verification. The National Institute of Standards and Technology (NIST) measures the confidence of the digital identity's verification set by a set of requirements for different levels. More information can be found here: https://pages.nist.gov/800-63-4/sp800-63b/aal/#AAL_SEC4 Possible values:              -  https://data.gov.dk/concept/core/nsis/Low - (Level 1) The user has self asserted their identity and is neither verified nor validated. - https://data.gov.dk/concept/core/nsis/Substantial - (Level 2) The user has performed either a remote or in-person identity proofing. - https://data.gov.dk/concept/core/nsis/High - (Level 3) The user has performed an in person identity proofing with an authorized representative.              **Note**: These urls are not valid anymore, but they still contain the level of assurance name. | [optional] |
-| **level_of_assurance** | **String** | The level of assurance (LOA) for the verification. This is an older retired model that is a combination of Identity Assurance Level and Authentication Assurance Level. The National Institute of Standards and Technology (NIST) measures the confidence of the digital identity's verification and authentication strength by a set of requirements for different levels.              Possible values: -  https://data.gov.dk/concept/core/nsis/Low - (Level 1) The user has self asserted their identity and multifactor authentication is not required. - https://data.gov.dk/concept/core/nsis/Substantial - (Level 3) The user has performed either a remote or in-person identity proofing and multifactor authentication is required. - https://data.gov.dk/concept/core/nsis/High - (Level 4) The user has performed an in person identity proofing with an authorized representative and has strong cryptographic authentication requirements.              **Note**: These urls are not valid anymore, but they still contain the level of assurance name. MitID only returns three of the four potential levels and does not include level 2.              More information can be found here: - https://pages.nist.gov/800-63-3/sp800-63-3.html - https://pages.nist.gov/800-63-3/ | [optional] |
-| **identification_source** | **String** | The source of the identification for the verification              Possible values: - private - The verification is from a private individual. - professional - The verification is a user in behalf of a organization. | [optional] |
+| **identity_authentication_level** | **String** | The identity assurance level (IAL) for the verification. The National Institute of Standards and Technology (NIST) measures the confidence of the digital identity's verification set by a set of requirements for different levels. More information can be found here: https://pages.nist.gov/800-63-4/sp800-63b/aal/#AAL_SEC4 Possible values:              -  https://data.gov.dk/concept/core/nsis/Low - (Level 1) The individual has self asserted their identity and is neither verified nor validated. - https://data.gov.dk/concept/core/nsis/Substantial - (Level 2) The individual has performed either a remote or in-person identity proofing. - https://data.gov.dk/concept/core/nsis/High - (Level 3) The individual has performed an in person identity proofing with an authorized representative.              **Note**: These urls are not valid anymore, but they still contain the level of assurance name. | [optional] |
+| **level_of_assurance** | **String** | The level of assurance (LOA) for the verification. This is an older retired model that is a combination of Identity Assurance Level and Authentication Assurance Level. The National Institute of Standards and Technology (NIST) measures the confidence of the digital identity's verification and authentication strength by a set of requirements for different levels.              Possible values: -  https://data.gov.dk/concept/core/nsis/Low - (Level 1) The individual has self asserted their identity and multifactor authentication is not required. - https://data.gov.dk/concept/core/nsis/Substantial - (Level 3) The individual has performed either a remote or in-person identity proofing and multifactor authentication is required. - https://data.gov.dk/concept/core/nsis/High - (Level 4) The individual has performed an in person identity proofing with an authorized representative and has strong cryptographic authentication requirements.              **Note**: These urls are not valid anymore, but they still contain the level of assurance name. MitID only returns three of the four potential levels and does not include level 2.              More information can be found here: - https://pages.nist.gov/800-63-3/sp800-63-3.html - https://pages.nist.gov/800-63-3/ | [optional] |
+| **identification_source** | **String** | The source of the identification for the verification              Possible values: - private - The verification is from a private individual. - professional - The verification is an individual on behalf of an organization. | [optional] |
 | **civil_registration_number** | **String** | The civil registration number (CPR number) of the individual for the verification.              The CPR number is a 10-digit number in the format DDMMYYY-XXXX, where: - DDMMYYY represents the individual's date of birth (day, month, year). - XXXX is a unique identifier.              If XXXX is even, the individual is female. If XXXX is odd, the individual is male.              More information can be found here: https://international.kk.dk/live/cpr-registration-and-documents/cpr-number | [optional] |
 | **organization_name** | **String** | The name of the organization for the verification | [optional] |
 | **organization_number** | **String** | The organization number (CVR number). This is an 8-digit unique identifier for the organization. This will be prefixed with \"DK\" for VAT numbers. | [optional] |
-| **authorized_representative_number** | **String** | The organization number (CVR number) of the organization the user is authorized to represent. This is only returned if the requested scope is for an organization verification and the user provides a private source in behalf of a company. | [optional] |
+| **authorized_representative_number** | **String** | The organization number (CVR number) of the organization the individual is authorized to represent. This is only returned if the requested scope is for an organization verification and the individual provides a private source on behalf of a company. | [optional] |
 
 ## Example
 

data/docs/MobileCarrier.md

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

data/docs/MobileOperatingSystem.md

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

data/docs/NetherlandsIdinAddress.md

@@ -0,0 +1,26 @@
+# TrinsicApi::NetherlandsIdinAddress
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **street** | **String** | Street name of the individual's address. |  |
+| **house_number** | **String** | House number of the individual's address. |  |
+| **postal_code** | **String** | Postal code of the individual's address.              A postal code in The Netherlands is a 4-digit number and two letters. |  |
+| **city** | **String** | City of the individual's address. |  |
+| **country_code** | **String** | Country code of the individual's address in ISO 3166-1 alpha-2 format. |  |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::NetherlandsIdinAddress.new(
+  street: Drieslag,
+  house_number: 51,
+  postal_code: 6832AM,
+  city: Arnhem,
+  country_code: NL
+)
+```
+

data/docs/NetherlandsIdinProviderOutput.md

@@ -0,0 +1,36 @@
+# TrinsicApi::NetherlandsIdinProviderOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **authority_id** | **String** | Unique identifier of the authority that was used to verify the individual.              For banks this follows the SWIFT/BIC (Bank Identification Code) format. |  |
+| **authority_name** | **String** | Name of the authority that was used to verify the individual. |  |
+| **customer_id** | **String** | Unique identifier of the customer's account with the issuing authority.              This identifier is generated by each authority and is unique per customer registration, authority, and individual. The identifier should be treated as a unique opaque string. |  |
+| **initials** | **String** | Initials of the individual. |  |
+| **family_name** | **String** | Last/family name of the individual. |  |
+| **address** | [**NetherlandsIdinAddress**](NetherlandsIdinAddress.md) | Address of the individual. |  |
+| **birth_date** | **Date** | Date of birth of the individual. |  |
+| **gender** | **String** | Gender of the individual.              Possible values: - Male - Female - Unknown |  |
+| **phone_number** | **String** | Phone number of the individual in E164 format. | [optional] |
+| **email** | **String** | Email address of the individual. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::NetherlandsIdinProviderOutput.new(
+  authority_id: INGBNL2A,
+  authority_name: ING,
+  customer_id: NLINGBG344XBYRN9O+Zu7EK9ajC8Ta19fe0xDYfwudOnKRirMopP9rgG/GfV8L1Ck3UWqgYq8dNhKztgp3PRYOelbTJQ==,
+  initials: J,
+  family_name: De Wit,
+  address: null,
+  birth_date: Mon Jan 15 00:00:00 UTC 1990,
+  gender: Male,
+  phone_number: +31612345678,
+  email: jan.dewit@example.nl
+)
+```
+

data/docs/NorwegianBankIdProviderOutput.md

@@ -6,11 +6,11 @@
 | ---- | ---- | ----------- | ----- |
 | **full_name** | **String** | The full name of the individual. | [optional] |
 | **date_of_birth** | **Date** | The date of birth of the individual. | [optional] |
-| **personal_identifier** | **String** | The personal identifier for Norwegian BankID.              This uniquely identifies the user in the Norwegian BankID system and is considered a stable identifier to use. | [optional] |
+| **personal_identifier** | **String** | The personal identifier for Norwegian BankID.              This uniquely identifies the individual in the Norwegian BankID system and is considered a stable identifier to use. | [optional] |
 | **national_identity_number** | **String** | The 11-digit Norwegian National Identity Number (fødselsnummer) of the verified individual.              This is in the format DDMMYYZZZCC, where: - DDMMYY is the date of birth (In some cases, this is not the date of birth due to no available identity numbers for some dates - ZZZ is an individual number, indicating gender - CC is a checksum character              If ZZZ is even, the individual is female. If ZZZ is odd, the individual is male. | [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 user has self asserted their identity and multifactor authentication is not required. - Substantial: The user has performed either a remote or in-person identity verification and multifactor authentication is required. - High: The user has performed an in-person identity proofing with an authorized representative and has strong cryptographic authentication requirements such as using a smart card. | [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] |
 | **authentication_method** | **String** | The authentication method used by the individual.              Possible values: - urn:bankid:bis - BankID with Biometrics - urn:bankid:bid - Standard BankID with High Assurance | [optional] |
 
 ## Example

data/docs/PanamaCedulaLookupInput.md

@@ -0,0 +1,20 @@
+# TrinsicApi::PanamaCedulaLookupInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **document_number** | **String** | The number from the holder's cédula (Cédula de Identidad Personal).              Send the full number as {firstSegment}-{libro}-{tomo} (libro 1–4 digits, tomo 1–6), using only ASCII letters, digits, and hyphens. Hyphens are not inserted for you between segments. Trinsic uppercases letters, collapses repeated hyphens, trims leading and trailing hyphens, and merges a redundant hyphen between province and AV or PI (for example 10-AV-1234-12345 becomes 10AV-1234-12345).              Citizen category and format: - Born in Panama format: {province}-{libro}-{tomo} ({province} is official code 1 through 13). Examples   8-1234-12345, 4-56-789, 12-12-12345. - Panamanian born abroad format: PE-{libro}-{tomo}. Example PE-1234-12345. - Foreign national with cédula format: E-{libro}-{tomo}. Examples E-1234-12345, E-8-102017. - Naturalized citizen format: N-{libro}-{tomo}. Example N-1234-12345. - Pre-2006 civil registry (AV) format: {province}AV-{libro}-{tomo}. Example 10AV-1234-12345. - Indigenous (PI) format: {province}PI-{libro}-{tomo}. Example 1PI-1234-12345. | [optional] |
+| **date_of_birth** | **Date** | The user's date of birth, in `YYYY-MM-DD` format. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::PanamaCedulaLookupInput.new(
+  document_number: 8-1234-12345,
+  date_of_birth: Mon Mar 02 00:00:00 UTC 1992
+)
+```
+