trinsic_api 3.2.0 → 3.3.0.pre.alpha2

data/docs/GetAttachmentResponse.md

@@ -4,7 +4,8 @@
 
 | 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. |  |
+| **encrypted_content** | [**TrinsicHPKEBundle**](TrinsicHPKEBundle.md) | The HPKE Bundle containing the encrypted contents of the Attachment, if secured via HPKE.              Decrypt it using the HPKE info string `trinsic-hpke:1:attachment-contents:{sessionId}:{attachmentId}`. | [optional] |
 | **content_type** | **String** | The MIME type of the Attachment data |  |
 
 ## Example
@@ -14,6 +15,7 @@ require 'trinsic_api'
 
 instance = TrinsicApi::GetAttachmentResponse.new(
   content: null,
+  encrypted_content: null,
   content_type: null
 )
 ```

data/docs/GetSessionResultRequest.md

@@ -5,6 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **results_access_key** | **String** | The Results Access Key to exchange |  |
+| **redirect_token** | **String** | The `redirectToken` which Trinsic appended to your Redirect URL before sending the user back to your application.              This is only relevant for Sessions which involve a redirect flow.              If a `redirectToken` is required for a Session, it is only required for the first call to `GetSessionResult`. Future calls do not require a `redirectToken`. | [optional] |
 
 ## Example
 
@@ -12,7 +13,8 @@
 require 'trinsic_api'
 
 instance = TrinsicApi::GetSessionResultRequest.new(
-  results_access_key: null
+  results_access_key: null,
+  redirect_token: null
 )
 ```
 

data/docs/GetSessionResultResponse.md

@@ -4,8 +4,9 @@
 
 | 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] |
+| **encrypted_identity_data** | [**TrinsicHPKEBundle**](TrinsicHPKEBundle.md) | The HPKE-encrypted IdentityData which resulted from the Session, if HPKE-encrypted. | [optional] |
 
 ## Example
 
@@ -14,7 +15,8 @@ require 'trinsic_api'
 
 instance = TrinsicApi::GetSessionResultResponse.new(
   session: null,
-  identity_data: null
+  identity_data: null,
+  encrypted_identity_data: null
 )
 ```
 

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

@@ -0,0 +1,22 @@
+# TrinsicApi::HPKETestRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | **String** | The data to encrypt. Must be between 0 and 1024 bytes. |  |
+| **info_suffix** | **String** | A 32-character suffix appended to the fixed info prefix to form the HPKE info parameter. |  |
+| **public_key** | **String** | The recipient's public key, as a JWK or PEM string. |  |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::HPKETestRequest.new(
+  data: null,
+  info_suffix: null,
+  public_key: null
+)
+```
+

data/docs/HPKETestVPRequest.md

@@ -0,0 +1,20 @@
+# TrinsicApi::HPKETestVPRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | **String** | The data to encrypt. Must be between 0 and 1024 bytes. |  |
+| **info_suffix** | **String** | A 32-byte suffix appended to the fixed info prefix to form the HPKE info parameter. |  |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::HPKETestVPRequest.new(
+  data: null,
+  info_suffix: null
+)
+```
+

data/docs/IdemiaMobileIdProviderOutput.md

@@ -0,0 +1,60 @@
+# 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] |
+| **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,
+  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: DL,
+  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/IndiaPanLookupProviderOutput.md

@@ -11,7 +11,7 @@
 | **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] |
+| **pan_status** | **String** | PAN card status returned by the lookup provider.              Possible values: - VALID - FAKE - DEACTIVATED - DELETED - INVALID - AMALGAMATION - ACQUISITION - DEATH - DISSOLUTION - LIQUIDATED - MERGER - PARTITION - SPLIT - UNDER LIQUIDATION - INOPERATIVE | [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/IndonesiaDukcapilMatchInput.md

@@ -9,7 +9,7 @@
 | **nik_id_number** | **String** | The user's Indonesia NIK ID number | [optional] |
 | **email** | **String** | The email address of the individual.              Either email or phone number must be provided. | [optional] |
 | **phone_number** | **String** | The phone number of the individual.              Either email or phone number must be provided. | [optional] |
-| **selfie_image** | **String** | The raw bytes of the selfie image of the individual.              Must be JPEG or PNG format; 10MB maximum. | [optional] |
+| **selfie_image** | **String** | The raw bytes of the selfie image of the individual.              Must be JPEG or PNG format; 10MB maximum. When using an SDK, this can be a raw byte array. In raw JSON form this is Base64. | [optional] |
 | **document_image** | **String** | The raw bytes of the image of the individual's KTP government ID.              Must be JPEG format; 1MB maximum.              Optional. | [optional] |
 | **consent_given_at** | **Time** | The timestamp when consent was given by the user for the verification. | [optional] |
 

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

data/docs/Iso180132BiometricValidityPeriod.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **not_before** | **Date** | Date the biometric data block becomes valid. |  |
-| **not_after** | **Date** | Date the biometric data block expires. |  |
+| **not_before** | **Date** | Date the biometric data block becomes valid. | [optional] |
+| **not_after** | **Date** | Date the biometric data block expires. | [optional] |
 
 ## Example
 

data/docs/Iso180135AamvaDomesticVehicleClass.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **code** | **String** | Vehicle class code. |  |
-| **description** | **String** | Human-readable description of the vehicle class. |  |
+| **code** | **String** | Vehicle class code. | [optional] |
+| **description** | **String** | Human-readable description of the vehicle class. | [optional] |
 | **issue_date** | **Date** | Date when this vehicle class privilege was issued. | [optional] |
 | **expiry_date** | **Date** | Date when this vehicle class privilege expires. | [optional] |
 

data/docs/Iso180135AamvaDomesticVehicleEndorsement.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **code** | **String** | Endorsement code, when present. | [optional] |
-| **description** | **String** | Human-readable description of the endorsement. |  |
+| **description** | **String** | Human-readable description of the endorsement. | [optional] |
 
 ## Example
 

data/docs/Iso180135AamvaDomesticVehicleRestriction.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **code** | **String** | Restriction code, when present. | [optional] |
-| **description** | **String** | Human-readable description of the restriction. |  |
+| **description** | **String** | Human-readable description of the restriction. | [optional] |
 
 ## Example
 

data/docs/Iso180135AamvaWeightRange.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **min_kilograms** | **Integer** | Minimum weight in the range, in kilograms. |  |
+| **min_kilograms** | **Integer** | Minimum weight in the range, in kilograms. | [optional] |
 | **max_kilograms** | **Integer** | Maximum weight in the range, in kilograms.              If null, the maximum weight has no limit. | [optional] |
 
 ## Example

data/docs/Iso180135DrivingPrivilege.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **vehicle_category_code** | **String** | Vehicle category code that the holder is authorized to operate. |  |
+| **vehicle_category_code** | **String** | Vehicle category code that the holder is authorized to operate. | [optional] |
 | **issue_date** | **Date** | Date when this driving privilege was issued. | [optional] |
 | **expiry_date** | **Date** | Date when this driving privilege expires. | [optional] |
 | **codes** | [**Array<Iso180135DrivingPrivilegeCode>**](Iso180135DrivingPrivilegeCode.md) | Restriction, condition, or special privilege codes attached to this entry. | [optional] |

data/docs/Iso180135DrivingPrivilegeCode.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **code** | **String** | The code identifier. |  |
+| **code** | **String** | The code identifier. | [optional] |
 | **sign** | **String** | Optional comparison sign applied to the code's value. | [optional] |
 | **value** | **String** | Optional value applied to the code. | [optional] |
 

data/docs/ItsmeAddressBase.md

@@ -0,0 +1,22 @@
+# TrinsicApi::ItsmeAddressBase
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **street_address** | **String** | The street address.              itsme documents this as an address member when the address claim is returned. | [optional] |
+| **postal_code** | **String** | The postal code of the address.              itsme documents this as an address member when the address claim is returned. | [optional] |
+| **country** | **String** | The country of the address as an ISO 3166-1 alpha-2 code, when returned.              This field is not part of itsme's documented address claim members; it is present only when itsme returns `address.country`. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::ItsmeAddressBase.new(
+  street_address: Jekerstraat 39,
+  postal_code: 3700,
+  country: BE
+)
+```
+

data/docs/ItsmeBelgianIdentityCard.md

@@ -0,0 +1,26 @@
+# TrinsicApi::ItsmeBelgianIdentityCard
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **number** | **String** | The Belgian eID card number. This identifies the card document, not the person's Belgian National Register Number.              Availability by ID document issuing country: returned only for Belgian-issued ID documents.              Belgian citizen examples are 12 digits in the form `xxx-xxxxxxx-yy`; EU, EEA, and Swiss resident card examples can start with a letter followed by digits. | [optional] |
+| **issuing_country** | **String** | The issuing country as an ISO 3166-1 alpha-2 country code.              Availability by ID document issuing country: always returned for all supported issuing countries. | [optional] |
+| **validity_from** | **Time** | The identity card validity start date time.              Availability by ID document issuing country: best effort for Belgian-issued ID documents; not returned for other supported issuing countries. | [optional] |
+| **validity_to** | **Time** | The identity card validity end date time.              Availability by ID document issuing country: always returned for supported issuing countries except Belgium, where it is best effort. | [optional] |
+| **issuance_locality** | **String** | The locality that issued the identity card.              Availability by ID document issuing country: best effort for Belgian-issued ID documents; not returned for other supported issuing countries. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::ItsmeBelgianIdentityCard.new(
+  number: 431522485012,
+  issuing_country: BE,
+  validity_from: 2018-11-08T00:00Z,
+  validity_to: 2028-11-10T00:00Z,
+  issuance_locality: BRUXELLES
+)
+```
+

data/docs/ItsmeBelgianNationalNumber.md

@@ -0,0 +1,22 @@
+# TrinsicApi::ItsmeBelgianNationalNumber
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **number** | **String** | The raw Belgian National Register Number of the verified individual.              Availability by ID document issuing country: returned only for Belgian-issued ID documents.              This is an 11-digit number in the format YYMMDDXXXCC: - YYMMDD is the date of birth. - XXX is a sequential birth number, odd for males and even for females. - CC is the checksum. | [optional] |
+| **issuing_country** | **String** | The issuing country as an ISO 3166-1 alpha-2 country code.              Availability by ID document issuing country: always returned for all supported issuing countries. | [optional] |
+| **verification_date** | **Time** | The date time when the document was last read.              Availability by ID document issuing country: always returned for supported issuing countries except Belgium, where it is best effort. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::ItsmeBelgianNationalNumber.new(
+  number: 99060427181,
+  issuing_country: BE,
+  verification_date: 2023-04-12T15:02:23Z
+)
+```
+