RubyGems - trinsic_api - Versions diffs - 3.0.2.pre.preview → 3.1.0 - Mend

trinsic_api 3.0.2.pre.preview → 3.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (566) hide show

data/docs/EudiAgeVerificationCredential.md ADDED Viewed

@@ -0,0 +1,22 @@
+# TrinsicApi::EudiAgeVerificationCredential
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **age_over** | [**Array&lt;AgeOverOutput&gt;**](AgeOverOutput.md) | Processed age-over claims returned by the credential. | [optional] |
+| **expiry_date** | **Date** | Date when the age verification data expires. | [optional] |
+| **issuing_country** | **String** | ISO 3166-1 alpha-2 country code of the country or territory of the issuer of the credential. | [optional] |
+## Example
+```ruby
+require 'trinsic_api'
+instance = TrinsicApi::EudiAgeVerificationCredential.new(
+  age_over: [{&quot;age&quot;:18,&quot;isOver&quot;:true},{&quot;age&quot;:21,&quot;isOver&quot;:true}],
+  expiry_date: Thu Jan 31 00:00:00 UTC 2030,
+  issuing_country: FR
+)
+```

data/docs/EudiPidCredential.md ADDED Viewed

@@ -0,0 +1,70 @@
+# TrinsicApi::EudiPidCredential
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **given_name** | **String** | Current first name(s), including middle name(s) where applicable, of the individual to whom the PID relates. | [optional] |
+| **given_name_birth** | **String** | First name(s), including middle name(s), of the individual at the time of birth. | [optional] |
+| **family_name** | **String** | Current last name(s) or surname(s) of the individuals. | [optional] |
+| **family_name_birth** | **String** | Last name(s) or surname(s) of the individual at the time of birth. | [optional] |
+| **date_of_birth** | **Date** | The date of birth of the individual. | [optional] |
+| **birth_place** | **String** | Country (ISO 3166-1 alpha-2), state, province, district, local area, municipality, city, town, or village where the individual was born. | [optional] |
+| **nationality** | **Array&lt;String&gt;** | One or more ISO 3166-1 alpha-2 country codes representing the nationality of the individual. | [optional] |
+| **expiry_date** | **Date** | Date when the PID expires.              Because PIDs are not necessarily backed by a physical document, this does not correspond to the expiration date of such. | [optional] |
+| **issuing_authority** | **String** | Name of the administrative authority that issued the PID, or the ISO 3166 alpha-2 country code of the respective Member State if there is no separate authority entitled to issue PIDs. | [optional] |
+| **issuing_country** | **String** | ISO 3166-1 alpha-2 country code of the country or territory of the issuer of the PID. | [optional] |
+| **issuance_date** | **Date** | Date when the PID was issued and/or the administrative validity period began. | [optional] |
+| **trust_anchor** | **String** | URL where a machine-readable trust anchor for verifying the PID can be found. | [optional] |
+| **attestation_legal_category** | **String** | Indicator that this credential has been issued specifically as PID.              When present, typically equal to \&quot;PID\&quot;. | [optional] |
+| **document_number** | **String** | A number assigned to the PID by the issuer.              This does not correspond to the document number of a physical document. | [optional] |
+| **issuing_jurisdiction** | **String** | ISO 3166-2 country-subdivision code for the jurisdiction that issued the PID. | [optional] |
+| **location_status** | **String** | Location of validity status information for the PID, where revocation information is published. | [optional] |
+| **sex** | **Integer** | Sex of the individual.              This is a superset of the ISO/IEC 5218 sex code standard, defining additional \&quot;other\&quot;, \&quot;inter\&quot;, \&quot;diverse\&quot;, and \&quot;open\&quot; values.              Possible values: - 0: Unknown - 1: Male - 2: Female - 3: Other - 4: Inter - 5: Diverse - 6: Open - 9: Not Applicable              For values 0, 1, 2, and 9, ISO/IEC 5218 applies. | [optional] |
+| **email_address** | **String** | The individual&#39;s email address. | [optional] |
+| **mobile_phone_number** | **String** | The mobile phone number of the individual, in international format. | [optional] |
+| **personal_administrative_number** | **String** | A value assigned to the individual that is unique among all personal administrative numbers issued by the provider. | [optional] |
+| **resident_address** | **String** | The full address of the individual&#39;s permanent residence. | [optional] |
+| **resident_street** | **String** | The street name of the individual&#39;s permanent residence. | [optional] |
+| **resident_house_number** | **String** | The house number of the individual&#39;s permanent residence. | [optional] |
+| **resident_city** | **String** | The municipality, city, town, or village of the individual&#39;s permanent residence. | [optional] |
+| **resident_state** | **String** | The state, province, district, or local area of the individual&#39;s permanent residence. | [optional] |
+| **resident_postal_code** | **String** | The postal code of the individual&#39;s permanent residence. | [optional] |
+| **resident_country** | **String** | The ISO 3166-1 alpha-2 country code of the individual&#39;s permanent residence. | [optional] |
+## Example
+```ruby
+require 'trinsic_api'
+instance = TrinsicApi::EudiPidCredential.new(
+  given_name: JEAN,
+  given_name_birth: JEAN,
+  family_name: DUPONT,
+  family_name_birth: DUPONT,
+  date_of_birth: Wed Jan 31 00:00:00 UTC 1990,
+  birth_place: PARIS,
+  nationality: [&quot;FR&quot;],
+  expiry_date: Thu Jan 31 00:00:00 UTC 2030,
+  issuing_authority: FR,
+  issuing_country: FR,
+  issuance_date: Fri Jan 31 00:00:00 UTC 2020,
+  trust_anchor: https://trust.example.test/anchor,
+  attestation_legal_category: PID,
+  document_number: P1234567,
+  issuing_jurisdiction: FR-75,
+  location_status: https://status.example.test/pid,
+  sex: 1,
+  email_address: jean.dupont@example.test,
+  mobile_phone_number: +33612345678,
+  personal_administrative_number: 123456789,
+  resident_address: 1 RUE DE LA PAIX, 75001 PARIS,
+  resident_street: RUE DE LA PAIX,
+  resident_house_number: 1,
+  resident_city: PARIS,
+  resident_state: ILE-DE-FRANCE,
+  resident_postal_code: 75001,
+  resident_country: FR
+)
+```

data/docs/FaydaProviderAddress.md ADDED Viewed

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

data/docs/FaydaProviderOutput.md CHANGED Viewed

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

data/docs/FinnishTrustNetworkProviderOutput.md CHANGED Viewed

@@ -10,9 +10,9 @@
 | **unique_identification_number** | **String** | The 9-digit Finnish Unique Identification Number (FINUID, or sähköinen asiointitunnus SATU) of the verified individual. This number is typically used for online transactions and unlike the Finnish Personal Identification Code, does not reveal personal information such as birthdate.              The first 8 digits are randomly generated and the last character is a check control. | [optional] |
 | **given_name** | **String** | The given name of the individual. | [optional] |
 | **family_name** | **String** | The family name of the individual. | [optional] |
-| **level_of_assurance** | **String** | The level of assurance (LOA) for the verification.              The LOA refers to the degree of confidence in the claimed identity of a person. The European Digital Identity Framework (EUDI) measures the confidence of the digital identity&#39;s verification and authentication strength by a set of requirements for different levels. To learn more, see: https://ec.europa.eu/digital-building-blocks/sites/spaces/DIGITAL/pages/467110081/eIDAS+Levels+of+Assurance              Possible values: - Low: The user has self asserted their identity and multifactor authentication is not required. - Substantial: The user has performed either a remote or in-person identity verification and multifactor authentication is required. - High: The user has performed an in-person identity proofing with an authorized representative and has strong cryptographic authentication requirements such as using a smart card. | [optional] |
+| **level_of_assurance** | **String** | The level of assurance (LOA) for the verification.              The LOA refers to the degree of confidence in the claimed identity of a person. The European Digital Identity Framework (EUDI) measures the confidence of the digital identity&#39;s verification and authentication strength by a set of requirements for different levels. To learn more, see: https://ec.europa.eu/digital-building-blocks/sites/spaces/DIGITAL/pages/467110081/eIDAS+Levels+of+Assurance              Possible values: - Low: The individual has self asserted their identity and multifactor authentication is not required. - Substantial: The individual has performed either a remote or in-person identity verification and multifactor authentication is required. - High: The individual has performed an in-person identity proofing with an authorized representative and has strong cryptographic authentication requirements such as using a smart card. | [optional] |
 | **bank** | **String** | The bank used to perform the identification for the verified individual. | [optional] |
-| **phone_number** | **String** | The phone number of the verified individual.              This is only returned if the user authenticated with MobileID (Mobiilivarmenne). | [optional] |
+| **phone_number** | **String** | The phone number of the verified individual.              This is only returned if the individual authenticated with MobileID (Mobiilivarmenne). | [optional] |
 | **organization_name** | **String** | The organization name that the individual is associated with.              This is returned for requests that contain the organization scope. | [optional] |
 | **vat_number** | **String** | The VAT number of the organization that the individual is associated with.              This is returned for requests that contain the organization scope. | [optional] |

data/docs/FranceIdentiteProviderOutput.md CHANGED Viewed

@@ -4,6 +4,8 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **pid** | [**EudiPidCredential**](EudiPidCredential.md) | An EUDI Person Identification Data (PID) credential, retrieved from the individual&#39;s wallet. | [optional] |
+| **age_verification** | [**EudiAgeVerificationCredential**](EudiAgeVerificationCredential.md) | An EUDI Age Verification credential, retrieved from the individual&#39;s wallet. | [optional] |
 | **raw18013_output** | [**MdlOutput**](MdlOutput.md) | The raw output of the 18013-7 exchange performed through France Identité. |  |
 ## Example
@@ -12,6 +14,8 @@
 require 'trinsic_api'
 instance = TrinsicApi::FranceIdentiteProviderOutput.new(
+  pid: null,
+  age_verification: null,
   raw18013_output: null
 )
 ```

data/docs/FrejaProviderOutput.md CHANGED Viewed

@@ -20,7 +20,7 @@
 | **country** | **String** | The ISO 3166-1 alpha-2 country code associated with the individual&#39;s country of origin. | [optional] |
 | **document** | [**OutputFrejaDocument**](OutputFrejaDocument.md) | The underlying document, such as a passport, used to create the Freja credential. | [optional] |
 | **registration_level** | **String** | The Freja registration level associated with this individual. This can be BASIC, EXTENDED, or PLUS. * BASIC: Individual has a registered account with Freja. * EXTENDED: Individual has an official identity document verified by Freja. * PLUS: Individual has undergone in-person verification with Freja. | [optional] |
-| **relying_party_user_id** | **String** | The relying party user identifier for this individual. This is an identifier specific to the individual and the relying party (your service). | [optional] |
+| **relying_party_user_id** | **String** | The relying party identifier for this individual. This is an identifier specific to the individual and the relying party (your service). | [optional] |
 | **transaction_reference** | **String** | The Freja transaction reference for this verification. This is an identifier specific to the verification transaction. | [optional] |
 ## Example

data/docs/FrenchNumeriqueGivenName.md CHANGED Viewed

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

data/docs/FrenchNumeriqueProviderOutput.md CHANGED Viewed

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

data/docs/GoogleWalletIdPassCredential.md ADDED Viewed

@@ -0,0 +1,40 @@
+# TrinsicApi::GoogleWalletIdPassCredential
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **given_name** | **String** | First name(s), other name(s), or secondary identifier of the individual. | [optional] |
+| **family_name** | **String** | Last name, surname, or primary identifier of the individual. | [optional] |
+| **date_of_birth** | **Date** | The date of birth of the individual. | [optional] |
+| **issue_date** | **Date** | The date when the ID Pass was issued.              This is not the same as the issue date of the underlying physical passport used to create the ID Pass. | [optional] |
+| **expiry_date** | **Date** | The date when the ID Pass expires.              This is not necessarily the same as the expiration date of the underlying physical passport used to create the ID Pass. | [optional] |
+| **issuing_country** | **String** | Alpha-2 country code of the issuing authority&#39;s country or territory. | [optional] |
+| **issuing_authority** | **String** | Name or identifier of the mDL issuing authority.              This field&#39;s contents are arbitrary; it has no guaranteed format. | [optional] |
+| **nationality** | **String** | Nationality of the individual as an ISO 3166-1 alpha-2 country code. | [optional] |
+| **document_number** | **String** | The number of the underlying passport used to create the ID Pass. | [optional] |
+| **sex** | **Integer** | The individual&#39;s sex as an ISO/IEC 5218 code.              Possible values: - 0: Unknown - 1: Male - 2: Female - 9: Not Applicable | [optional] |
+| **age_over** | [**Array&lt;AgeOverOutput&gt;**](AgeOverOutput.md) | Processed age-over claims returned by the ID Pass. | [optional] |
+| **issue_date_of_underlying_document** | **Date** | Date when the underlying passport backing this digital credential was originally issued. | [optional] |
+## Example
+```ruby
+require 'trinsic_api'
+instance = TrinsicApi::GoogleWalletIdPassCredential.new(
+  given_name: JOHN,
+  family_name: DOE,
+  date_of_birth: Wed Jan 31 00:00:00 UTC 1990,
+  issue_date: Fri Jan 31 00:00:00 UTC 2020,
+  expiry_date: Thu Jan 31 00:00:00 UTC 2030,
+  issuing_country: US,
+  issuing_authority: US Department of State,
+  nationality: US,
+  document_number: P1234567,
+  sex: 1,
+  age_over: [{&quot;age&quot;:18,&quot;isOver&quot;:true},{&quot;age&quot;:21,&quot;isOver&quot;:true}],
+  issue_date_of_underlying_document: Fri Jun 15 00:00:00 UTC 2018
+)
+```

data/docs/GoogleWalletInput.md CHANGED Viewed

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **exchange_mechanism** | [**MdlExchangeMechanism**](MdlExchangeMechanism.md) | The exchange mechanism to use for this Google Wallet verification.              Use &#x60;DigitalCredentialsApi&#x60; for Digital Credentials API on web, or &#x60;NativeApp&#x60; for a native Android app. | [optional] |
-| **preview_raw18013_request** | [**Raw18013RequestInput**](Raw18013RequestInput.md) | **Preview feature: not suitable for production use cases**              The raw 18013-7 exchange request to use for this verification.              If set, this overrides any default configuration on your Verification Profile. | [optional] |
+| **preview_raw18013_request** | [**Raw18013RequestInput**](Raw18013RequestInput.md) | **Preview feature: not suitable for production use cases**              The raw 18013-7 exchange request to use for this verification.              If set, this overrides any default configuration on your Verification Profile.              NOTE: This parameter has no effect in live mode for Google Wallet verifications. Dynamic requests are currently only supported in test mode for Google Wallet. | [optional] |
 ## Example

data/docs/GoogleWalletProviderOutput.md CHANGED Viewed

@@ -4,6 +4,8 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **mobile_drivers_license** | [**Iso180135MobileDriversLicenseCredential**](Iso180135MobileDriversLicenseCredential.md) | A standard 18013-5 Mobile Driver&#39;s License credential, retrieved from the individual&#39;s wallet. | [optional] |
+| **id_pass** | [**GoogleWalletIdPassCredential**](GoogleWalletIdPassCredential.md) | A Google Wallet ID Pass credential (&#x60;com.google.wallet.idcard.1&#x60;), retrieved from the individual&#39;s wallet. | [optional] |
 | **raw_mdl_output** | [**MdlOutput**](MdlOutput.md) | The raw output of the mDL exchange performed through Google Wallet. |  |
 ## Example
@@ -12,6 +14,8 @@
 require 'trinsic_api'
 instance = TrinsicApi::GoogleWalletProviderOutput.new(
+  mobile_drivers_license: null,
+  id_pass: null,
   raw_mdl_output: null
 )
 ```

data/docs/GuatemalaCuiLookupInput.md ADDED Viewed

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

data/docs/GuatemalaCuiProviderOutput.md ADDED Viewed

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

data/docs/IndiaPanLookupInput.md ADDED Viewed

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

data/docs/IndiaPanLookupProviderOutput.md ADDED Viewed

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

data/docs/IndiaPanStructuredNumber.md ADDED Viewed

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

data/docs/Iso180132BiometricDataBlockProduct.md ADDED Viewed

@@ -0,0 +1,20 @@
+# TrinsicApi::Iso180132BiometricDataBlockProduct
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **product_owner** | **Integer** | Identifier of the product owner. |  |
+| **product_type** | **Integer** | Identifier of the product type. |  |
+## Example
+```ruby
+require 'trinsic_api'
+instance = TrinsicApi::Iso180132BiometricDataBlockProduct.new(
+  product_owner: 4660,
+  product_type: 22136
+)
+```

data/docs/Iso180132BiometricGroupTemplate.md ADDED Viewed

@@ -0,0 +1,18 @@
+# TrinsicApi::Iso180132BiometricGroupTemplate
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **templates** | [**Array&lt;Iso180132BiometricTemplate&gt;**](Iso180132BiometricTemplate.md) | Individual biometric templates contained in this group. |  |
+## Example
+```ruby
+require 'trinsic_api'
+instance = TrinsicApi::Iso180132BiometricGroupTemplate.new(
+  templates: []
+)
+```

data/docs/Iso180132BiometricTemplate.md ADDED Viewed

@@ -0,0 +1,24 @@
+# TrinsicApi::Iso180132BiometricTemplate
+## Properties
+| 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 &#x60;face&#x60; and &#x60;signature_usual_mark&#x60;, 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. |  |
+| **biometric_information_record_payload** | **String** | Optional Biometric Information Record payload, containing arbitrary domestic data. | [optional] |
+## Example
+```ruby
+require 'trinsic_api'
+instance = TrinsicApi::Iso180132BiometricTemplate.new(
+  header: null,
+  data_block: null,
+  data_is_encrypted: false,
+  biometric_information_record_payload: null
+)
+```

data/docs/Iso180132BiometricTemplateHeader.md ADDED Viewed

@@ -0,0 +1,36 @@
+# TrinsicApi::Iso180132BiometricTemplateHeader
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **patron_header_version** | **Integer** | Patron header version (defaults to 0x0101). |  |
+| **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_information_record_index** | **String** | Index identifier of the Biometric Information Record, when present. | [optional] |
+## Example
+```ruby
+require 'trinsic_api'
+instance = TrinsicApi::Iso180132BiometricTemplateHeader.new(
+  patron_header_version: 257,
+  biometric_type: 2,
+  biometric_sub_type: 1,
+  creation_date: 2020-01-31T12:34:56Z,
+  biometric_information_record_creator: BiometricVendor,
+  validity_period: null,
+  biometric_data_block_product: null,
+  biometric_data_block_format_owner: 257,
+  biometric_data_block_format_type: 8,
+  biometric_information_record_index: idx-1
+)
+```

data/docs/Iso180132BiometricValidityPeriod.md ADDED Viewed

@@ -0,0 +1,20 @@
+# TrinsicApi::Iso180132BiometricValidityPeriod
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **not_before** | **Date** | Date the biometric data block becomes valid. |  |
+| **not_after** | **Date** | Date the biometric data block expires. |  |
+## Example
+```ruby
+require 'trinsic_api'
+instance = TrinsicApi::Iso180132BiometricValidityPeriod.new(
+  not_before: Fri Jan 31 00:00:00 UTC 2020,
+  not_after: Thu Jan 31 00:00:00 UTC 2030
+)
+```

data/docs/Iso180135AamvaDomesticDrivingPrivilege.md ADDED Viewed

@@ -0,0 +1,22 @@
+# TrinsicApi::Iso180135AamvaDomesticDrivingPrivilege
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **vehicle_class** | [**Iso180135AamvaDomesticVehicleClass**](Iso180135AamvaDomesticVehicleClass.md) | Vehicle class describing the category of vehicle the holder is authorized to operate. | [optional] |
+| **vehicle_restrictions** | [**Array&lt;Iso180135AamvaDomesticVehicleRestriction&gt;**](Iso180135AamvaDomesticVehicleRestriction.md) | Restrictions attached to this domestic driving privilege. | [optional] |
+| **vehicle_endorsements** | [**Array&lt;Iso180135AamvaDomesticVehicleEndorsement&gt;**](Iso180135AamvaDomesticVehicleEndorsement.md) | Endorsements attached to this domestic driving privilege. | [optional] |
+## Example
+```ruby
+require 'trinsic_api'
+instance = TrinsicApi::Iso180135AamvaDomesticDrivingPrivilege.new(
+  vehicle_class: null,
+  vehicle_restrictions: [{&quot;code&quot;:&quot;B&quot;,&quot;description&quot;:&quot;Corrective Lenses&quot;}],
+  vehicle_endorsements: [{&quot;code&quot;:&quot;H&quot;,&quot;description&quot;:&quot;Hazardous Materials&quot;}]
+)
+```