trinsic_api 3.1.0 → 3.2.1

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
+)
+```
+

data/docs/ClearProviderOutputLocationInfo.md

@@ -0,0 +1,30 @@
+# TrinsicApi::ClearProviderOutputLocationInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **country** | **String** | The country name. | [optional] |
+| **country_iso** | **String** | The ISO 3166 alpha-2 country code. | [optional] |
+| **subdivision** | **String** | The subdivision name. | [optional] |
+| **subdivision_type** | **String** | The subdivision type, such as state or province. | [optional] |
+| **city** | **String** | The city name. | [optional] |
+| **latitude** | **String** | The latitude parsed from the request. | [optional] |
+| **longitude** | **String** | The longitude parsed from the request. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::ClearProviderOutputLocationInfo.new(
+  country: United States,
+  country_iso: US,
+  subdivision: California,
+  subdivision_type: state,
+  city: San Francisco,
+  latitude: 37.7749,
+  longitude: -122.4194
+)
+```
+

data/docs/ClearProviderOutputPartialDate.md

@@ -0,0 +1,22 @@
+# TrinsicApi::ClearProviderOutputPartialDate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **day** | **Integer** | The day of the month. | [optional] |
+| **month** | **Integer** | The month number, where January is 1. | [optional] |
+| **year** | **Integer** | The year. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::ClearProviderOutputPartialDate.new(
+  day: 31,
+  month: 1,
+  year: 1990
+)
+```
+

data/docs/ClearProviderOutputSessionInfo.md

@@ -0,0 +1,28 @@
+# TrinsicApi::ClearProviderOutputSessionInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **location** | [**ClearProviderOutputLocationInfo**](ClearProviderOutputLocationInfo.md) | Location information gathered from the individual's frontend session. | [optional] |
+| **user_agent** | **String** | The browser user agent for this frontend session. | [optional] |
+| **created_at** | **Time** | The time this frontend session was created, as a UTC timestamp. | [optional] |
+| **ip** | **String** | The IP address for this frontend session. | [optional] |
+| **locale** | **String** | The individual's locale for this frontend session. | [optional] |
+| **zone_info** | **String** | The individual's IANA time zone for this frontend session. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::ClearProviderOutputSessionInfo.new(
+  location: null,
+  user_agent: Mozilla/5.0,
+  created_at: 2024-03-09T16:00Z,
+  ip: 203.0.113.10,
+  locale: en-US,
+  zone_info: America/New_York
+)
+```
+

data/docs/ClearProviderOutputTraits.md

@@ -0,0 +1,50 @@
+# TrinsicApi::ClearProviderOutputTraits
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **address** | [**ClearProviderOutputAddress**](ClearProviderOutputAddress.md) | The individual's address. | [optional] |
+| **date_of_birth** | **Date** | The individual's date of birth. | [optional] |
+| **email** | **String** | The individual's email address. | [optional] |
+| **first_name** | **String** | The individual's first name. | [optional] |
+| **last_name** | **String** | The individual's last name. | [optional] |
+| **middle_name** | **String** | The individual's middle name. | [optional] |
+| **second_family_name** | **String** | The individual's second family name. | [optional] |
+| **full_last_name** | **String** | The individual's full last name. | [optional] |
+| **phone** | **String** | The individual's phone number, normalized to international E.164 format. | [optional] |
+| **ssn4** | **String** | The last four digits of the individual's SSN. | [optional] |
+| **ssn9** | **String** | The individual's SSN. | [optional] |
+| **identification_number** | **String** | The national identification number. | [optional] |
+| **identification_type** | **String** | The national identification number type. | [optional] |
+| **document** | [**ClearProviderOutputDocument**](ClearProviderOutputDocument.md) | Parsed data from the individual's scanned document. | [optional] |
+| **health_insurance** | [**ClearProviderOutputHealthInsurance**](ClearProviderOutputHealthInsurance.md) | Health insurance information. | [optional] |
+| **verified_email** | [**ClearProviderOutputVerifiedEmail**](ClearProviderOutputVerifiedEmail.md) | Verified email information. | [optional] |
+| **historical_data** | [**ClearProviderOutputHistoricalData**](ClearProviderOutputHistoricalData.md) | Historical identity traits. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::ClearProviderOutputTraits.new(
+  address: null,
+  date_of_birth: Wed Jan 31 00:00:00 UTC 1990,
+  email: jane.doe@example.com,
+  first_name: Jane,
+  last_name: Doe,
+  middle_name: Quinn,
+  second_family_name: Rivera,
+  full_last_name: Doe Rivera,
+  phone: +14155551212,
+  ssn4: 1234,
+  ssn9: 123456789,
+  identification_number: ID1234567,
+  identification_type: national_id,
+  document: null,
+  health_insurance: null,
+  verified_email: null,
+  historical_data: null
+)
+```
+

data/docs/ClearProviderOutputVerifiedEmail.md

@@ -0,0 +1,22 @@
+# TrinsicApi::ClearProviderOutputVerifiedEmail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** | The verified email address. | [optional] |
+| **verified_at** | **Time** | The time the email was verified, as a UTC timestamp. | [optional] |
+| **verification_method** | **String** | The method CLEAR used to verify the email. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::ClearProviderOutputVerifiedEmail.new(
+  email: jane.doe@example.com,
+  verified_at: 2024-03-09T16:01:40Z,
+  verification_method: otp
+)
+```
+

data/docs/ClearProviderOutputWatchlistHit.md

@@ -0,0 +1,24 @@
+# TrinsicApi::ClearProviderOutputWatchlistHit
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **entity_type** | **String** | The watchlist entity type.              Known values: - person | [optional] |
+| **details** | [**ClearProviderOutputWatchlistHitDetails**](ClearProviderOutputWatchlistHitDetails.md) | More details about the watchlist hit entity. | [optional] |
+| **source_lists** | [**Array<ClearProviderOutputWatchlistSource>**](ClearProviderOutputWatchlistSource.md) | The watchlist source lists where CLEAR found the hit. | [optional] |
+| **hit_types** | **Array<String>** | The types of watchlist hits.              Known values: - sanction - pep - warning - adverse_media | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::ClearProviderOutputWatchlistHit.new(
+  entity_type: person,
+  details: null,
+  source_lists: [{"name":"Example List","summary":"Example source","url":"https://example.com/list"}],
+  hit_types: ["sanction"]
+)
+```
+

data/docs/ClearProviderOutputWatchlistHitDetails.md

@@ -0,0 +1,48 @@
+# TrinsicApi::ClearProviderOutputWatchlistHitDetails
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **Array<String>** | Names associated with the watchlist hit. | [optional] |
+| **_alias** | **Array<String>** | Aliases associated with the watchlist hit. | [optional] |
+| **country** | **Array<String>** | ISO 3166-1 alpha-2 country codes associated with the watchlist hit. | [optional] |
+| **address** | [**Array<ClearProviderOutputAddress>**](ClearProviderOutputAddress.md) | Addresses associated with the watchlist hit. | [optional] |
+| **date_of_birth** | [**Array<ClearProviderOutputPartialDate>**](ClearProviderOutputPartialDate.md) | Dates of birth associated with the watchlist hit. | [optional] |
+| **date_of_death** | [**Array<ClearProviderOutputPartialDate>**](ClearProviderOutputPartialDate.md) | Dates of death associated with the watchlist hit. | [optional] |
+| **place_of_birth** | **Array<String>** | Places of birth associated with the watchlist hit. | [optional] |
+| **gender** | **Array<String>** | Genders associated with the watchlist hit, as represented in the source lists. | [optional] |
+| **nationality** | **Array<String>** | ISO 3166-1 alpha-2 nationalities associated with the watchlist hit. | [optional] |
+| **position** | **Array<String>** | Positions associated with the watchlist hit. | [optional] |
+| **passport_number** | **Array<String>** | Passport numbers associated with the watchlist hit. | [optional] |
+| **id_number** | **Array<String>** | Identification numbers associated with the watchlist hit. | [optional] |
+| **notes** | **Array<String>** | Notes from the watchlist source data. | [optional] |
+| **created_at** | [**Array<ClearProviderOutputPartialDate>**](ClearProviderOutputPartialDate.md) | Dates when the source entries were created. | [optional] |
+| **modified_at** | [**Array<ClearProviderOutputPartialDate>**](ClearProviderOutputPartialDate.md) | Dates when the source entries were last modified. | [optional] |
+| **source_urls** | **Array<String>** | Source URLs for the watchlist hit. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::ClearProviderOutputWatchlistHitDetails.new(
+  name: ["Jane Doe"],
+  _alias: ["J. Doe"],
+  country: ["US"],
+  address: [{"line1":"123 Main St","city":"New York","country":"US"}],
+  date_of_birth: [{"year":1990,"month":1,"day":31}],
+  date_of_death: [{"year":2020}],
+  place_of_birth: ["New York"],
+  gender: ["female"],
+  nationality: ["US"],
+  position: ["Director"],
+  passport_number: ["P1234567"],
+  id_number: ["ID1234567"],
+  notes: ["Example source note"],
+  created_at: [{"year":2023,"month":1,"day":15}],
+  modified_at: [{"year":2024,"month":2,"day":20}],
+  source_urls: ["https://example.com/source"]
+)
+```
+

data/docs/ClearProviderOutputWatchlistHits.md

@@ -0,0 +1,20 @@
+# TrinsicApi::ClearProviderOutputWatchlistHits
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **hits** | [**Array<ClearProviderOutputWatchlistHit>**](ClearProviderOutputWatchlistHit.md) | The watchlist hits. | [optional] |
+| **updated_at** | **Time** | The last time CLEAR fetched watchlist hit data from its data sources, as a UTC timestamp. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::ClearProviderOutputWatchlistHits.new(
+  hits: [{"entityType":"person","hitTypes":["sanction"]}],
+  updated_at: 2024-03-09T16:03:20Z
+)
+```
+

data/docs/ClearProviderOutputWatchlistSource.md

@@ -0,0 +1,22 @@
+# TrinsicApi::ClearProviderOutputWatchlistSource
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the watchlist source. | [optional] |
+| **summary** | **String** | The summary of the watchlist source. | [optional] |
+| **url** | **String** | The URL for the watchlist source. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::ClearProviderOutputWatchlistSource.new(
+  name: Example Sanctions List,
+  summary: Example source summary,
+  url: https://example.com/list
+)
+```
+

data/docs/ColombiaCcProviderOutput.md

@@ -4,16 +4,16 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **full_name** | **String** | Full name as it appears on the CC. |  |
-| **given_name** | **String** | Given name(s) of the holder as they appear on the CC. |  |
-| **family_name** | **String** | Family name(s) of the holder as they appear on the CC. Space-separated when both paternal and maternal family names are present. |  |
-| **date_of_birth** | **Date** | Date of birth as recorded in the civil registry (Registraduría Nacional). |  |
-| **sex** | **String** | Sex of the holder as recorded in the civil registry (Registraduría Nacional).              Possible values: - Male - Female - Unknown (when the sex is not recorded or cannot be confidently determined) |  |
-| **is_alive** | **Boolean** | Whether the person is reported as alive in Colombia's official civil registry (Registraduría Nacional).              Used to detect identity fraud when the holder is deceased. |  |
-| **document_number** | **String** | The Cédula de Ciudadanía (CC) document number.              This is the unique identifier assigned by the Registraduría Nacional when the person is first issued a CC. It does not change when the person renews or receives a new physical card; it remains the same for the individual for life.              Cédulas issued after 2004 use the NUIP (Número Único de Identificación Personal), which is 10 digits. Older documents may have fewer than 10 digits and are still valid. |  |
-| **expedition_date** | **Date** | Date the CC was issued (fecha de expedición).              Format: - yyyy-MM-dd |  |
-| **expedition_place** | [**ColombiaExpeditionPlace**](ColombiaExpeditionPlace.md) | Place where the CC was issued (lugar de expedición): municipality and department as recorded by the Registraduría Nacional. |  |
-| **array_name** | **Array<String>** | All names as they appear on the CC, as an array of strings.              Format: - Order follows the civil registry: typically family name(s) first, then given name(s). |  |
+| **full_name** | **String** | Full name as it appears on the CC. | [optional] |
+| **given_name** | **String** | Given name(s) of the holder as they appear on the CC. | [optional] |
+| **family_name** | **String** | Family name(s) of the holder as they appear on the CC. Space-separated when both paternal and maternal family names are present. | [optional] |
+| **date_of_birth** | **Date** | Date of birth as recorded in the civil registry (Registraduría Nacional). | [optional] |
+| **sex** | **String** | Sex of the holder as recorded in the civil registry (Registraduría Nacional).              Possible values: - Male - Female - Unknown (when the sex is not recorded or cannot be confidently determined) | [optional] |
+| **is_alive** | **Boolean** | Whether the person is reported as alive in Colombia's official civil registry (Registraduría Nacional).              Used to detect identity fraud when the holder is deceased. | [optional] |
+| **document_number** | **String** | The Cédula de Ciudadanía (CC) document number.              This is the unique identifier assigned by the Registraduría Nacional when the person is first issued a CC. It does not change when the person renews or receives a new physical card; it remains the same for the individual for life.              Cédulas issued after 2004 use the NUIP (Número Único de Identificación Personal), which is 10 digits. Older documents may have fewer than 10 digits and are still valid. | [optional] |
+| **expedition_date** | **Date** | Date the CC was issued (fecha de expedición).              Format: - yyyy-MM-dd | [optional] |
+| **expedition_place** | [**ColombiaExpeditionPlace**](ColombiaExpeditionPlace.md) | Place where the CC was issued (lugar de expedición): municipality and department as recorded by the Registraduría Nacional. | [optional] |
+| **array_name** | **Array<String>** | All names as they appear on the CC, as an array of strings.              Format: - Order follows the civil registry: typically family name(s) first, then given name(s). | [optional] |
 
 ## Example
 

data/docs/CoteDIvoireNidLookup2ProviderOutput.md

@@ -4,12 +4,12 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **full_name** | **String** | Full name as returned by ONECI (National Civil Registry and Identification Office). |  |
-| **given_name** | **String** | Given name of the ID holder as returned by ONECI (National Civil Registry and Identification Office). |  |
-| **family_name** | **String** | Family name of the ID holder as returned by ONECI (National Civil Registry and Identification Office). |  |
-| **date_of_birth** | **Date** | Date of birth as returned by ONECI (National Civil Registry and Identification Office). |  |
-| **sex** | **String** | Sex of the ID holder as returned by ONECI (National Civil Registry and Identification Office). Possible values: - Male - Female |  |
-| **nationality** | **String** | Nationality as ISO 3166-1 alpha-2 country code (e.g. \"CI\" for Côte d'Ivoire). |  |
+| **full_name** | **String** | Full name as returned by ONECI (National Civil Registry and Identification Office). | [optional] |
+| **given_name** | **String** | Given name of the ID holder as returned by ONECI (National Civil Registry and Identification Office). | [optional] |
+| **family_name** | **String** | Family name of the ID holder as returned by ONECI (National Civil Registry and Identification Office). | [optional] |
+| **date_of_birth** | **Date** | Date of birth as returned by ONECI (National Civil Registry and Identification Office). | [optional] |
+| **sex** | **String** | Sex of the ID holder as returned by ONECI (National Civil Registry and Identification Office). Possible values: - Male - Female | [optional] |
+| **nationality** | **String** | Nationality as ISO 3166-1 alpha-2 country code (e.g. \"CI\" for Côte d'Ivoire). | [optional] |
 | **address** | **String** | Address as returned from ONECI (National Civil Registry and Identification Office). Format is LOCALITY,COMMUNE: the locality (village, neighborhood, or sous-quartier) followed by the commune. Not a full street address. | [optional] |
 | **document_number** | **String** | The document's own identifier (printed on the card; often labeled \"Immatriculation\" on older cards or \"Numéro CNI\" in post-2020 cards). On older cards this is usually one letter followed by 10 digits. On new cards it appears as 1 or 2 leading letters plus 9 digits. | [optional] |
 | **national_id_number** | **String** | The NNI (Numéro National d'Identification): the person's 11-digit national ID, printed on the back of the new national id card and assigned by ONECI. It is always exactly 11 digits with no letters, and is semi-random, non-repetitive, and does not encode any extra data, such as date of birth, gender, or other readable attributes. | [optional] |

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

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **session_id** | **String** | The ID of the newly-created Acceptance Session |  |
-| **launch_url** | **String** | The URL that should be used to launch the Hosted Provider Session on your user's device.              There are two recommended ways to do so: - Redirect their browser to the `LaunchUrl` as a top-level navigation - Open a popup window and navigate it to the `LaunchUrl`              This URL is sensitive and as such can only be obtained once. If you need to obtain it again, you will need to create a new Acceptance Session. |  |
+| **launch_url** | **String** | The URL that should be used to launch the Hosted Provider Session on your user's device.              Redirect the user's browser to the `LaunchUrl` as a top-level navigation              This URL is sensitive and as such can only be obtained once. If you need to obtain it again, you will need to create a new Acceptance Session. |  |
 | **results_access_key** | **String** | The `resultsAccessKey` for the Acceptance Session.              This is an encrypted payload which contains the decryption key necessary to access the Session's Data Vault.              Save this securely in your systems; it must be passed back with any API call which requires access to the Session's Data Vault.              Trinsic cannot access a Session's Data Vault without this key. |  |
 
 ## 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. | [optional] |
+| **city_area** | **String** | The city area name.              This is usually present. | [optional] |
+| **zipcode** | **String** | The zip of the address. | [optional] |
+| **country** | **String** | The country code in ISO 3166-1 alpha-2 format. | [optional] |
+| **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 | [optional] |
+| **description** | **String** | The localized identity document type description. | [optional] |
+| **country** | **String** | The country for which the identity document is valid. | [optional] |
+| **number** | **String** | The identity document number. | [optional] |
+| **valid_to** | **Date** | The identity document expiration date. | [optional] |
+| **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
+)
+```
+