trinsic_api 3.0.1 → 3.1.0.pre.preview1

data/docs/KoreaTelcoMatchProviderOutput.md

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

data/docs/KoreaTelcoMatchSex.md

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

data/docs/LloydsSmartIdProviderOutput.md

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

data/docs/MdlOutput.md

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

data/docs/MitIdProviderOutput.md

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

data/docs/MobileCarrier.md

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

data/docs/MobileOperatingSystem.md

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

data/docs/NetherlandsIdinAddress.md

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

data/docs/NetherlandsIdinProviderOutput.md

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

data/docs/NigeriaNinLookup2ProviderOutput.md

@@ -0,0 +1,40 @@
+# TrinsicApi::NigeriaNinLookup2ProviderOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **first_name** | **String** | The first name (given name) of the ID holder. |  |
+| **middle_name** | **String** | The middle name of the ID holder. | [optional] |
+| **surname** | **String** | The surname (family name) of the ID holder. |  |
+| **sex** | **String** | The sex of the ID holder.              Possible values: - Male - Female | [optional] |
+| **date_of_birth** | **Date** | The date of birth of the ID holder. | [optional] |
+| **birth_country** | **String** | Country of birth as an ISO 3166-1 alpha-2 code. | [optional] |
+| **national_identity_number** | **String** | National Identification Number (NIN).              This is a unique, permanent identifier assigned by the National Identity Management Commission upon enrollment.              Format: 11 numeric digits (regex: /^[0-9]{11}$/). The digits are validated using the Verhoeff algorithm, meaning the last digit serves as a check digit. |  |
+| **phone_number** | **String** | Phone number registered with the National Identity Management Commission. | [optional] |
+| **email** | **String** | Email address registered with the National Identity Management Commission. | [optional] |
+| **address** | **String** | Full residential address as a single string, normalized to lowercase without delimiters. | [optional] |
+| **local_government_area** | **String** | Local Government Area of residence.              Nigeria is divided into 774 Local Government Areas (LGAs), which are the third-tier administrative divisions below states and the Federal Capital Territory. LGAs are roughly equivalent to counties or municipalities in other countries. | [optional] |
+| **state** | **String** | State of residence. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::NigeriaNinLookup2ProviderOutput.new(
+  first_name: MUSA,
+  middle_name: IBRAHIM,
+  surname: MOHAMMED,
+  sex: Male,
+  date_of_birth: Wed Jan 31 00:00:00 UTC 1990,
+  birth_country: NG,
+  national_identity_number: 12345678901,
+  phone_number: +2340123456789,
+  email: user@example.com,
+  address: 816 ahmadu bello way central business district abuja,
+  local_government_area: Abuja Municipal,
+  state: Federal Capital Territory
+)
+```
+

data/docs/NorwegianBankIdProviderOutput.md

@@ -0,0 +1,32 @@
+# TrinsicApi::NorwegianBankIdProviderOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **full_name** | **String** | The full name of the individual. | [optional] |
+| **date_of_birth** | **Date** | The date of birth of the individual. | [optional] |
+| **personal_identifier** | **String** | The personal identifier for Norwegian BankID.              This uniquely identifies the individual in the Norwegian BankID system and is considered a stable identifier to use. | [optional] |
+| **national_identity_number** | **String** | The 11-digit Norwegian National Identity Number (fødselsnummer) of the verified individual.              This is in the format DDMMYYZZZCC, where: - DDMMYY is the date of birth (In some cases, this is not the date of birth due to no available identity numbers for some dates - ZZZ is an individual number, indicating gender - CC is a checksum character              If ZZZ is even, the individual is female. If ZZZ is odd, the individual is male. | [optional] |
+| **given_name** | **String** | The given name of the individual. | [optional] |
+| **family_name** | **String** | The family name of the individual. | [optional] |
+| **level_of_assurance** | **String** | The level of assurance (LOA) for the verification.              The LOA refers to the degree of confidence in the claimed identity of a person. The European Digital Identity Framework (EUDI) measures the confidence of the digital identity's verification and authentication strength by a set of requirements for different levels. To learn more, see: https://ec.europa.eu/digital-building-blocks/sites/spaces/DIGITAL/pages/467110081/eIDAS+Levels+of+Assurance              Possible values: - Low: The individual has self asserted their identity and multifactor authentication is not required. - Substantial: The individual has performed either a remote or in-person identity verification and multifactor authentication is required. - High: The individual has performed an in-person identity proofing with an authorized representative and has strong cryptographic authentication requirements such as using a smart card. | [optional] |
+| **authentication_method** | **String** | The authentication method used by the individual.              Possible values: - urn:bankid:bis - BankID with Biometrics - urn:bankid:bid - Standard BankID with High Assurance | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::NorwegianBankIdProviderOutput.new(
+  full_name: Ove Henriksen,
+  date_of_birth: Sun Aug 15 00:00:00 UTC 1943,
+  personal_identifier: 9578-5999-4-1765512,
+  national_identity_number: 30069012345,
+  given_name: Ole,
+  family_name: Olsen,
+  level_of_assurance: High,
+  authentication_method: urn:bankid:bis
+)
+```
+

data/docs/OneIdProviderAddress.md

@@ -0,0 +1,26 @@
+# TrinsicApi::OneIdProviderAddress
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **street_address** | **String** | The line or street portion of the address. | [optional] |
+| **locality** | **String** | The locality or city portion of the address. | [optional] |
+| **region** | **String** | The region or subdivision portion of the address. | [optional] |
+| **postal_code** | **String** | The postal code of the address. | [optional] |
+| **country_code** | **String** | The alpha-2 country code of the address. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::OneIdProviderAddress.new(
+  street_address: 80 Temple Way, Winterton-On-Sea,
+  locality: Great Yarmouth,
+  region: Norfolk,
+  postal_code: NR29 9QS,
+  country_code: GB
+)
+```
+

data/docs/OneIdProviderOutput.md

@@ -0,0 +1,28 @@
+# TrinsicApi::OneIdProviderOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **sub** | **String** | The OpenID Connect (OIDC) subject identifier (sub). | [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] |
+| **birthdate** | **Date** | The date of birth of the individual. | [optional] |
+| **address** | [**OneIdProviderAddress**](OneIdProviderAddress.md) | The address of the individual. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::OneIdProviderOutput.new(
+  sub: 458924ee-f856-59ad-ae9f-6de2429a3c74,
+  full_name: John Smith,
+  given_name: John,
+  family_name: Smith,
+  birthdate: Thu Jan 31 00:00:00 UTC 1985,
+  address: null
+)
+```
+

data/docs/OutputFrejaAddress.md

@@ -0,0 +1,24 @@
+# TrinsicApi::OutputFrejaAddress
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **line1** | **String** | The line1 portion of the address. Incorporates all address details that are not included by city, postal code, and country. | [optional] |
+| **city** | **String** | The name of the city associated with the address. | [optional] |
+| **postal_code** | **String** | The postal code associated with the address. | [optional] |
+| **country** | **String** | The ISO 3166-1 alpha-2 country code associated with the address. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::OutputFrejaAddress.new(
+  line1: 123 Residential St,
+  city: New York,
+  postal_code: 12345,
+  country: SE
+)
+```
+

data/docs/OutputFrejaDocument.md

@@ -0,0 +1,24 @@
+# TrinsicApi::OutputFrejaDocument
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | Type of document. Possible values are: * \"PASS\": Passport * \"DRILIC\": Driver's License * \"NATID\": National ID * \"IDSIS\": SiS certified ID document * \"TAXID\": Tax Agency ID card * \"OTHERID\": Other IDs | [optional] |
+| **serial_number** | **String** | The document serial number. The structure of this number depends on the type and nationality of the document. | [optional] |
+| **expiration_date** | **Date** | Expiration date of the document. Formatted as an ISO 8601 Date. | [optional] |
+| **country** | **String** | The ISO 3166-1 alpha-2 country code associated with the document. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::OutputFrejaDocument.new(
+  type: PASS,
+  serial_number: SA1234567890,
+  expiration_date: Sun Dec 31 00:00:00 UTC 2028,
+  country: SE
+)
+```
+

data/docs/PanamaCedulaLookupInput.md

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

data/docs/PanamaCedulaProviderOutput.md

@@ -0,0 +1,32 @@
+# TrinsicApi::PanamaCedulaProviderOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **full_name** | **String** | Full name from Tribunal Electoral records. |  |
+| **given_name** | **String** | Given name(s) from Tribunal Electoral records. |  |
+| **family_name** | **String** | Family name(s) from Tribunal Electoral records. |  |
+| **date_of_birth** | **Date** | Verified date of birth from Tribunal Electoral records. | [optional] |
+| **document_number** | **String** | The matched personal identity cédula (Cédula de Identidad Personal) number from Tribunal Electoral records.              On output, Trinsic applies the same normalization as for lookup input. Structure is always {firstSegment}-{libro}-{tomo}: libro is one to four digits and tomo is one to six digits, separated by hyphens.              Citizen category and format: - Born in Panama format: {province}-{libro}-{tomo} ({province} is official code 1 through 13). Examples   8-1234-12345, 4-56-789, 12-12-12345. - Panamanian born abroad format: PE-{libro}-{tomo}. Example PE-1234-12345. - Foreign national with cédula format: E-{libro}-{tomo}. Examples E-1234-12345, E-8-102017. - Naturalized citizen format: N-{libro}-{tomo}. Example N-1234-12345. - Pre-2006 civil registry (AV) format: {province}AV-{libro}-{tomo}. Example 10AV-1234-12345. - Indigenous (PI) format: {province}PI-{libro}-{tomo}. Example 1PI-1234-12345. |  |
+| **nationality_or_residence_type** | **String** | Inferred from DocumentNumber. Values are nationality or residence category.              Possible values: - BornInPanama - ForeignNational - BornAbroad - Naturalized - LegacyNumber - Indigenous - Unknown (we were unable to determine the category) |  |
+| **subdivision_of_origin** | **String** | ISO 3166-2 principal subdivision code. Only available for BornInPanama, LegacyNumber, and Indigenous.              Possible values, matching cédula province digits 1–13: 1. PA-1 - Bocas del Toro 2. PA-2 - Coclé 3. PA-3 - Colón 4. PA-4 - Chiriquí 5. PA-5 - Darién 6. PA-6 - Herrera 7. PA-7 - Los Santos 8. PA-8 - Panamá 9. PA-9 - Veraguas 10. PA-KY - Guna Yala 11. PA-EM - Emberá 12. PA-NB - Ngäbe-Buglé 13. PA-10 - Panamá Oeste | [optional] |
+| **subdivision_of_origin_name** | **String** | Subdivision display name from the ISO 3166-2 registry, when available. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::PanamaCedulaProviderOutput.new(
+  full_name: Juan Pérez,
+  given_name: Juan,
+  family_name: Pérez,
+  date_of_birth: Mon Mar 02 00:00:00 UTC 1992,
+  document_number: 8-1234-12345,
+  nationality_or_residence_type: BornInPanama,
+  subdivision_of_origin: PA-8,
+  subdivision_of_origin_name: Panamá
+)
+```
+

data/docs/PeruDniProviderOutput.md

@@ -8,7 +8,7 @@
 | **array_name** | **Array<String>** | All names that appear on DNI, as an array of strings.              Format: - All uppercase - Ordered by paternal family name, then maternal family name, then given names. |  |
 | **civil_status** | **String** | Marital status as it appears on the DNI.              This field is not always available.              Valid values: - \"Single\" - \"Married\" - \"Divorced\" - \"Widowed\" | [optional] |
 | **date_of_birth** | **Date** | Date of birth as it appears on the DNI.              This field is not always available. | [optional] |
-| **document_number** | **String** | The user's National Identity Document number (Documento Nacional de Identidad or DNI).              Format: - 8 digits - Does NOT include verification digit. On the DNI card, a ninth digit appears next to the first eight. It is   0-9 or A-K. This is NOT included in the DNI number when returned from Peru's database. - Does NOT include dots or hyphens |  |
+| **document_number** | **String** | The individual's National Identity Document number (Documento Nacional de Identidad or DNI).              Format: - 8 digits - Does NOT include verification digit. On the DNI card, a ninth digit appears next to the first eight. It is   0-9 or A-K. This is NOT included in the DNI number when returned from Peru's database. - Does NOT include dots or hyphens |  |
 | **document_type** | **String** | Should always be \"DNI\". |  |
 | **expedition_date** | **Date** | Date that the DNI was issued.              This field is not always available.              Format: - yyyy-MM-dd | [optional] |
 | **expiration_date** | **Date** | Date that the DNI will expire. DNI expires every 8 years, unless the citizen is >= 60 years old, in which case it never expires.              This field is not always available.              Format: - yyyy-MM-dd | [optional] |

data/docs/PhilippinesDigitalNidProviderOutput.md

@@ -5,6 +5,16 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **philsys_card_number** | **String** | The PhilSys Card Number (PCN). Every citizen or resident alien registered in PhilSys has a PhilSys Number (PSN). This number is tokenized into a card number to protect the PSN. The PhilSys Card Number is 12 characters long, and often is written in octets with dashes in between. |  |
+| **given_name** | **String** | The given (first) name of the individual. | [optional] |
+| **middle_name** | **String** | The middle name of the individual. | [optional] |
+| **family_name** | **String** | The family (last) name of the individual. | [optional] |
+| **date_of_birth** | **Date** | The date of birth of the individual. | [optional] |
+| **suffix** | **String** | The name suffix of the individual (e.g. Jr., III). | [optional] |
+| **sex** | **String** | The sex of the individual.              Possible values: - Male - Female | [optional] |
+| **place_of_birth** | **String** | The place of birth of the individual as recorded on the PhilSys credential. | [optional] |
+| **document_issue_date** | **Date** | The date the document was issued. | [optional] |
+| **document_number** | **String** | The document number of the digital National ID. | [optional] |
+| **issuing_authority** | **String** | The issuing authority of the document. | [optional] |
 
 ## Example
 
@@ -12,7 +22,17 @@
 require 'trinsic_api'
 
 instance = TrinsicApi::PhilippinesDigitalNidProviderOutput.new(
-  philsys_card_number: 1234-5678-9101-1213
+  philsys_card_number: 1234-5678-9101-1213,
+  given_name: Juan,
+  middle_name: Santos,
+  family_name: Dela Cruz,
+  date_of_birth: Thu Jan 31 00:00:00 UTC 1985,
+  suffix: Jr.,
+  sex: Male,
+  place_of_birth: Manila,
+  document_issue_date: Fri Mar 15 00:00:00 UTC 2024,
+  document_number: 12345678901234,
+  issuing_authority: Philippine Statistics Authority
 )
 ```
 

data/docs/PhilippinesPhysicalNidProviderOutput.md

@@ -5,6 +5,14 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **philsys_card_number** | **String** | The PhilSys Card Number (PCN). Every citizen or resident alien registered in PhilSys has a PhilSys Number (PSN). This number is tokenized into a card number to protect the PSN. The PhilSys Card Number is 12 characters long, and often is written in octets with dashes in between. |  |
+| **given_name** | **String** | The given (first) name of the individual. | [optional] |
+| **middle_name** | **String** | The middle name of the individual. | [optional] |
+| **family_name** | **String** | The family (last) name of the individual. | [optional] |
+| **date_of_birth** | **Date** | The date of birth of the individual. | [optional] |
+| **suffix** | **String** | The name suffix of the individual (e.g. Jr., III). | [optional] |
+| **sex** | **String** | The sex of the individual.              Possible values: - Male - Female | [optional] |
+| **place_of_birth** | **String** | The place of birth of the individual as recorded on the PhilSys credential. | [optional] |
+| **document_issue_date** | **Date** | The date the document was issued. | [optional] |
 
 ## Example
 
@@ -12,7 +20,15 @@
 require 'trinsic_api'
 
 instance = TrinsicApi::PhilippinesPhysicalNidProviderOutput.new(
-  philsys_card_number: 1234-5678-9101-1213
+  philsys_card_number: 1234-5678-9101-1213,
+  given_name: Juan,
+  middle_name: Santos,
+  family_name: Dela Cruz,
+  date_of_birth: Thu Jan 31 00:00:00 UTC 1985,
+  suffix: Jr.,
+  sex: Male,
+  place_of_birth: Manila,
+  document_issue_date: Fri Mar 15 00:00:00 UTC 2024
 )
 ```
 

data/docs/PolandMobywatelMatchInput.md

@@ -0,0 +1,32 @@
+# TrinsicApi::PolandMobywatelMatchInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **given_name** | **String** | Given name as it appears on mobile ID (mDowód). | [optional] |
+| **family_name** | **String** | Current legal family name (nazwisko) as it appears on mobile ID (mDowód).              In Poland the current legal family name (nazwisko) is a separate idea from your birth family name (nazwisko rodowe). They often match, but they can differ after marriage, adoption, or a court-ordered change. | [optional] |
+| **date_of_birth** | **String** | Date of birth as it appears on mobile ID (mDowód). | [optional] |
+| **nationality** | **String** | Nationality as it appears on mobile ID (mDowód). | [optional] |
+| **personal_number** | **String** | Polish national identification number (PESEL) as it appears on mobile ID (mDowód).              NOTE: The provided example value is a randomly generated, but valid PESEL number that does not correspond to a real person. | [optional] |
+| **expiration_date** | **String** | Document expiration date as it appears on mobile ID (mDowód). | [optional] |
+| **selfie_bytes** | **String** | The raw bytes of the selfie image collected from the user. | [optional] |
+| **selfie_image_mime_type** | **String** | The MIME Type of the file contained in SelfieBytes.              Only JPEG or PNG formats are supported. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::PolandMobywatelMatchInput.new(
+  given_name: Jan,
+  family_name: Kowalski,
+  date_of_birth: 1980-10-20,
+  nationality: PL,
+  personal_number: 80102005992,
+  expiration_date: 2030-12-31,
+  selfie_bytes: null,
+  selfie_image_mime_type: null
+)
+```
+

data/docs/PolandMobywatelMatchProviderOutput.md

@@ -0,0 +1,56 @@
+# TrinsicApi::PolandMobywatelMatchProviderOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **given_name** | **String** | Given name as provided by the individual. | [optional] |
+| **family_name** | **String** | Current legal family name (nazwisko) as provided by the individual.              In Poland the current legal family name (nazwisko) is a separate concept from your birth family name (nazwisko rodowe). They often match, but they can differ after marriage, adoption, or a court-ordered change. | [optional] |
+| **nationality** | **String** | Nationality as provided by the individual. | [optional] |
+| **date_of_birth** | **Date** | Date of birth as provided by the individual. | [optional] |
+| **personal_number** | **String** | Personal number (PESEL) as provided by the individual. | [optional] |
+| **expiration_date** | **Date** | Expiration date as provided by the individual. | [optional] |
+| **is_match_for_given_names** | **Boolean** | True when the provided given name matches mObywatel wallet data. | [optional] |
+| **is_match_for_family_name** | **Boolean** | True when the provided family name matches mObywatel wallet data. | [optional] |
+| **is_match_for_expiration_date** | **Boolean** | True when the provided document expiration date matches mObywatel wallet data. | [optional] |
+| **is_match_for_personal_number** | **Boolean** | True when the provided personal number (PESEL) matches mObywatel wallet data. | [optional] |
+| **is_match_for_nationality** | **Boolean** | True when the provided nationality matches mObywatel wallet data. | [optional] |
+| **is_match_for_birth_date** | **Boolean** | True when the provided birth date matches mObywatel wallet data. | [optional] |
+| **is_match_for_selfie** | **Boolean** | True when the face in the provided selfie matches the face in the document photo in mObywatel wallet. | [optional] |
+| **is_not_too_similar_to_document_portrait** | **Boolean** | True when the uploaded face and wallet portrait are not suspiciously identical. Often fails when using a document photo as a selfie. | [optional] |
+| **is_not_different_face** | **Boolean** | True when no other person's face has been used to verify this document (good). False when another person's face has been used to verify this document (possible fraud). | [optional] |
+| **is_single_face** | **Boolean** | True when exactly one face was detected on the selfie image (good). False when multiple faces were detected on the selfie image (ambiguous result). | [optional] |
+| **is_over_age** | **Boolean** | True when the individual's age in digital wallet is over 18. | [optional] |
+| **is_age_estimation_match_for_selfie** | **Boolean** | True when the individual's age estimated from the selfie matches the individual's age in digital wallet. | [optional] |
+| **age_estimation_threshold** | **Integer** | Number of years allowed between the individual's age in digital wallet and the individual's age estimated from the selfie. | [optional] |
+| **estimated_age_from_selfie** | **Integer** | Estimated age from the selfie, if provided. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::PolandMobywatelMatchProviderOutput.new(
+  given_name: Jan,
+  family_name: Kowalski,
+  nationality: PL,
+  date_of_birth: Mon Oct 20 00:00:00 UTC 1980,
+  personal_number: 80102005992,
+  expiration_date: Tue Dec 31 00:00:00 UTC 2030,
+  is_match_for_given_names: true,
+  is_match_for_family_name: true,
+  is_match_for_expiration_date: true,
+  is_match_for_personal_number: true,
+  is_match_for_nationality: true,
+  is_match_for_birth_date: true,
+  is_match_for_selfie: true,
+  is_not_too_similar_to_document_portrait: true,
+  is_not_different_face: true,
+  is_single_face: true,
+  is_over_age: true,
+  is_age_estimation_match_for_selfie: true,
+  age_estimation_threshold: 4,
+  estimated_age_from_selfie: 35
+)
+```
+