trinsic_api 3.2.0 → 3.2.1

data/docs/EvrotrustProviderOutput.md

@@ -0,0 +1,78 @@
+# TrinsicApi::EvrotrustProviderOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **names** | **String** | The full name of the individual. | [optional] |
+| **latin_names** | **String** | The full Latin-script name of the individual. | [optional] |
+| **first_name** | **String** | The given name of the individual. | [optional] |
+| **middle_name** | **String** | The middle name of the individual. | [optional] |
+| **last_name** | **String** | The family name of the individual. | [optional] |
+| **first_name_latin** | **String** | The Latin-script given name of the individual. | [optional] |
+| **middle_name_latin** | **String** | The Latin-script middle name of the individual. | [optional] |
+| **last_name_latin** | **String** | The Latin-script family name of the individual. | [optional] |
+| **nationality** | **String** | The nationality label of the individual. | [optional] |
+| **nationality_country** | **String** | The nationality country of the individual. | [optional] |
+| **nationality_country_code** | **String** | The nationality country code of the individual.              Evrotrust uses ISO 3166-1 alpha-3 country codes. | [optional] |
+| **gender** | **String** | The gender label of the individual.              Known values in Evrotrust API docs: - Male: the individual is male. - Female: the individual is female. | [optional] |
+| **gender_latin** | **String** | The Latin-script gender label of the individual.              Known values in Evrotrust API docs: - Male: the individual is male. - Female: the individual is female. | [optional] |
+| **user_gender** | **String** | The gender value from Evrotrust's user data object.              Evrotrust documents this separately from the identification metadata gender labels. Known values: - Male: the individual is male. - Female: the individual is female. | [optional] |
+| **date_of_birth** | **Date** | The date of birth of the individual in YYYY-MM-DD format. | [optional] |
+| **place_of_birth** | **String** | The place of birth of the individual, if available. | [optional] |
+| **identification_number** | **String** | The national identification number of the individual.              The format depends on the verified document and issuing country. | [optional] |
+| **document_type** | **String** | The localized document type label of the identity document.              For Evrotrust's canonical document type code, see `docType`. | [optional] |
+| **doc_type** | **String** | The canonical Evrotrust document type code.              Known values: - IDcard: an identity card. - Passport: a passport. | [optional] |
+| **document_number** | **String** | The identity document number. | [optional] |
+| **document_issuer_name** | **String** | The name of the authority that issued the identity document. | [optional] |
+| **document_issue_date** | **Date** | The identity document issue date in YYYY-MM-DD format.              Evrotrust documents timestamp `0` for this field as no value; it is omitted from provider-specific output. | [optional] |
+| **document_valid_date** | **Date** | The identity document expiration date in YYYY-MM-DD format.              Evrotrust documents timestamp `0` for this field as no value; it is omitted from provider-specific output. | [optional] |
+| **document_country** | **String** | The identity document issuing country. | [optional] |
+| **document_country_code** | **String** | The identity document issuing country code.              Evrotrust uses ISO 3166-1 alpha-3 country codes. | [optional] |
+| **address** | **String** | The full address of the individual. | [optional] |
+| **address_components** | [**EvrotrustAddressComponents**](EvrotrustAddressComponents.md) | The structured address fragments of the individual, if available. | [optional] |
+| **email_addresses** | **Array<String>** | The email addresses of the individual, if available. | [optional] |
+| **phone_numbers** | **Array<String>** | The phone numbers of the individual in E.164 format, if available. | [optional] |
+| **identification_reason** | **String** | The relying party-provided reason for requesting identification. | [optional] |
+| **identification_before** | **String** | The deadline or contextual value supplied for the identification request. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::EvrotrustProviderOutput.new(
+  names: Iva Petrova Georgieva,
+  latin_names: IVA PETROVA GEORGIEVA,
+  first_name: Iva,
+  middle_name: Petrova,
+  last_name: Georgieva,
+  first_name_latin: IVA,
+  middle_name_latin: PETROVA,
+  last_name_latin: GEORGIEVA,
+  nationality: Bulgaria,
+  nationality_country: Bulgaria,
+  nationality_country_code: BGR,
+  gender: Female,
+  gender_latin: Female,
+  user_gender: Female,
+  date_of_birth: Fri Aug 03 00:00:00 UTC 1984,
+  place_of_birth: Sofia,
+  identification_number: 8001010008,
+  document_type: Паспорт,
+  doc_type: Passport,
+  document_number: 644444444,
+  document_issuer_name: MVR Sofia,
+  document_issue_date: Fri Jan 01 00:00:00 UTC 2021,
+  document_valid_date: Wed Jan 01 00:00:00 UTC 2031,
+  document_country: България,
+  document_country_code: BGR,
+  address: Sofia, Vitosha Blvd 2,
+  address_components: null,
+  email_addresses: ["iva.georgieva@example.com"],
+  phone_numbers: ["+359888123456"],
+  identification_reason: Identity verification,
+  identification_before: 2026-05-22T12:00:00Z
+)
+```
+

data/docs/FinlandIdCardProviderOutput.md

@@ -4,10 +4,10 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **first_name** | **String** | The first name of the verified individual |  |
-| **last_name** | **String** | The last name of the verified individual |  |
-| **date_of_birth** | **Date** | The date of birth of the verified individual |  |
-| **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). |  |
+| **first_name** | **String** | The first name of the verified individual | [optional] |
+| **last_name** | **String** | The last name of the verified individual | [optional] |
+| **date_of_birth** | **Date** | The date of birth of the verified 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] |
 
 ## Example
 

data/docs/FranceIdentiteProviderOutput.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **pid** | [**EudiPidCredential**](EudiPidCredential.md) | An EUDI Person Identification Data (PID) credential, retrieved from the individual's wallet. | [optional] |
 | **age_verification** | [**EudiAgeVerificationCredential**](EudiAgeVerificationCredential.md) | An EUDI Age Verification credential, retrieved from the individual's wallet. | [optional] |
-| **raw18013_output** | [**MdlOutput**](MdlOutput.md) | The raw output of the 18013-7 exchange performed through France Identité. |  |
+| **raw18013_output** | [**MdlOutput**](MdlOutput.md) | The raw output of the 18013-7 exchange performed through France Identité. | [optional] |
 
 ## Example
 

data/docs/FrejaIndirectProviderOutput.md

@@ -4,10 +4,10 @@
 
 | 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. |  |
+| **first_name** | **String** | The first name of the verified individual | [optional] |
+| **last_name** | **String** | The last name of the verified individual | [optional] |
+| **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. | [optional] |
+| **personal_number_country** | **String** | The 2-digit ISO country code of the country which issued the personal number. | [optional] |
 
 ## Example
 

data/docs/FrenchNumeriqueProviderOutput.md

@@ -4,14 +4,17 @@
 
 | 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] |
+| **sub** | **String** | OpenID Connect subject identifier (sub) for the verified individual. | [optional] |
+| **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] |
+| **splitted_given_name** | [**FrenchNumeriqueSplittedGivenName**](FrenchNumeriqueSplittedGivenName.md) | Given name split into first name and middle name(s). | [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 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 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** | **String** | Full phone number including country prefix. | [optional] |
+| **splitted_phone** | [**FrenchNumeriqueSplittedPhone**](FrenchNumeriqueSplittedPhone.md) | Phone number split into 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 individual's digital identity account. | [optional] |
 | **email_verified** | **Boolean** | Whether the email address has been verified by the provider. | [optional] |
@@ -36,14 +39,17 @@
 require 'trinsic_api'
 
 instance = TrinsicApi::FrenchNumeriqueProviderOutput.new(
-  given_name: null,
+  sub: 075ccece-6699-4c08-80ca-27a6af136b68,
+  given_name: Jean Pierre,
+  splitted_given_name: null,
   family_name: Dupont,
   preferred_surname: Martin,
   birthdate: 1990-01-15,
   nationality: null,
   sex: Male,
   majority: true,
-  phone_number: null,
+  phone_number: +33606060606,
+  splitted_phone: null,
   phone_number_verified: true,
   email: jean.dupont@example.fr,
   email_verified: true,

data/docs/{FrenchNumeriqueGivenName.md → FrenchNumeriqueSplittedGivenName.md}

@@ -1,10 +1,9 @@
-# TrinsicApi::FrenchNumeriqueGivenName
+# TrinsicApi::FrenchNumeriqueSplittedGivenName
 
 ## Properties
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **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] |
 
@@ -13,8 +12,7 @@
 ```ruby
 require 'trinsic_api'
 
-instance = TrinsicApi::FrenchNumeriqueGivenName.new(
-  full_given_name: Jean Pierre,
+instance = TrinsicApi::FrenchNumeriqueSplittedGivenName.new(
   first_name: Jean,
   middle_name: Pierre
 )

data/docs/{FrenchNumeriquePhone.md → FrenchNumeriqueSplittedPhone.md}

@@ -1,10 +1,9 @@
-# TrinsicApi::FrenchNumeriquePhone
+# TrinsicApi::FrenchNumeriqueSplittedPhone
 
 ## Properties
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **full_phone_number** | **String** | Full phone number including country prefix. | [optional] |
 | **country_prefix** | **String** | International country calling code including the plus sign. | [optional] |
 | **national_number** | **String** | National phone number without the country prefix. | [optional] |
 
@@ -13,8 +12,7 @@
 ```ruby
 require 'trinsic_api'
 
-instance = TrinsicApi::FrenchNumeriquePhone.new(
-  full_phone_number: +33606060606,
+instance = TrinsicApi::FrenchNumeriqueSplittedPhone.new(
   country_prefix: +33,
   national_number: 601020304
 )

data/docs/GermanyEudiSandboxInput.md

@@ -0,0 +1,18 @@
+# TrinsicApi::GermanyEudiSandboxInput
+
+## 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::GermanyEudiSandboxInput.new(
+  preview_raw18013_request: null
+)
+```
+

data/docs/GermanyEudiSandboxProviderOutput.md

@@ -0,0 +1,20 @@
+# TrinsicApi::GermanyEudiSandboxProviderOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pid** | [**EudiPidCredential**](EudiPidCredential.md) | An EUDI Person Identification Data (PID) credential, retrieved from the individual's wallet. | [optional] |
+| **raw18013_output** | [**MdlOutput**](MdlOutput.md) | The raw output of the 18013-7 exchange performed through the Germany EUDI Sandbox Wallet. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::GermanyEudiSandboxProviderOutput.new(
+  pid: null,
+  raw18013_output: null
+)
+```
+

data/docs/GetAttachmentResponse.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **content** | **String** | The raw file contents of the Attachment |  |
+| **content** | **String** | The file contents of the Attachment. When using an SDK, this can be a raw byte array. In raw JSON form this is Base64. Combine this with the Content type to reconstruct the file.              This is empty when `encryptedContent` is present. |  |
 | **content_type** | **String** | The MIME type of the Attachment data |  |
 
 ## Example

data/docs/GetSessionResultResponse.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **session** | [**Session**](Session.md) |  |  |
-| **identity_data** | [**IdentityData**](IdentityData.md) |  | [optional] |
+| **session** | [**Session**](Session.md) | The Session in its current state. |  |
+| **identity_data** | [**IdentityData**](IdentityData.md) | The IdentityData which resulted from the Session, if not HPKE-encrypted. | [optional] |
 
 ## Example
 

data/docs/GoogleWalletProviderOutput.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **mobile_drivers_license** | [**Iso180135MobileDriversLicenseCredential**](Iso180135MobileDriversLicenseCredential.md) | A standard 18013-5 Mobile Driver's License credential, retrieved from the individual's wallet. | [optional] |
 | **id_pass** | [**GoogleWalletIdPassCredential**](GoogleWalletIdPassCredential.md) | A Google Wallet ID Pass credential (`com.google.wallet.idcard.1`), retrieved from the individual's wallet. | [optional] |
-| **raw_mdl_output** | [**MdlOutput**](MdlOutput.md) | The raw output of the mDL exchange performed through Google Wallet. |  |
+| **raw_mdl_output** | [**MdlOutput**](MdlOutput.md) | The raw output of the mDL exchange performed through Google Wallet. | [optional] |
 
 ## Example
 

data/docs/GuatemalaCuiLookupInput.md

@@ -5,6 +5,7 @@
 | 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] |
+| **date_of_birth** | **Date** | The individual's date of birth.              Must match the record in order to retrieve the individual's details. | [optional] |
 
 ## Example
 
@@ -12,7 +13,8 @@
 require 'trinsic_api'
 
 instance = TrinsicApi::GuatemalaCuiLookupInput.new(
-  document_number: 1234567890101
+  document_number: 1234567890101,
+  date_of_birth: Mon Mar 12 00:00:00 UTC 1984
 )
 ```
 

data/docs/GuatemalaCuiProviderOutput.md

@@ -4,16 +4,16 @@
 
 | 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. |  |
+| **full_name** | **String** | Full name, including given and family names of the CUI holder. | [optional] |
+| **given_name** | **String** | Given name(s) of the CUI holder. | [optional] |
+| **family_name** | **String** | Family name(s) of the CUI holder, including maternal and paternal names. | [optional] |
 | **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). |  |
+| **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). | [optional] |
+| **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. | [optional] |
+| **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). | [optional] |
+| **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)\" | [optional] |
+| **sex** | **String** | Sex of the CUI holder.              Possible values: - Male - Female - Unknown | [optional] |
+| **array_name** | **Array<String>** | All names of the CUI holder, as an array of strings (e.g. given and family name parts). | [optional] |
 
 ## Example
 

data/docs/IdemiaMobileIdProviderOutput.md

@@ -0,0 +1,64 @@
+# TrinsicApi::IdemiaMobileIdProviderOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **sub** | **String** | The OpenID Connect subject identifier for the verified individual. | [optional] |
+| **name_suffix** | **String** | The individual's name suffix. | [optional] |
+| **full_name** | **String** | The individual's full name. | [optional] |
+| **given_name** | **String** | The individual's given name. | [optional] |
+| **family_name** | **String** | The individual's family name. | [optional] |
+| **birth_date** | **String** | The individual's birth date. | [optional] |
+| **age_over18** | **String** | Whether the individual is over 18 years old. | [optional] |
+| **age_over21** | **String** | Whether the individual is over 21 years old. | [optional] |
+| **age_over25** | **String** | Whether the individual is over 25 years old. | [optional] |
+| **resident_address** | **String** | The individual's resident street address. | [optional] |
+| **resident_state** | **String** | The individual's resident state. | [optional] |
+| **resident_country** | **String** | The individual's resident country. | [optional] |
+| **resident_postal_code** | **String** | The individual's resident postal code. | [optional] |
+| **resident_city** | **String** | The individual's resident city. | [optional] |
+| **email** | **String** | The individual's email address. | [optional] |
+| **email_verified** | **Boolean** | Whether the individual's email address has been verified. | [optional] |
+| **document_number** | **String** | The individual's document number. | [optional] |
+| **issue_date** | **String** | The date the document was issued. | [optional] |
+| **issuing_country** | **String** | The country that issued the document. | [optional] |
+| **issuing_authority** | **String** | The authority that issued the document. | [optional] |
+| **expiry_date** | **String** | The date the document expires. | [optional] |
+| **issuing_jurisdiction** | **String** | The jurisdiction that issued the document. | [optional] |
+| **document_type** | **String** | The document type. | [optional] |
+| **sex** | **String** | The individual's sex. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::IdemiaMobileIdProviderOutput.new(
+  sub: 248289761001,
+  name_suffix: Jr.,
+  full_name: Jane Doe,
+  given_name: Jane,
+  family_name: Doe,
+  birth_date: 1985-01-31,
+  age_over18: true,
+  age_over21: true,
+  age_over25: true,
+  resident_address: 123 Main St,
+  resident_state: NY,
+  resident_country: USA,
+  resident_postal_code: 12207,
+  resident_city: Albany,
+  email: jane.doe@example.com,
+  email_verified: true,
+  document_number: D1234567,
+  issue_date: 2021-01-31,
+  issuing_country: USA,
+  issuing_authority: New York DMV,
+  expiry_date: 2031-01-31,
+  issuing_jurisdiction: NY,
+  document_type: DRIVING_LICENSE,
+  sex: female
+)
+```
+

data/docs/IdentityData.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **originating_provider_id** | **String** | The ID of the provider from which this data originated (eg \"yoti\", \"clear\") | [optional] |
+| **originating_provider_id** | **String** | The ID of the provider from which this data originated (eg \"yoti\", \"clear\") |  |
 | **originating_sub_provider_id** | **String** | The sub-provider ID of the provider from which this data originated (eg \"rabo\", \"poste-italiane\")              This is applicable only to federated Identity Providers such as SPID and IDIN. | [optional] |
 | **person** | [**PersonData**](PersonData.md) | Identity data of the individual who was verified | [optional] |
 | **document** | [**DocumentData**](DocumentData.md) | Identity data of the document involved in verification, if relevant | [optional] |

data/docs/IndiaDigilockerAadhaarMatchDateOfBirthField.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **input_value** | **Date** | The date of birth submitted for this check, as provided in the match input. |  |
-| **outcome** | **Boolean** | Whether the submitted date of birth matched the issuer record for this session. |  |
+| **input_value** | **Date** | The date of birth submitted for this check, as provided in the match input. | [optional] |
+| **outcome** | **Boolean** | Whether the submitted date of birth matched the issuer record for this session. | [optional] |
 
 ## Example
 

data/docs/IndiaDigilockerAadhaarMatchFullNameField.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **input_value** | **String** | The full name string submitted for this check, as provided in the match input. |  |
-| **outcome** | **Float** | Full-name similarity score from the DigiLocker match result for this session.              Format: - Between 0.0 to 1.0, where higher values indicate closer agreement with the Aadhaar record. |  |
+| **input_value** | **String** | The full name string submitted for this check, as provided in the match input. | [optional] |
+| **outcome** | **Float** | Full-name similarity score from the DigiLocker match result for this session.              Format: - Between 0.0 to 1.0, where higher values indicate closer agreement with the Aadhaar record. | [optional] |
 
 ## Example
 

data/docs/IndiaPanStructuredNumber.md

@@ -4,12 +4,12 @@
 
 | 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 |  |
+| **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 | [optional] |
+| **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 | [optional] |
 | **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 |  |
+| **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 | [optional] |
+| **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 | [optional] |
+| **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 | [optional] |
 
 ## Example
 

data/docs/IndonesiaDukcapilMatchDateOfBirthField.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **input_value** | **Date** | The date of birth submitted for this check. |  |
-| **outcome** | **Float** | The provider assessment result for the submitted date of birth.              Local integration code expects the provider to return 0 or 1 for this assessment. |  |
+| **input_value** | **Date** | The date of birth submitted for this check. | [optional] |
+| **outcome** | **Float** | The provider assessment result for the submitted date of birth.              Local integration code expects the provider to return 0 or 1 for this assessment. | [optional] |
 
 ## Example
 

data/docs/IndonesiaDukcapilMatchFullNameField.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **input_value** | **String** | The full name submitted for this check. |  |
-| **outcome** | **Float** | The provider assessment result for the submitted full name.              Format: numeric score from 0.0 to 1.0, where higher values indicate closer agreement with the Dukcapil record. |  |
+| **input_value** | **String** | The full name submitted for this check. | [optional] |
+| **outcome** | **Float** | The provider assessment result for the submitted full name.              Format: numeric score from 0.0 to 1.0, where higher values indicate closer agreement with the Dukcapil record. | [optional] |
 
 ## Example
 

data/docs/IndonesiaDukcapilMatchNationalIdNumberField.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **input_value** | **String** | The NIK (Nomor Induk Kependudukan) submitted for this check.              NIK is Indonesia's unique population identity number, issued by Indonesia's population administration and civil registration authority (Dukcapil) under the Ministry of Home Affairs.              Format: - 16 numeric digits. - Digits 1-2 are the province code. - Digits 3-4 are the regency or city code within that province. - Digits 5-6 are the district code within that regency or city. - Digits 7-12 encode date of birth as DDMMYY. For female NIK holders, the day is increased by 40. - Digits 13-16 are an issuance serial number. |  |
-| **outcome** | **Float** | The provider assessment result for the submitted NIK.              Local integration code expects the provider to return 0 or 1 for this assessment. |  |
+| **input_value** | **String** | The NIK (Nomor Induk Kependudukan) submitted for this check.              NIK is Indonesia's unique population identity number, issued by Indonesia's population administration and civil registration authority (Dukcapil) under the Ministry of Home Affairs.              Format: - 16 numeric digits. - Digits 1-2 are the province code. - Digits 3-4 are the regency or city code within that province. - Digits 5-6 are the district code within that regency or city. - Digits 7-12 encode date of birth as DDMMYY. For female NIK holders, the day is increased by 40. - Digits 13-16 are an issuance serial number. | [optional] |
+| **outcome** | **Float** | The provider assessment result for the submitted NIK.              Local integration code expects the provider to return 0 or 1 for this assessment. | [optional] |
 
 ## Example
 

data/docs/IndonesiaDukcapilMatchProviderOutput.md

@@ -4,16 +4,16 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **national_id_number** | [**IndonesiaDukcapilMatchNationalIdNumberField**](IndonesiaDukcapilMatchNationalIdNumberField.md) | NIK submitted for this Dukcapil match and the assessment result returned for that value. |  |
-| **full_name** | [**IndonesiaDukcapilMatchFullNameField**](IndonesiaDukcapilMatchFullNameField.md) | Full name submitted for this Dukcapil match and the assessment result returned for that value. |  |
-| **date_of_birth** | [**IndonesiaDukcapilMatchDateOfBirthField**](IndonesiaDukcapilMatchDateOfBirthField.md) | Date of birth submitted for this Dukcapil match and the assessment result returned for that value. |  |
-| **province_code** | **String** | Two-digit Indonesian government administrative region code for the province, extracted from digits 1-2 of the submitted NIK number.              Source system: Kode Wilayah Administrasi Pemerintahan, maintained by Indonesia's Ministry of Home Affairs. The first digit indicates the island group: 1-2 Sumatra, 3-4 Java, 5 Bali and Nusa Tenggara, 6 Kalimantan, 7 Sulawesi, 8 Maluku, and 9 Papua. The second digit follows the province creation order. |  |
-| **regency_or_city_code** | **String** | Four-digit Indonesian government administrative region code for the regency or city, extracted from digits 1-4 of the submitted NIK number.              Source system: Kode Wilayah Administrasi Pemerintahan, maintained by Indonesia's Ministry of Home Affairs. Format: two-digit province code followed by a two-digit regency or city sequence; suffixes 01-69 identify regencies and suffixes 71-99 identify cities. The NIK stores this value without dot separators. |  |
-| **district_code** | **String** | Six-digit Indonesian government administrative region code for the district (kecamatan), extracted from digits 1-6 of the submitted NIK number.              Source system: Kode Wilayah Administrasi Pemerintahan, maintained by Indonesia's Ministry of Home Affairs. Format: two-digit province code, two-digit regency or city code, and two-digit district sequence. The NIK stores this value without dot separators. |  |
-| **sex_national_id_number** | **String** | Sex extracted from the birth-day portion of the submitted NIK number.              Known values: - Male: The encoded day value is 40 or lower. - Female: The encoded day value is greater than 40. |  |
-| **serial_number** | **String** | Four-digit issuance serial number extracted from digits 13-16 of the submitted NIK number. |  |
+| **national_id_number** | [**IndonesiaDukcapilMatchNationalIdNumberField**](IndonesiaDukcapilMatchNationalIdNumberField.md) | NIK submitted for this Dukcapil match and the assessment result returned for that value. | [optional] |
+| **full_name** | [**IndonesiaDukcapilMatchFullNameField**](IndonesiaDukcapilMatchFullNameField.md) | Full name submitted for this Dukcapil match and the assessment result returned for that value. | [optional] |
+| **date_of_birth** | [**IndonesiaDukcapilMatchDateOfBirthField**](IndonesiaDukcapilMatchDateOfBirthField.md) | Date of birth submitted for this Dukcapil match and the assessment result returned for that value. | [optional] |
+| **province_code** | **String** | Two-digit Indonesian government administrative region code for the province, extracted from digits 1-2 of the submitted NIK number.              Source system: Kode Wilayah Administrasi Pemerintahan, maintained by Indonesia's Ministry of Home Affairs. The first digit indicates the island group: 1-2 Sumatra, 3-4 Java, 5 Bali and Nusa Tenggara, 6 Kalimantan, 7 Sulawesi, 8 Maluku, and 9 Papua. The second digit follows the province creation order. | [optional] |
+| **regency_or_city_code** | **String** | Four-digit Indonesian government administrative region code for the regency or city, extracted from digits 1-4 of the submitted NIK number.              Source system: Kode Wilayah Administrasi Pemerintahan, maintained by Indonesia's Ministry of Home Affairs. Format: two-digit province code followed by a two-digit regency or city sequence; suffixes 01-69 identify regencies and suffixes 71-99 identify cities. The NIK stores this value without dot separators. | [optional] |
+| **district_code** | **String** | Six-digit Indonesian government administrative region code for the district (kecamatan), extracted from digits 1-6 of the submitted NIK number.              Source system: Kode Wilayah Administrasi Pemerintahan, maintained by Indonesia's Ministry of Home Affairs. Format: two-digit province code, two-digit regency or city code, and two-digit district sequence. The NIK stores this value without dot separators. | [optional] |
+| **sex_national_id_number** | **String** | Sex extracted from the birth-day portion of the submitted NIK number.              Known values: - Male: The encoded day value is 40 or lower. - Female: The encoded day value is greater than 40. | [optional] |
+| **serial_number** | **String** | Four-digit issuance serial number extracted from digits 13-16 of the submitted NIK number. | [optional] |
 | **phone_number** | **String** | The phone number submitted for this verification, if provided.              Format: international E.164 phone number. | [optional] |
-| **consent_given_at** | **Time** | The consent timestamp submitted for this verification. |  |
+| **consent_given_at** | **Time** | The consent timestamp submitted for this verification. | [optional] |
 | **email** | **String** | The email address submitted for this verification, if provided. | [optional] |
 
 ## Example

data/docs/IndonesiaNikMatchField.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **content** | **String** | Raw value used for this match field. |  |
-| **match_value** | **Boolean** | Whether the value matched. |  |
+| **content** | **String** | Raw value used for this match field. | [optional] |
+| **match_value** | **Boolean** | Whether the value matched. | [optional] |
 
 ## Example
 

data/docs/Iso180132BiometricDataBlockProduct.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **product_owner** | **Integer** | Identifier of the product owner. |  |
-| **product_type** | **Integer** | Identifier of the product type. |  |
+| **product_owner** | **Integer** | Identifier of the product owner. | [optional] |
+| **product_type** | **Integer** | Identifier of the product type. | [optional] |
 
 ## Example
 

data/docs/Iso180132BiometricGroupTemplate.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **templates** | [**Array<Iso180132BiometricTemplate>**](Iso180132BiometricTemplate.md) | Individual biometric templates contained in this group. |  |
+| **templates** | [**Array<Iso180132BiometricTemplate>**](Iso180132BiometricTemplate.md) | Individual biometric templates contained in this group. | [optional] |
 
 ## Example
 

data/docs/Iso180132BiometricTemplate.md

@@ -4,9 +4,9 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **header** | [**Iso180132BiometricTemplateHeader**](Iso180132BiometricTemplateHeader.md) | Header describing the biometric template. |  |
-| **data_block** | **String** | The raw data block, in a biometric type- and format-specific encoding.              For `face` and `signature_usual_mark`, this is a raw JPEG or JPEG2000 image.              See ISO 18013-2 and 18013-5. |  |
-| **data_is_encrypted** | **Boolean** | Whether the data block is encrypted. |  |
+| **header** | [**Iso180132BiometricTemplateHeader**](Iso180132BiometricTemplateHeader.md) | Header describing the biometric template. | [optional] |
+| **data_block** | **String** | The raw data block, in a biometric type- and format-specific encoding.              For `face` and `signature_usual_mark`, this is a raw JPEG or JPEG2000 image.              See ISO 18013-2 and 18013-5. | [optional] |
+| **data_is_encrypted** | **Boolean** | Whether the data block is encrypted. | [optional] |
 | **biometric_information_record_payload** | **String** | Optional Biometric Information Record payload, containing arbitrary domestic data. | [optional] |
 
 ## Example

data/docs/Iso180132BiometricTemplateHeader.md

@@ -4,15 +4,15 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **patron_header_version** | **Integer** | Patron header version (defaults to 0x0101). |  |
+| **patron_header_version** | **Integer** | Patron header version (defaults to 0x0101). | [optional] |
 | **biometric_type** | **Integer** | Biometric type code per ISO 18013-2. | [optional] |
 | **biometric_sub_type** | **Integer** | Biometric sub-type code per ISO 18013-2. | [optional] |
 | **creation_date** | **Time** | Date and time the biometric template was created. | [optional] |
 | **biometric_information_record_creator** | **String** | Name of the Biometric Information Record (BIR) creator. | [optional] |
 | **validity_period** | [**Iso180132BiometricValidityPeriod**](Iso180132BiometricValidityPeriod.md) | Validity period of the biometric data block. | [optional] |
 | **biometric_data_block_product** | [**Iso180132BiometricDataBlockProduct**](Iso180132BiometricDataBlockProduct.md) | Owner and type identifying the product that produced the biometric data block. | [optional] |
-| **biometric_data_block_format_owner** | **Integer** | Format owner of the biometric data block. |  |
-| **biometric_data_block_format_type** | **Integer** | Format type of the biometric data block. |  |
+| **biometric_data_block_format_owner** | **Integer** | Format owner of the biometric data block. | [optional] |
+| **biometric_data_block_format_type** | **Integer** | Format type of the biometric data block. | [optional] |
 | **biometric_information_record_index** | **String** | Index identifier of the Biometric Information Record, when present. | [optional] |
 
 ## Example