trinsic_api 3.2.0 → 3.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d826458b25907104dd986fb577be318d9587a235aa7ce0a5aedd8998e84e2d9
-  data.tar.gz: f9a00d6313d0b202429a50653f4ddcb099a055a5524b50feac8cae883dbef651
+  metadata.gz: d5af7955eee93bf6017130ec8fffa2696756f7c374a698b717d84af160a28496
+  data.tar.gz: d73572425baf923faaad2028e7ab325d59f4b3412698cdbfa342220f1f92b6f9
 SHA512:
-  metadata.gz: 292532e4f8a5ae07d2cf9d3f56867eeda0c730dfb8bc76a0273e41c99656b4e5e757d4b513a9532ce1bd0fa07cbd6547d560ae188bde5e8e769253e9fb471ee8
-  data.tar.gz: a4b21645120d6432ea39d210f8f6798c381ae4b1a8296e79f9a0b474b969eabc9bc14e030bd4f57fa3ee792b123b89a5fa29814d7103ec0f602ca0d1b57aa0b9
+  metadata.gz: 0eca02afb19c2be6bab1b8eb2188e511b8b8534305e5908da0b2690ee0977649380e514677e6143ed418c4460799c8b18a1801ba291077cef0048d8f3c9ded0c
+  data.tar.gz: b0fa9d6efaa4d5117a7076d2a5d1e69ef3d74f3a96202b80097cc1b43e572aa05f5e55e07423433e72fa5c667f2dbf3d33378e3384306a7a55e156695dbab04e

data/README.md

@@ -41,6 +41,19 @@ sessions = TrinsicApi::SessionsApi.new
 
 You can find a full Ruby server example in the [samples](https://github.com/trinsic-id/sdk/tree/main/api-ruby/samples) folder.
 
+### Data residency
+
+By default, the SDK communicates with `https://api.trinsic.id`. If you have a Verification Profile configured for EU data residency, point the SDK at the EU endpoint by setting the configuration `host`.
+
+```rb
+TrinsicApi.configure do |config|
+  config.host = 'https://api.eu.trinsic.id' # omit to use the default endpoint
+  config.access_token = 'your-access-token'
+end
+
+sessions = TrinsicApi::SessionsApi.new
+```
+
 ## SDK Versioning
 
 Our SDKs follow the [Semantic Versioning](https://semver.org) ("SemVer") scheme. 

data/docs/AadhaarLanguage.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **language_code** | **String** | The language code for the localized claims. | [optional] |
-| **language_name** | **String** | The language name for the localized claims.              This is Trinsic mapping the language from the code. The mapping comes from the spec, however, the code may not always reflect with the actual language used in the localized claims. Use this as a reference. Possible values: - Assamese (01) - Bengali (02) - Gujarati (05) - Hindi (06) - Kannada (07) - Malayalam (11) - Manipuri (12) - Marathi (13) - Oriya (15) - Punjabi (16) - Tamil (20) - Telugu (21) - Urdu (22) | [readonly] |
+| **language_name** | **String** | The language name for the localized claims.              This is Trinsic mapping the language from the code. The mapping comes from the spec, however, the code may not always reflect with the actual language used in the localized claims. Use this as a reference. Possible values: - Assamese (01) - Bengali (02) - Gujarati (05) - Hindi (06) - Kannada (07) - Malayalam (11) - Manipuri (12) - Marathi (13) - Oriya (15) - Punjabi (16) - Tamil (20) - Telugu (21) - Urdu (22) | [optional][readonly] |
 
 ## Example
 

data/docs/AgeOverOutput.md

@@ -4,8 +4,8 @@
 
 | 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. |  |
+| **age** | **Integer** | The age threshold from the `age over X` claim. | [optional] |
+| **is_over** | **Boolean** | Whether the individual is at least the given age. | [optional] |
 
 ## Example
 

data/docs/AlaskaMobileIdProviderOutput.md

@@ -0,0 +1,20 @@
+# TrinsicApi::AlaskaMobileIdProviderOutput
+
+## Properties
+
+| 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] |
+| **raw_mdl_output** | [**MdlOutput**](MdlOutput.md) | The raw output of the 18013-7 mDL exchange performed through Alaska Mobile ID. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::AlaskaMobileIdProviderOutput.new(
+  mobile_drivers_license: null,
+  raw_mdl_output: null
+)
+```
+

data/docs/AppleWalletDigitalIdBirthDate.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **date_of_birth** | **Date** | The encoded date of birth. |  |
+| **date_of_birth** | **Date** | The encoded date of birth. | [optional] |
 | **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

data/docs/AppleWalletProviderOutput.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **mobile_drivers_license** | [**Iso180135MobileDriversLicenseCredential**](Iso180135MobileDriversLicenseCredential.md) | A standard 18013-5 Mobile Driver's License credential, retrieved from the individual's wallet. | [optional] |
 | **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. |  |
+| **raw_mdl_output** | [**MdlOutput**](MdlOutput.md) | The raw output of the mDL exchange performed through Apple Wallet. | [optional] |
 
 ## Example
 

data/docs/AttachmentInfo.md

@@ -8,6 +8,7 @@
 | **type** | **String** | The type of the Attachment.              Possible values: - \"selfie\" - \"document_front\" - \"document_back\" - \"document_portrait\" - \"document_signature\" - \"document_scan_report\"              Additional attachment types may be defined for specific Providers. |  |
 | **content_type** | **String** | The MIME type of the attachment's contents; eg, \"image/jpeg\" or \"application/pdf\". |  |
 | **size_bytes** | **Integer** | The size in bytes of the attachment. |  |
+| **hpke_encrypted** | **Boolean** | Whether the attachment contents are encrypted via HPKE and must be decrypted using your private key. | [optional] |
 
 ## Example
 
@@ -18,7 +19,8 @@ instance = TrinsicApi::AttachmentInfo.new(
   id: null,
   type: null,
   content_type: null,
-  size_bytes: null
+  size_bytes: null,
+  hpke_encrypted: null
 )
 ```
 

data/docs/AudkenniProviderOutput.md

@@ -4,9 +4,9 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **national_register_id** | **String** | National Register ID number (kennitala) of the individual.              Often written with a hyphen following the 6th digit (123456-1234). ID numbers are composed of ten digits. The first six of these are the individual’s date of birth in the format DDMMYY. The seventh and eighth digits are randomly chosen when the ID number is allocated, the ninth digit used to be a check digit (modulus (11) but this has been removed. The tenth indicates the century of the individual’s birth: ‘9’ for 1900–1999, ‘0’ for 2000 and beyond. |  |
-| **subject_id** | **String** | Unique identifier for the individual across Audkenni.              It is recommended to use this identifier instead of using the national register ID directly. |  |
-| **name** | **String** | The full name of the individual. |  |
+| **national_register_id** | **String** | National Register ID number (kennitala) of the individual.              Often written with a hyphen following the 6th digit (123456-1234). ID numbers are composed of ten digits. The first six of these are the individual’s date of birth in the format DDMMYY. The seventh and eighth digits are randomly chosen when the ID number is allocated, the ninth digit used to be a check digit (modulus (11) but this has been removed. The tenth indicates the century of the individual’s birth: ‘9’ for 1900–1999, ‘0’ for 2000 and beyond. | [optional] |
+| **subject_id** | **String** | Unique identifier for the individual across Audkenni.              It is recommended to use this identifier instead of using the national register ID directly. | [optional] |
+| **name** | **String** | The full name of the individual. | [optional] |
 | **date_of_birth** | **Date** | The date of birth of the individual as parsed from the National Register ID number. Is null if the date of birth could not be parsed, but should always be present | [optional] |
 
 ## Example

data/docs/AustriaHandySignaturProviderOutput.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **first_name** | **String** | The first name of the verified individual |  |
-| **last_name** | **String** | The last name of the verified individual |  |
+| **first_name** | **String** | The first name of the verified individual | [optional] |
+| **last_name** | **String** | The last name of the verified individual | [optional] |
 
 ## Example
 

data/docs/AustriaValeraEudiSandboxInput.md

@@ -0,0 +1,18 @@
+# TrinsicApi::AustriaValeraEudiSandboxInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **preview_raw18013_request** | [**Raw18013RequestInput**](Raw18013RequestInput.md) | The raw 18013-7 exchange request to use for this verification.              If set, this overrides any default configuration on your Verification Profile. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::AustriaValeraEudiSandboxInput.new(
+  preview_raw18013_request: null
+)
+```
+

data/docs/AustriaValeraEudiSandboxProviderOutput.md

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

data/docs/BelgiumIdCardProviderOutput.md

@@ -4,10 +4,10 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **first_name** | **String** | The first name of the verified individual |  |
-| **last_name** | **String** | The last name of the verified individual |  |
-| **date_of_birth** | **Date** | The date of birth of the verified individual |  |
-| **national_register_number** | **String** | The Belgian National Register Number (\"Rijksregisternummer\") of the verified individual.              This is an 11-digit number in the format YYMMDDXXXCC, where: - YYMMDD represents the individual's date of birth (year, month, day). - XXX is a sequential birth number, odd for males and even for females. - CC is a checksum, calculated with the equation: 97 - (YYMMDDXXX mod 97)              For births in the year 2000 or later, the digit '2' is prepended to the first 9 digits during checksum calculation. |  |
+| **first_name** | **String** | The first name of the verified individual | [optional] |
+| **last_name** | **String** | The last name of the verified individual | [optional] |
+| **date_of_birth** | **Date** | The date of birth of the verified individual | [optional] |
+| **national_register_number** | **String** | The Belgian National Register Number (\"Rijksregisternummer\") of the verified individual.              This is an 11-digit number in the format YYMMDDXXXCC, where: - YYMMDD represents the individual's date of birth (year, month, day). - XXX is a sequential birth number, odd for males and even for females. - CC is a checksum, calculated with the equation: 97 - (YYMMDDXXX mod 97)              For births in the year 2000 or later, the digit '2' is prepended to the first 9 digits during checksum calculation. | [optional] |
 
 ## Example
 

data/docs/BoliviaCiProviderOutput.md

@@ -4,11 +4,11 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **full_name** | **String** | Full name as it appears on the CI (Cédula de Identidad). |  |
-| **given_name** | **String** | Given name(s) of the holder as they appear on the CI (Cédula de Identidad). |  |
-| **family_name** | **String** | Family name(s) of the holder (paternal and maternal) as they appear on the CI (Cédula de Identidad). |  |
+| **full_name** | **String** | Full name as it appears on the CI (Cédula de Identidad). | [optional] |
+| **given_name** | **String** | Given name(s) of the holder as they appear on the CI (Cédula de Identidad). | [optional] |
+| **family_name** | **String** | Family name(s) of the holder (paternal and maternal) as they appear on the CI (Cédula de Identidad). | [optional] |
 | **date_of_birth** | **Date** | Date of birth as recorded in official Bolivian identity records (RUI — Registro Único de Identificación). | [optional] |
-| **document_number** | **String** | The CI (Cédula de Identidad) document number for the matched record.              The document is officially called the Cédula de Identidad and is commonly called carnet or carnet de identidad in Bolivia. This is the identifier assigned by the Servicio General de Identificación Personal (SEGIP) in the Registro Único de Identificación (RUI). The value is entirely numeric. There is no verification digit or other data encoded in the number.              Published regulations do not define a fixed length; digit count may vary. |  |
+| **document_number** | **String** | The CI (Cédula de Identidad) document number for the matched record.              The document is officially called the Cédula de Identidad and is commonly called carnet or carnet de identidad in Bolivia. This is the identifier assigned by the Servicio General de Identificación Personal (SEGIP) in the Registro Único de Identificación (RUI). The value is entirely numeric. There is no verification digit or other data encoded in the number.              Published regulations do not define a fixed length; digit count may vary. | [optional] |
 
 ## Example
 

data/docs/BrazilBiometricVerificationOutput.md

@@ -0,0 +1,24 @@
+# TrinsicApi::BrazilBiometricVerificationOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **selfie_verification_probability** | **String** | The probability of the selfie verification being successful.              Possible values: - VeryLow - Low - High - VeryHigh | [optional] |
+| **selfie_liveness_outcome** | **String** | The outcome of the selfie verification.              Possible values: - Real - Fake - BadQuality | [optional] |
+| **database_selfie_available** | **Boolean** | Whether the government database had biometrics available for the individual.              Also false in some cases biometrics are available but not sufficient for selfie verification. | [optional] |
+| **selfie_similarity_percentage** | **Float** | Similarity match score of selfie verification.              Ranges from 0.0 to 1.0. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::BrazilBiometricVerificationOutput.new(
+  selfie_verification_probability: VeryHigh,
+  selfie_liveness_outcome: Real,
+  database_selfie_available: true,
+  selfie_similarity_percentage: 0.99
+)
+```
+

data/docs/BrazilCnhFacialBiometryOutput.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **database_face_available** | **Boolean** | Whether the government database had facial biometrics available for comparison. |  |
+| **database_face_available** | **Boolean** | Whether the government database had facial biometrics available for comparison. | [optional] |
 | **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] |

data/docs/BrazilCpfCheckInput.md

@@ -5,6 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **cpf_number** | **String** | The user's 11-digit, numeric CPF Number |  |
+| **date_of_birth** | **Date** | The user's date of birth. Optional, but date of birth will become required for lookups starting September 1, 2026. | [optional] |
 | **selfie_image** | **String** | The raw bytes of the selfie image collected from the user. | [optional] |
 | **selfie_image_content_type** | **String** | The MIME Type of the file contained in `SelfieImage`.              Must be one of `image/jpeg` or `image/png`. | [optional] |
 
@@ -15,6 +16,7 @@ require 'trinsic_api'
 
 instance = TrinsicApi::BrazilCpfCheckInput.new(
   cpf_number: null,
+  date_of_birth: null,
   selfie_image: null,
   selfie_image_content_type: null
 )

data/docs/BrazilCpfProviderOutput.md

@@ -0,0 +1,38 @@
+# TrinsicApi::BrazilCpfProviderOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **preview_raw_error_code** | **String** | The raw error code for the verification, returned by Serpro.              This is a temporary preview to support detailed error handling. When building against this please let the Trinsic team know. Preview features can be turned off without an obsoletion notice. | [optional] |
+| **cpf_number** | **String** | The individual's CPF number.              A CPF (Cadastro de Pessoas Físicas) is the Brazilian individual taxpayer identification number for residents and foreigners. It is an 11-digit number managed by the Federal Revenue Service, the last 2 digits are check digits, calculated based on the first 9 digits. The 9th digit indicates the fiscal region responsible for the registration, | [optional] |
+| **fiscal_regions** | **Array<String>** | List of Brazilian fiscal regions that could have issued this number.              This is calculated based off of the CPF number. A CPF number encodes information about what region it is issued from, but some regions share the identifier.              Possible values: Formatted as two characters. The digit represents the region code this applies to. - AC (Acre) - 2 - AL (Alagoas) - 4 - AP (Amapá) - 2 - AM (Amazonas) - 2 - BA (Bahia) - 5 - CE (Ceará) - 3 - DF (Distrito Federal) - 1 - ES (Espírito Santo) - 7 - GO (Goiás) - 1 - MA (Maranhão) - 3 - MT (Mato Grosso) - 1 - MS (Mato Grosso do Sul) - 1 - MG (Minas Gerais) - 6 - PA (Pará) - 2 - PB (Paraíba) - 4 - PR (Paraná) - 9 - PE (Pernambuco) - 4 - PI (Piauí) - 3 - RJ (Rio de Janeiro) - 7 - RN (Rio Grande do Norte) - 4 - RO (Rondônia) - 2 - RS (Rio Grande do Sul) - 0 - RR (Roraima) - 2 - SC (Santa Catarina) - 9 - SP (São Paulo) - 8 - SE (Sergipe) - 5 - TO (Tocantins) - 1 | [optional] |
+| **status_code** | **Integer** | The CPF Status. Possible values: 0 - Regular. The CPF is valid and in good standing. There are no pending issues, registration inconsistencies, or missing mandatory Individual Income Tax Returns (DIRPF). 2 - Suspended. The CPF record contains incorrect or incomplete registration data (e.g., name, date of birth, or voter registration number). This status is typically caused by discrepancies with the Superior Electoral Court (TSE) database or failure to update personal information. 3 - Deceased Holder. The CPF has been registered as belonging to a deceased individual. This status is recorded to prevent post-mortem misuse. 4 - Pending Regularization. The taxpayer has failed to submit one or more mandatory Individual Income Tax Returns (DIRPF) within the last five years. This can occur for various reasons, such as failure to file a mandatory declaration, changes of address, name, marital status, or other important information that does not conform to the records. Regularization requires submission of the overdue returns. 5 - Canceled by Multiplicity. The CPF has been cancelled due to duplicate registration (multiple CPFs assigned to the same individual or a single CPF linked to multiple individuals). 8 - Null. The CPF registration was cancelled due to confirmed fraud or a serious issuance error. Regularization requires in-person verification at a Federal Revenue Service office and may not be guaranteed. 9 - Cancelled Ex Officio. The CPF was cancelled due to administrative or judicial decision, or other registration inconsistencies. | [optional] |
+| **status_description** | **String** | Description of the CPF Status. | [optional] |
+| **name** | **String** | The full legal name of the individual. | [optional] |
+| **social_name** | **String** | The social name of the individual in case the individual would like to use a different name than their full legal name. | [optional] |
+| **date_of_birth** | **Date** | The date of birth of the individual. | [optional] |
+| **year_of_death** | **String** | Deprecated as of September 1, 2026.              The year of death of the individual, if applicable. | [optional] |
+| **date_of_registration** | **Date** | The date of registration of the individual with the Federal Revenue Service. | [optional] |
+| **biometric_verification** | [**BrazilBiometricVerificationOutput**](BrazilBiometricVerificationOutput.md) | The biometric verification results.              This is an optional configurable check. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::BrazilCpfProviderOutput.new(
+  preview_raw_error_code: MinorValidationNotAllowed,
+  cpf_number: 40442820135,
+  fiscal_regions: ["DF","GO","MS","MT","TO"],
+  status_code: 0,
+  status_description: Regular,
+  name: João Silva,
+  social_name: Maria Silva,
+  date_of_birth: Mon Sep 11 00:00:00 UTC 1995,
+  year_of_death: 2020,
+  date_of_registration: Fri Sep 11 00:00:00 UTC 2015,
+  biometric_verification: null
+)
+```
+

data/docs/ClearProviderOutput.md

@@ -0,0 +1,56 @@
+# TrinsicApi::ClearProviderOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **authenticated** | **Boolean** | Whether CLEAR authenticated the individual. | [optional] |
+| **authentication_methods** | **Array<String>** | The methods the individual authenticated with during the CLEAR flow.              Known values: - webauthn - email - sms_otp | [optional] |
+| **activated_authentication_methods** | **Array<String>** | The authentication methods the individual activated but did not use as a pre-existing credential during this session.              Known values: - webauthn - totp | [optional] |
+| **checks** | [**Array<ClearProviderOutputCheck>**](ClearProviderOutputCheck.md) | The checks CLEAR performed on the individual's data and each check's result. | [optional] |
+| **check_metadata** | **Array<String>** | CLEAR error or metadata codes that influenced check results. | [optional] |
+| **completed_at** | **Time** | The time the CLEAR verification session completed, as a UTC timestamp. | [optional] |
+| **created_at** | **Time** | The time the CLEAR verification session was created, as a UTC timestamp. | [optional] |
+| **email** | **String** | The individual's verified email address from the session. | [optional] |
+| **expires_at** | **Time** | The time the CLEAR verification session expires, as a UTC timestamp. | [optional] |
+| **fields_to_collect** | **Array<String>** | The fields CLEAR still required to complete the current verification step. | [optional] |
+| **ip** | **Array<String>** | The IP addresses used to access this CLEAR verification session. | [optional] |
+| **phone** | **String** | The individual's verified phone number, normalized to international E.164 format. | [optional] |
+| **status** | **String** | The CLEAR verification session status.              Known values: - success - fail - awaiting_user_input - deferred - processing_data - expired - awaiting_manual_review - manual_success - manual_fail - canceled | [optional] |
+| **updated_at** | **Time** | The time the CLEAR verification session was most recently updated, as a UTC timestamp. | [optional] |
+| **user_agent** | **Array<String>** | The browser user agents that accessed this CLEAR verification session. | [optional] |
+| **user_created** | **Boolean** | Whether CLEAR created a new individual account during this session. | [optional] |
+| **user_id** | **String** | The CLEAR identifier for the individual. | [optional] |
+| **traits** | [**ClearProviderOutputTraits**](ClearProviderOutputTraits.md) | The individual traits CLEAR returned after collecting enough information to make a decision. | [optional] |
+| **idv_status** | **String** | The identity verification status.              Known documented value: - verified: CLEAR indicates the individual is verified. | [optional] |
+| **sessions** | [**Array<ClearProviderOutputSessionInfo>**](ClearProviderOutputSessionInfo.md) | Frontend session metadata CLEAR collected. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::ClearProviderOutput.new(
+  authenticated: true,
+  authentication_methods: ["sms_otp"],
+  activated_authentication_methods: ["webauthn"],
+  checks: [{"verificationCheckName":"Selfie matches portrait on Gov ID","value":true,"status":"completed","checkResult":"success"}],
+  check_metadata: ["document_expired"],
+  completed_at: 2024-03-09T16:05Z,
+  created_at: 2024-03-09T16:00Z,
+  email: jane.doe@example.com,
+  expires_at: 2024-03-19T16:00Z,
+  fields_to_collect: ["phone"],
+  ip: ["203.0.113.10"],
+  phone: +14155551212,
+  status: success,
+  updated_at: 2024-03-09T16:05Z,
+  user_agent: ["Mozilla/5.0"],
+  user_created: false,
+  user_id: psuid_xyz987,
+  traits: null,
+  idv_status: verified,
+  sessions: [{"ip":"203.0.113.10","locale":"en-US","zoneInfo":"America/New_York"}]
+)
+```
+

data/docs/ClearProviderOutputAddress.md

@@ -0,0 +1,28 @@
+# TrinsicApi::ClearProviderOutputAddress
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **line1** | **String** | The first line of the address. | [optional] |
+| **line2** | **String** | The second line of the address, such as an apartment or suite. | [optional] |
+| **city** | **String** | The city. | [optional] |
+| **state** | **String** | The state, province, or region. | [optional] |
+| **postal_code** | **String** | The postal code. | [optional] |
+| **country** | **String** | The ISO 3166-1 alpha-2 country code. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::ClearProviderOutputAddress.new(
+  line1: 123 Main St,
+  line2: Apt 4B,
+  city: San Francisco,
+  state: California,
+  postal_code: 94105,
+  country: US
+)
+```
+

data/docs/ClearProviderOutputCheck.md

@@ -0,0 +1,28 @@
+# TrinsicApi::ClearProviderOutputCheck
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **verification_check_name** | **String** | The verification check name as specified in the CLEAR verification configuration. | [optional] |
+| **value** | **Boolean** | The boolean check value.              This can be null when a check is skipped or unable to evaluate to a deterministic result. | [optional] |
+| **status** | **String** | Whether CLEAR performed the check.              Known values: - completed - skipped - error | [optional] |
+| **check_result** | **String** | The granular CLEAR result for this check.              Known values: - success - failure - indeterminate - not_applicable - awaiting_async_response | [optional] |
+| **additional_details** | [**ClearProviderOutputCheckAdditionalDetails**](ClearProviderOutputCheckAdditionalDetails.md) | Additional structured details CLEAR used for this check. Currently modeled details: watchlistHits. | [optional] |
+| **params** | **Hash<String, Object>** | Custom parameters configured for this CLEAR check. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::ClearProviderOutputCheck.new(
+  verification_check_name: Selfie matches portrait on Gov ID,
+  value: true,
+  status: completed,
+  check_result: success,
+  additional_details: null,
+  params: {"minimumAge":18}
+)
+```
+

data/docs/ClearProviderOutputCheckAdditionalDetails.md

@@ -0,0 +1,18 @@
+# TrinsicApi::ClearProviderOutputCheckAdditionalDetails
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **watchlist_hits** | [**ClearProviderOutputWatchlistHits**](ClearProviderOutputWatchlistHits.md) | Watchlist hit information. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::ClearProviderOutputCheckAdditionalDetails.new(
+  watchlist_hits: null
+)
+```
+

data/docs/ClearProviderOutputDocument.md

@@ -0,0 +1,42 @@
+# TrinsicApi::ClearProviderOutputDocument
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **nationality** | **String** | The nationality scanned from the document, normalized to an ISO 3166-1 alpha-2 country code. | [optional] |
+| **document_type** | **String** | The document type scanned by CLEAR.              Known values: - drivers_license - paper_passport - passport_card - id_card - visa - health_care_card - other | [optional] |
+| **issuing_country** | **String** | The ISO 3166-1 alpha-2 country code of issue. | [optional] |
+| **issuing_subdivision** | **String** | The ISO 3166 subdivision issuer of the document. | [optional] |
+| **document_number** | **String** | The document number scanned from the document. | [optional] |
+| **date_of_expiry** | **Date** | The document expiration date. | [optional] |
+| **gender** | **String** | The gender scanned from the document. CLEAR does not publish a closed set of possible values for this field. | [optional] |
+| **address** | [**ClearProviderOutputAddress**](ClearProviderOutputAddress.md) | The address scanned from the document. | [optional] |
+| **date_of_birth** | **Date** | The date of birth scanned from the document. | [optional] |
+| **first_name** | **String** | The first name scanned from the document. | [optional] |
+| **last_name** | **String** | The last name scanned from the document. | [optional] |
+| **middle_name** | **String** | The middle name scanned from the document. | [optional] |
+| **full_name** | **String** | The full name scanned from the document. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::ClearProviderOutputDocument.new(
+  nationality: US,
+  document_type: drivers_license,
+  issuing_country: US,
+  issuing_subdivision: US-CA,
+  document_number: D1234567,
+  date_of_expiry: Thu Jan 31 00:00:00 UTC 2030,
+  gender: F,
+  address: null,
+  date_of_birth: Wed Jan 31 00:00:00 UTC 1990,
+  first_name: Jane,
+  last_name: Doe,
+  middle_name: Quinn,
+  full_name: Jane Quinn Doe
+)
+```
+

data/docs/ClearProviderOutputHealthInsurance.md

@@ -0,0 +1,32 @@
+# TrinsicApi::ClearProviderOutputHealthInsurance
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payer_id** | **String** | The health insurance payer identifier. | [optional] |
+| **payer_name** | **String** | The health insurance payer name. | [optional] |
+| **plan_status** | **String** | The health insurance plan status. | [optional] |
+| **group_name** | **String** | The health insurance group name. | [optional] |
+| **group_id** | **String** | The health insurance group identifier. | [optional] |
+| **insurance_member_id** | **String** | The health insurance member identifier. | [optional] |
+| **policy_holder_first_name** | **String** | The first name of the policy holder. | [optional] |
+| **policy_holder_last_name** | **String** | The last name of the policy holder. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::ClearProviderOutputHealthInsurance.new(
+  payer_id: 12345,
+  payer_name: Example Health,
+  plan_status: active,
+  group_name: Example Group,
+  group_id: G12345,
+  insurance_member_id: M123456789,
+  policy_holder_first_name: Jane,
+  policy_holder_last_name: Doe
+)
+```
+

data/docs/ClearProviderOutputHistoricalAddress.md

@@ -0,0 +1,36 @@
+# TrinsicApi::ClearProviderOutputHistoricalAddress
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **line1** | **String** | The first line of the address. | [optional] |
+| **line2** | **String** | The second line of the address, such as an apartment or suite. | [optional] |
+| **city** | **String** | The city. | [optional] |
+| **state** | **String** | The state, province, or region. | [optional] |
+| **postal_code** | **String** | The postal code. | [optional] |
+| **country** | **String** | The ISO 3166-1 alpha-2 country code. | [optional] |
+| **street_number** | **String** | The historical address street number. | [optional] |
+| **street_name** | **String** | The historical address street name. | [optional] |
+| **first_seen** | [**ClearProviderOutputPartialDate**](ClearProviderOutputPartialDate.md) | The first date CLEAR saw this historical address. | [optional] |
+| **last_seen** | [**ClearProviderOutputPartialDate**](ClearProviderOutputPartialDate.md) | The last date CLEAR saw this historical address. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::ClearProviderOutputHistoricalAddress.new(
+  line1: 123 Main St,
+  line2: Apt 4B,
+  city: San Francisco,
+  state: California,
+  postal_code: 94105,
+  country: US,
+  street_number: 123,
+  street_name: Main St,
+  first_seen: null,
+  last_seen: null
+)
+```
+

data/docs/ClearProviderOutputHistoricalData.md

@@ -0,0 +1,20 @@
+# TrinsicApi::ClearProviderOutputHistoricalData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **names** | [**Array<ClearProviderOutputHistoricalName>**](ClearProviderOutputHistoricalName.md) | Prior names associated with the individual. | [optional] |
+| **addresses** | [**Array<ClearProviderOutputHistoricalAddress>**](ClearProviderOutputHistoricalAddress.md) | Prior addresses associated with the individual. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::ClearProviderOutputHistoricalData.new(
+  names: [{"firstName":"Jane","lastName":"Doe","firstSeen":{"year":2018,"month":1,"day":15}}],
+  addresses: [{"line1":"123 Main St","city":"San Francisco","state":"California","country":"US","firstSeen":{"year":2018,"month":1,"day":15}}]
+)
+```
+

data/docs/ClearProviderOutputHistoricalName.md

@@ -0,0 +1,28 @@
+# TrinsicApi::ClearProviderOutputHistoricalName
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **first_name** | **String** | The historical first name. | [optional] |
+| **middle_name** | **String** | The historical middle name. | [optional] |
+| **last_name** | **String** | The historical last name. | [optional] |
+| **second_family_name** | **String** | The historical second family name. | [optional] |
+| **first_seen** | [**ClearProviderOutputPartialDate**](ClearProviderOutputPartialDate.md) | The first date CLEAR saw this historical name. | [optional] |
+| **last_seen** | [**ClearProviderOutputPartialDate**](ClearProviderOutputPartialDate.md) | The last date CLEAR saw this historical name. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::ClearProviderOutputHistoricalName.new(
+  first_name: Jane,
+  middle_name: Quinn,
+  last_name: Doe,
+  second_family_name: Rivera,
+  first_seen: null,
+  last_seen: null
+)
+```
+