trinsic_api 3.1.0.pre.preview1 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b03d53ed3421393c49e333ca021e708b032361bc3c37e4abcdc8328be9482bd
-  data.tar.gz: 2e603a14881093ba79814494660ed427f30cc61cf7e980f557d381da1479f565
+  metadata.gz: 6d826458b25907104dd986fb577be318d9587a235aa7ce0a5aedd8998e84e2d9
+  data.tar.gz: f9a00d6313d0b202429a50653f4ddcb099a055a5524b50feac8cae883dbef651
 SHA512:
-  metadata.gz: 7840c227b532d7450c8c271ba8af2f8f08c2bd4b36a9023379b8b1d0cd3b7ec9e81b86a389d04fa077caf05f45cdb3eeb42b64c4738786fdee0bfcf3d90b6b3a
-  data.tar.gz: ae7ba268795de19f3a1d6b36c1780fefb68210f65e8ba454b2a5c0bceb1f379cf6438c145ac8a4b5be162ff277f7462cce1cd2b3d1bbc6005f6a6791d409ddd0
+  metadata.gz: 292532e4f8a5ae07d2cf9d3f56867eeda0c730dfb8bc76a0273e41c99656b4e5e757d4b513a9532ce1bd0fa07cbd6547d560ae188bde5e8e769253e9fb471ee8
+  data.tar.gz: a4b21645120d6432ea39d210f8f6798c381ae4b1a8296e79f9a0b474b969eabc9bc14e030bd4f57fa3ee792b123b89a5fa29814d7103ec0f602ca0d1b57aa0b9

data/docs/AgeOverOutput.md

@@ -0,0 +1,20 @@
+# TrinsicApi::AgeOverOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **age** | **Integer** | The age threshold from the `age over X` claim. |  |
+| **is_over** | **Boolean** | Whether the individual is at least the given age. |  |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::AgeOverOutput.new(
+  age: 21,
+  is_over: true
+)
+```
+

data/docs/AppleWalletDigitalIdBirthDate.md

@@ -0,0 +1,20 @@
+# TrinsicApi::AppleWalletDigitalIdBirthDate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **date_of_birth** | **Date** | The encoded date of birth. |  |
+| **approximate_mask** | **String** | An 8-character mask of `1`s and `0`s, where a `1` indicates that the corresponding digit in the birth date (formatted as YYYYMMDD) is uncertain or unknown.              For example, a mask of \"00000011\" indicates that the day-of-month on which the individual was born is not certain. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::AppleWalletDigitalIdBirthDate.new(
+  date_of_birth: Wed Jan 31 00:00:00 UTC 1990,
+  approximate_mask: 00000011
+)
+```
+

data/docs/AppleWalletDigitalIdCredential.md

@@ -0,0 +1,54 @@
+# TrinsicApi::AppleWalletDigitalIdCredential
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **given_name_unicode** | **String** | First name(s), other name(s), or secondary identifier of the individual.              This field uses the full UTF-8 character set and can represent any name. | [optional] |
+| **given_name_latin1** | **String** | First name(s), other name(s), or secondary identifier of the individual.              This field uses the Latin-1 character set and is limited to names represented by the English alphabet. represented using the English alphabet. | [optional] |
+| **family_name_unicode** | **String** | Last name, surname, or primary identifier of the individual.              This field uses the full UTF-8 character set and can represent any name. | [optional] |
+| **family_name_latin1** | **String** | Last name, surname, or primary identifier of the individual.              This field uses only the Latin-1 character set and is largely limited to names which can be represented using the English alphabet. | [optional] |
+| **sex** | **Integer** | The individual's sex as an ISO/IEC 5218 code.              Possible values: - 0: Unknown - 1: Male - 2: Female - 9: Not Applicable | [optional] |
+| **date_of_birth** | [**AppleWalletDigitalIdBirthDate**](AppleWalletDigitalIdBirthDate.md) | The date of birth of the individual, possibly with an \"approximate mask\" indicating uncertain digits. | [optional] |
+| **document_number** | **String** | The document number of the underlying passport used to create the Digital ID. | [optional] |
+| **issuing_authority_unicode** | **String** | Name or identifier of the issuing authority of the credential, using the full UTF-8 character set.              This field's contents are arbitrary; it has no guaranteed format. | [optional] |
+| **issuing_subdivision** | **String** | ISO 3166-2 country-subdivision code for the jurisdiction that issued the credential. | [optional] |
+| **issuing_country** | **String** | ISO 3166-1 alpha-2 country code of the issuing authority's country or territory. | [optional] |
+| **issue_date** | **Date** | Date when the underlying passport used to create the Digital ID was issued. | [optional] |
+| **expiry_date** | **Date** | Date when the underlying passport used to create the Digital ID expires. | [optional] |
+| **age_in_years** | **Integer** | The age of the individual, as of the issuance date of the credential. | [optional] |
+| **age_over** | [**Array<AgeOverOutput>**](AgeOverOutput.md) | Processed age-over claims returned by the credential. | [optional] |
+| **resident_address_unicode** | **String** | The permanent address of the individual, using the full UTF-8 character set.              This is only present if the underlying passport contained an address, which is uncommon. | [optional] |
+| **resident_city_unicode** | **String** | City of the individual's permanent address, using the full UTF-8 character set.              This is only present if the underlying passport contained an address, which is uncommon. | [optional] |
+| **resident_city_latin1** | **String** | City of the individual's permanent address, using the Latin-1 character set.              This is only present if the underlying passport contained an address, which is uncommon. | [optional] |
+| **resident_postal_code** | **String** | Postal code of the individual's permanent address.              This is only present if the underlying passport contained an address, which is uncommon. | [optional] |
+| **resident_country** | **String** | ISO 3166-1 alpha-2 country code of the individual's permanent address.              This is only present if the underlying passport contained an address, which is uncommon. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::AppleWalletDigitalIdCredential.new(
+  given_name_unicode: JOHN,
+  given_name_latin1: JOHN,
+  family_name_unicode: DOE,
+  family_name_latin1: DOE,
+  sex: 1,
+  date_of_birth: null,
+  document_number: P1234567,
+  issuing_authority_unicode: US Department of State,
+  issuing_subdivision: US-CA,
+  issuing_country: US,
+  issue_date: Fri Jun 15 00:00:00 UTC 2018,
+  expiry_date: Thu Jun 15 00:00:00 UTC 2028,
+  age_in_years: 35,
+  age_over: [{"age":18,"isOver":true},{"age":21,"isOver":true}],
+  resident_address_unicode: 1 INFINITE LOOP,
+  resident_city_unicode: CUPERTINO,
+  resident_city_latin1: CUPERTINO,
+  resident_postal_code: 95014,
+  resident_country: US
+)
+```
+

data/docs/AppleWalletProviderOutput.md

@@ -4,6 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **mobile_drivers_license** | [**Iso180135MobileDriversLicenseCredential**](Iso180135MobileDriversLicenseCredential.md) | A standard 18013-5 Mobile Driver's License credential, retrieved from the individual's wallet. | [optional] |
+| **digital_id** | [**AppleWalletDigitalIdCredential**](AppleWalletDigitalIdCredential.md) | An Apple Wallet Digital ID credential (`org.iso.23220.photoid.1`), retrieved from the individual's wallet. | [optional] |
 | **raw_mdl_output** | [**MdlOutput**](MdlOutput.md) | The raw output of the mDL exchange performed through Apple Wallet. |  |
 
 ## Example
@@ -12,6 +14,8 @@
 require 'trinsic_api'
 
 instance = TrinsicApi::AppleWalletProviderOutput.new(
+  mobile_drivers_license: null,
+  digital_id: null,
   raw_mdl_output: null
 )
 ```

data/docs/BrazilCnhFacialBiometryOutput.md

@@ -0,0 +1,24 @@
+# TrinsicApi::BrazilCnhFacialBiometryOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **database_face_available** | **Boolean** | Whether the government database had facial biometrics available for comparison. |  |
+| **probability** | **String** | Probability bucket returned by Serpro for the facial biometric comparison.              Known values: - VeryLow - Low - High - VeryHigh | [optional] |
+| **similarity_score** | **Float** | Similarity score returned by Serpro for the facial biometric comparison.              Ranges from 0.0 to 1.0, where 1.0 is a perfect match. | [optional] |
+| **liveness** | **String** | Liveness result returned by Serpro when liveness is part of the validation response.              Known values: - BAD_QUALITY: The image quality was too low for liveness validation. - FAKE: Liveness validation detected a presentation attack or non-live face. - REAL: Liveness validation detected a live face. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::BrazilCnhFacialBiometryOutput.new(
+  database_face_available: true,
+  probability: VeryHigh,
+  similarity_score: 0.99,
+  liveness: REAL
+)
+```
+

data/docs/BrazilCnhMatchFieldDateOnly.md

@@ -0,0 +1,20 @@
+# TrinsicApi::BrazilCnhMatchFieldDateOnly
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **content** | **Date** | Decoded CNH QR Code value used for this match field. |  |
+| **match_value** | **Boolean** | Whether the decoded CNH QR Code value matched the government database. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::BrazilCnhMatchFieldDateOnly.new(
+  content: null,
+  match_value: true
+)
+```
+

data/docs/BrazilCnhMatchFieldString.md

@@ -0,0 +1,20 @@
+# TrinsicApi::BrazilCnhMatchFieldString
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **content** | **String** | Decoded CNH QR Code value used for this match field. | [optional] |
+| **match_value** | **Boolean** | Whether the decoded CNH QR Code value matched the government database. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::BrazilCnhMatchFieldString.new(
+  content: JOAO ALMEIDA SOUZA,
+  match_value: true
+)
+```
+

data/docs/BrazilCnhProviderOutput.md

@@ -0,0 +1,48 @@
+# TrinsicApi::BrazilCnhProviderOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **full_name** | [**BrazilCnhMatchFieldString**](BrazilCnhMatchFieldString.md) | Full name decoded from the CNH QR Code and whether it matched the government database. | [optional] |
+| **full_name_similarity** | **Float** | Similarity score for the decoded full name from the CNH QR Code.              Ranges from 0.0 to 1.0, where 1.0 is an exact match. | [optional] |
+| **origin_document** | **String** | Source identity document number/reference for the CNH record, decoded from the CNH QR Code. | [optional] |
+| **date_of_birth** | [**BrazilCnhMatchFieldDateOnly**](BrazilCnhMatchFieldDateOnly.md) | Date of birth decoded from the CNH QR Code and whether it matched the government database. | [optional] |
+| **mother_full_name** | **String** | Mother's full name decoded from the CNH QR Code. | [optional] |
+| **father_full_name** | **String** | Father's full name decoded from the CNH QR Code. | [optional] |
+| **category** | **String** | Driver license category decoded from the CNH QR Code.              Known values: - A: Two- or three-wheeled motor vehicles, with or without a sidecar. - B: Motor vehicles outside category A up to 3,500 kg, with capacity for up to eight passengers besides the driver, and without articulation or trailer. - C: Category B vehicles and rigid cargo vehicles above 3,500 kg. - D: Category C vehicles and passenger vehicles with capacity above eight passengers besides the driver. - E: Category D vehicles, trailers, semi-trailers, and articulated buses. | [optional] |
+| **registration_number** | [**BrazilCnhMatchFieldString**](BrazilCnhMatchFieldString.md) | National Registry (Registro Nacional de Habilitacao) number decoded from the CNH QR Code and whether it matched the government database.              Is an 11-character ID with the format XXXXXXXXX@@: - XXXXXXXXX: Base characters. The value is unique to the driver for their lifetime. - @@: Security check digits | [optional] |
+| **registration_number_check_digits_valid** | **Boolean** | Whether the National Registry number satisfies the CNH modulo-11 check digit routine. | [optional] |
+| **first_issue_date** | **Date** | Date when the driver was first licensed, decoded from the CNH QR Code. | [optional] |
+| **observations** | **String** | CNH observations decoded from the QR Code.              May include EAR for paid driving activity and one or more restriction codes: - A: Corrective lenses required. - B: Hearing prosthesis required. - C: Left-side accelerator required. - D: Automatic transmission vehicle required. - E: Steering-wheel grip, handle, or knob required. - F: Power steering vehicle required. - G: Manual clutch, automated clutch, or automatic transmission vehicle required. - H: Hand accelerator and brake required. - I: Dashboard control adaptations to the steering wheel required. - J: Dashboard control adaptations for lower limbs or other body parts required. - K: Gear-shift lever extension and/or fixed height/depth compensation cushions required. - L: Pedal extensions and floor elevation and/or fixed height/depth compensation cushions required. - M: Motorcycle with adapted gear-shift pedal required. - N: Motorcycle with adapted rear-brake pedal required. - O: Motorcycle with adapted front-brake handle required. - P: Motorcycle with adapted clutch handle required. - Q: Motorcycle with sidecar or tricycle required. - R: Scooter with sidecar or tricycle required. - S: Motorcycle with automated gear shifting required. - T: Driving on highways and high-speed roads prohibited. - U: Driving after sunset prohibited. - V: Helmet with visor and unrestricted field of vision required. - X: Other restrictions. | [optional] |
+| **issue_city** | **String** | City where the CNH was issued, decoded from the QR Code. | [optional] |
+| **issue_state** | **String** | Brazilian state where the CNH was issued, decoded from the QR Code.              Format is a two-letter Brazilian state abbreviation when present. | [optional] |
+| **validation_number** | **String** | Numeric security validation code decoded from the CNH QR Code.              This is an 11-digit code generated from Departamento Estadual de Trânsito (State Traffic Department or DETRAN) owned data for each CNH and used to validate the document. The algorithm is proprietary, so no further information is available on this number. | [optional] |
+| **renach_number** | **String** | Registro Nacional de Condutores Habilitados (RENACH) form number decoded from the CNH QR Code.              Is an 11-character ID with the format FFXXXXXXXX@: - FF: The issuing federation unit abbreviation. It identifies the state where the driver was licensed or last had record changes. - XXXXXXXXX: Serial number - @: Modulo-11 security check digit | [optional] |
+| **facial_biometry** | [**BrazilCnhFacialBiometryOutput**](BrazilCnhFacialBiometryOutput.md) | Facial biometric comparison result if submitted and available. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::BrazilCnhProviderOutput.new(
+  full_name: null,
+  full_name_similarity: 0.98,
+  origin_document: SSP SP 123456789,
+  date_of_birth: null,
+  mother_full_name: MARIA ALMEIDA SOUZA,
+  father_full_name: JOSE CARLOS SOUZA,
+  category: B,
+  registration_number: null,
+  registration_number_check_digits_valid: true,
+  first_issue_date: Thu Aug 19 00:00:00 UTC 2010,
+  observations: EAR,
+  issue_city: SAO PAULO,
+  issue_state: SP,
+  validation_number: 12345678901,
+  renach_number: SP123456789,
+  facial_biometry: null
+)
+```
+

data/docs/CreateDirectProviderSessionRequest.md

@@ -9,7 +9,7 @@
 | **redirect_url** | **String** | The Redirect URL to which the user should be sent after the session is complete.              This field is required for providers which employ a redirect-based flow. | [optional] |
 | **capabilities** | [**Array<IntegrationCapability>**](IntegrationCapability.md) | The list of capabilities your integration supports. Capabilities are the core of Trinsic's whitelabel-with-optional-fallback offering.              Most capabilities align with either an `IntegrationLaunchMethod` or an `IntegrationCollectionMethod`. The exception being refresh content to support updating the content of the launch method.              For example, to support a basic redirect-based flow, you must include the `LaunchRedirect` and `CaptureRedirect` capabilities. To support a mobile deeplink / polling flow, you must include the `DeeplinkToMobile` and `PollForResults` capabilities.              If `FallbackToHostedUi` is `true`, Trinsic will automatically fall back to a Trinsic-hosted UI to cover any gaps in your integration's capabilities. If `FallbackToHostedUi` is `false`, gaps in your integration's capabilities will result in an error during Session creation.              Read more on how to integrate at <a href=\"https://docs.trinsic.id/docs/direct-provider-sessions\">the guide on Direct Provider Sessions</a> |  |
 | **fallback_to_hosted_ui** | **Boolean** | Whether the session should fall back to a Trinsic-hosted UI in certain instances.              Specifically, fallback will occur if any of the following are true: - You attempted to launch a provider which requires a capability you did not express support for     - In this case, Trinsic's hosted UI will perform the necessary capability - You attempted to launch a provider which requires input, and the input was either not provided or incomplete     - In this case, Trinsic's hosted UI will collect the necessary input from the user              If fallback occurs, the session's NextStep will always be LaunchBrowser, and the CollectionMethod will always be CaptureRedirect.              If this field is set to `true`, you must also: 1. Set the `RedirectUrl` field to a non-empty value 2. Include the `LaunchBrowser` and `CaptureRedirect` capabilities in the `Capabilities` field | [optional] |
-| **browser_languages** | **Array<String>** | Preferences for languages to show first if the session falls back to the Trinsic-hosted UI. If left empty, the Hosted UI defaults to the user's navigator languages. If no preferred language is available, the Hosted UI falls back to English. This only will be used if the session falls back to the Trinsic-hosted UI. | [optional] |
+| **browser_languages** | **Array<String>** | Preferences for languages to show first in supported provider launch flows and, if the session falls back, in the Trinsic-hosted UI. If left empty, the Hosted UI defaults to the user's navigator languages. If no preferred language is available, the Hosted UI falls back to English. | [optional] |
 | **provider_input** | [**ProviderInput**](ProviderInput.md) | Provider-specific input for those providers which require it. | [optional] |
 
 ## Example

data/docs/CreateHostedProviderSessionRequest.md

@@ -7,7 +7,7 @@
 | **provider** | **String** | The ID of the provider to launch |  |
 | **verification_profile_id** | **String** | The ID of the Verification Profile to use for this session. |  |
 | **redirect_url** | **String** | The Redirect URL to which the user should be sent after the session is complete. |  |
-| **browser_languages** | **Array<String>** | Preferences for languages to show first in the Hosted UI. If left empty, the Hosted UI defaults to the user's navigator languages. If no preferred language is available, the Hosted UI falls back to English. | [optional] |
+| **browser_languages** | **Array<String>** | Preferences for languages to show first in the Hosted UI and supported provider launch flows. If left empty, the Hosted UI defaults to the user's navigator languages. If no preferred language is available, the Hosted UI falls back to English. | [optional] |
 | **provider_input** | [**ProviderInput**](ProviderInput.md) | Provider-specific input for those providers which require it.   <b>Deprecated:</b> In the future, Hosted Provider Sessions will not accept input on creation, and will instead always redirect the user to a hosted interface to collect input. If you need to collect input from the user yourself, please use the Create Direct Session endpoint instead. | [optional] |
 
 ## Example

data/docs/CzechBankIdAddress.md

@@ -0,0 +1,36 @@
+# TrinsicApi::CzechBankIdAddress
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | The address type.              Possible values are: - PERMANENT_RESIDENCE - SECONDARY_RESIDENCE - UNKNOWN | [optional] |
+| **street** | **String** | The street name.              This is usually present, but unused for small villages. | [optional] |
+| **building_apartment** | **String** | The address land registry number.              This is usually present, but unused for small houses. | [optional] |
+| **street_number** | **String** | The additional address house number.              This is usually present, but unused for small villages. | [optional] |
+| **evidence_number** | **String** | The house evidence number.              This is rarely used in suburbs. An evidence number is used for addresses that are residential, temporary or non-residential buildings, e.g. cabins, garages etc. | [optional] |
+| **city** | **String** | The city name. |  |
+| **city_area** | **String** | The city area name.              This is usually present. | [optional] |
+| **zipcode** | **String** | The zip of the address. |  |
+| **country** | **String** | The country code in ISO 3166-1 alpha-2 format. |  |
+| **ruian_reference** | **String** | The address identifier in the Czech RUIAN address register.              RUIAN is the Czech Register of Territorial Identification, Addresses, and Real Estate. This value identifies the address record in that register and can be used to reconcile the address against Czech government address data. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::CzechBankIdAddress.new(
+  type: PERMANENT_RESIDENCE,
+  street: Novodvorska,
+  building_apartment: 13,
+  street_number: 1491,
+  evidence_number: 11a,
+  city: Plzen,
+  city_area: Pankrac,
+  zipcode: 10200,
+  country: CZ,
+  ruian_reference: 144560291
+)
+```
+

data/docs/CzechBankIdCard.md

@@ -0,0 +1,30 @@
+# TrinsicApi::CzechBankIdCard
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | The identity document type code.              Possible values are:              - ID - Identity card - P - Passport - DL - Driving license - IR - Residence permit - VS - Visa permit label - PS - Residential label - IX - Book with residence permit - IE - Form with temporary residence - OP - Identity card – without machine readable zone - CA - Passport of the Czech Republic resident – without machine readable zone - UNKNOWN - Unknown id card type |  |
+| **description** | **String** | The localized identity document type description. | [optional] |
+| **country** | **String** | The country for which the identity document is valid. |  |
+| **number** | **String** | The identity document number. |  |
+| **valid_to** | **Date** | The identity document expiration date. |  |
+| **issuer** | **String** | The office that issued the identity document. | [optional] |
+| **issue_date** | **Date** | The identity document issue date. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::CzechBankIdCard.new(
+  type: ID,
+  description: Identity card,
+  country: CZ,
+  number: 123456789,
+  valid_to: Tue Dec 31 00:00:00 UTC 2030,
+  issuer: Mesto Praha,
+  issue_date: Wed Jan 15 00:00:00 UTC 2020
+)
+```
+

data/docs/CzechBankIdProviderOutput.md

@@ -0,0 +1,78 @@
+# TrinsicApi::CzechBankIdProviderOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **subject_identifier** | **String** | The subject identifier for the verified individual. |  |
+| **full_name** | **String** | The individual's full name. | [optional] |
+| **given_name** | **String** | The individual's given or first name. | [optional] |
+| **family_name** | **String** | The individual's family or last name. | [optional] |
+| **middle_name** | **String** | The individual's middle name. | [optional] |
+| **nickname** | **String** | Nickname used by a physical person              A casual name, not necessarily the legal given name. | [optional] |
+| **preferred_username** | **String** | The individual's preferred username.              The user has chosen this as the preferred name for logins. | [optional] |
+| **gender** | **String** | The individual's gender.              Possible values: - Male - Female - Other              Only returned for Identify verifications. | [optional] |
+| **date_of_birth** | **String** | The individual's date of birth.              This is a string because the value may have reduced precision, such as only a year. | [optional] |
+| **birth_number** | **String** | The individual's Czech birth number.              This value is written without the traditional forward slash. Czech birth numbers are Czech public-authority identifiers administered through the Ministry of Interior's birth-number register. The Ministry can assign one to Czech citizens and to foreign nationals with temporary or permanent residence in the Czech Republic. For foreign nationals, this is still a Czech birth number in the Czech format, not an identity number from another country.              The common current format is YYXXDDSSSC: - YY: Two digit birth year - XX: Encoded birth month, see below for encoding logic - DD: Birth day - SSS: Sequence number - C: Modulo-11 checksum digit. Not present for people born before 1954. The encoded month is MM for men, MM + 50 for women, and can be MM + 20 for men or MM + 70 for women when additional number ranges are needed. Older numbers for people born before 1954 can use YYXXDDSSS and do not use the modulo-11 checksum.              Only returned for Identify verifications. | [optional] |
+| **age** | **Integer** | The individual's age. | [optional] |
+| **is_adult** | **Boolean** | Whether the individual is an adult.              In the Czech Republic, legal majority (adulthood) is reached at 18 years old. Only returned for Identify Plus verifications. | [optional] |
+| **date_of_death** | **Date** | The individual's date of death, if available. | [optional] |
+| **birth_place** | **String** | The individual's place of birth.              Only returned for Identify Plus verifications. | [optional] |
+| **birth_country** | **String** | The individual's country of birth.              Only returned for Identify Plus verifications. | [optional] |
+| **primary_nationality** | **String** | The individual's primary nationality.              The value is an ISO 3166-1 alpha-2 country code. Only returned for Identify Plus verifications. | [optional] |
+| **nationalities** | **Array<String>** | The individual's nationalities. | [optional] |
+| **marital_status** | **String** | The individual's marital status.              Possible values: - COHABITATION - MARRIED - DIVORCED - REGISTERED_PARTNERSHIP - REGISTERED_PARTNERSHIP_CANCELED - WIDOWED - SINGLE - PARTNERSHIP - PARTNERSHIP_CANCELED - SEPARATED - REGISTERED_PARTNERSHIP_WIDOWED - LAPSED_MARRIAGE - UNKNOWN              Only returned for Identify Plus verifications. | [optional] |
+| **email** | **String** | The individual's email address. | [optional] |
+| **email_verified** | **Boolean** | Whether the individual's email address has been verified. | [optional] |
+| **phone_number** | **String** | The individual's phone number.              This value is normalized to E.164 format. | [optional] |
+| **phone_number_verified** | **Boolean** | Whether the individual's phone number has been verified. | [optional] |
+| **is_politically_exposed_person** | **Boolean** | Whether the individual is a politically exposed person.              This follows Czech anti-money-laundering rules, indicating a person that is at risk for corruption, bribery or money laundering activities. Mandatory screening of these individuals is required for compliance. Typically set for people such as the Prime Minister, ministers, etc. | [optional] |
+| **limited_legal_capacity** | **Boolean** | Whether the individual is a person with limited legal capacity. | [optional] |
+| **verification** | [**CzechBankIdVerification**](CzechBankIdVerification.md) | Metadata about how the identity information was verified for Anti Money Laundering scope.              Only returned for Identify AML verifications. | [optional] |
+| **addresses** | [**Array<CzechBankIdAddress>**](CzechBankIdAddress.md) | The individual's addresses.              This can include permanent residence and contact addresses. Only returned for Identify verifications. | [optional] |
+| **id_cards** | [**Array<CzechBankIdCard>**](CzechBankIdCard.md) | The individual's identity documents.              This can include document type, country, number, issuer, and validity dates. Only returned for Identify Plus verifications. | [optional] |
+| **updated_at** | **Time** | The UTC date and time when the identity data was last updated. | [optional] |
+| **zone_info** | **String** | The individual's time zone.              This is represented as a zoneinfo/IANA Time Zone Database value. | [optional] |
+| **locale** | **String** | The individual's locale.              This is represented as a BCP 47/RFC 5646 language tag. Some values may use an underscore separator, such as cs_CZ. | [optional] |
+| **titles** | [**Array<CzechBankIdTitle>**](CzechBankIdTitle.md) | The individual's title prefixes and suffixes.              Only returned for Identify verifications. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::CzechBankIdProviderOutput.new(
+  subject_identifier: 248289761001,
+  full_name: Jan Novak,
+  given_name: Jan,
+  family_name: Novak,
+  middle_name: Josef,
+  nickname: jana.stastna,
+  preferred_username: jan.novak,
+  gender: male,
+  date_of_birth: 1978-01-23,
+  birth_number: 7801234562,
+  age: 46,
+  is_adult: true,
+  date_of_death: Mon Jan 15 00:00:00 UTC 2024,
+  birth_place: Praha,
+  birth_country: CZ,
+  primary_nationality: CZ,
+  nationalities: ["CZ"],
+  marital_status: MARRIED,
+  email: jan.novak@example.cz,
+  email_verified: true,
+  phone_number: +420123456789,
+  phone_number_verified: true,
+  is_politically_exposed_person: false,
+  limited_legal_capacity: false,
+  verification: null,
+  addresses: [{"type":"PERMANENT_RESIDENCE","street":"Vaclavske namesti","buildingApartment":"12","streetNumber":"1","evidenceNumber":"123","city":"Praha","cityArea":"Praha 1","zipcode":"11000","country":"CZ","ruianReference":"21722384"}],
+  id_cards: [{"type":"ID","description":"Identity card","country":"CZ","number":"123456789","validTo":"2030-12-31","issuer":"Mesto Praha","issueDate":"2020-01-15"}],
+  updated_at: 2024-05-15T12:00Z,
+  zone_info: Europe/Prague,
+  locale: cs_CZ,
+  titles: [{"titlePrefix":"Ing.","titleSuffix":"Ph.D."}]
+)
+```
+

data/docs/CzechBankIdTitle.md

@@ -0,0 +1,20 @@
+# TrinsicApi::CzechBankIdTitle
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **title_prefix** | **String** | The title prefix before the individual's name. | [optional] |
+| **title_suffix** | **String** | The title suffix after the individual's name. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::CzechBankIdTitle.new(
+  title_prefix: Ing.,
+  title_suffix: Ph.D.
+)
+```
+

data/docs/CzechBankIdVerification.md

@@ -0,0 +1,22 @@
+# TrinsicApi::CzechBankIdVerification
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **trust_framework** | **String** | The trust framework used for the verification.              This identifies the anti-money-laundering framework used for identity verification. |  |
+| **time** | **Time** | The UTC date and time when the verification happened.              This value is normalized to UTC. | [optional] |
+| **verification_process** | **String** | The verification process identifier.              This identifies the bank that completed the physical identity verification process. |  |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::CzechBankIdVerification.new(
+  trust_framework: cz_aml,
+  time: 2024-05-15T12:00Z,
+  verification_process: 12345678
+)
+```
+

data/docs/DiiaIssuerOutput.md

@@ -0,0 +1,28 @@
+# TrinsicApi::DiiaIssuerOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **common_name** | **String** | Certificate issuer common name. | [optional] |
+| **organization** | **String** | Certificate issuer organization. | [optional] |
+| **country** | **String** | Issuer country code in ISO 3166-1 alpha-2 format. | [optional] |
+| **locality** | **String** | City or region where the issuer is located. | [optional] |
+| **serial_number** | **String** | Unique identifier assigned to the issuing certificate authority.              Typically formatted as \"{country}-{registration code}-{sequence}\". | [optional] |
+| **national_registration_number** | **String** | The organizationIdentifier attribute from the certificate Issuer Distinguished Name.              Ukrainian organization identifiers commonly use the ETSI format \"{identifier-type}{country-code}-{identifier}\".              Components: - identifier-type (3 chars): NTR (National Trade Register). - country-code (2 chars): ISO 3166-1 alpha-2 country code, typically UA. - identifier: The legal entity registration code.              For Diia.Signature, this is issuer metadata rather than a natural person's RNOKPP. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::DiiaIssuerOutput.new(
+  common_name: Administrator ITS CCA (CA TEST),
+  organization: SE "DIIA" (TEST),
+  country: UA,
+  locality: Kyiv,
+  serial_number: UA-43395033-2403,
+  national_registration_number: NTRUA-43395033
+)
+```
+

data/docs/DiiaProviderOutput.md

@@ -0,0 +1,20 @@
+# TrinsicApi::DiiaProviderOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **subject** | [**DiiaSubjectOutput**](DiiaSubjectOutput.md) | Diia.Signature user data. |  |
+| **issuer** | [**DiiaIssuerOutput**](DiiaIssuerOutput.md) | Diia.Signature issuer data. |  |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::DiiaProviderOutput.new(
+  subject: null,
+  issuer: null
+)
+```
+

data/docs/DiiaSubjectOutput.md

@@ -0,0 +1,26 @@
+# TrinsicApi::DiiaSubjectOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **common_name** | **String** | Full name. | [optional] |
+| **country** | **String** | Country code in ISO 3166-1 alpha-2 format. | [optional] |
+| **serial_number** | **String** | The SERIALNUMBER attribute from the certificate Subject Distinguished Name. This is not the X.509 certificate serial number field.              For Ukrainian natural person certificates this commonly uses the ETSI natural person semantics identifier format \"{identifier-type}{country-code}-{identifier}\".              Components: - identifier-type (3 chars): TIN (Tax Identification Number) for RNOKPP. - country-code (2 chars): ISO 3166-1 alpha-2 country code, typically UA. - identifier: RNOKPP, the Ukrainian individual taxpayer registration number. | [optional] |
+| **given_name** | **String** | Given name. | [optional] |
+| **surname** | **String** | Surname. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::DiiaSubjectOutput.new(
+  common_name: Diia Nadia,
+  country: UA,
+  serial_number: TINUA-1234567063,
+  given_name: Nadia,
+  surname: Diia
+)
+```
+

data/docs/EudiAgeVerificationCredential.md

@@ -0,0 +1,22 @@
+# TrinsicApi::EudiAgeVerificationCredential
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **age_over** | [**Array<AgeOverOutput>**](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: [{"age":18,"isOver":true},{"age":21,"isOver":true}],
+  expiry_date: Thu Jan 31 00:00:00 UTC 2030,
+  issuing_country: FR
+)
+```
+