trinsic_api 3.2.0 → 3.2.1

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/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

@@ -9,10 +9,10 @@
 | **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** | **String** | The city name. | [optional] |
 | **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. |  |
+| **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

data/docs/CzechBankIdCard.md

@@ -4,11 +4,11 @@
 
 | 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 |  |
+| **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. |  |
-| **number** | **String** | The identity document number. |  |
-| **valid_to** | **Date** | The identity document expiration date. |  |
+| **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] |
 

data/docs/CzechBankIdProviderOutput.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **subject_identifier** | **String** | The subject identifier for the verified individual. |  |
+| **subject_identifier** | **String** | The subject identifier for the verified individual. | [optional] |
 | **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] |

data/docs/CzechBankIdVerification.md

@@ -4,9 +4,9 @@
 
 | 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. |  |
+| **trust_framework** | **String** | The trust framework used for the verification.              This identifies the anti-money-laundering framework used for identity verification. | [optional] |
 | **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. |  |
+| **verification_process** | **String** | The verification process identifier.              This identifies the bank that completed the physical identity verification process. | [optional] |
 
 ## Example
 

data/docs/CzechiaMojeIdProviderOutput.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 |  |
-| **open_id2_identifier** | **String** | The OpenID 2.0 Identifier (\"openid2_id\") of the verified individual's MojeID account.              This is an HTTPS URL which uniquely identifies the individual within the MojeID system. |  |
+| **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] |
+| **open_id2_identifier** | **String** | The OpenID 2.0 Identifier (\"openid2_id\") of the verified individual's MojeID account.              This is an HTTPS URL which uniquely identifies the individual within the MojeID system. | [optional] |
 
 ## Example
 

data/docs/DenmarkAltIdInput.md

@@ -0,0 +1,18 @@
+# TrinsicApi::DenmarkAltIdInput
+
+## 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::DenmarkAltIdInput.new(
+  preview_raw18013_request: null
+)
+```
+

data/docs/DenmarkAltIdProviderOutput.md

@@ -0,0 +1,22 @@
+# TrinsicApi::DenmarkAltIdProviderOutput
+
+## 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 AltID. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::DenmarkAltIdProviderOutput.new(
+  pid: null,
+  age_verification: null,
+  raw18013_output: null
+)
+```
+

data/docs/DigilockerAadhaarProviderOutput.md

@@ -10,7 +10,7 @@
 | **aadhaar_number_last_four** | **String** | The Aadhaar number (UID) value for the individual.              This is only the last four digits of the Aadhaar number. | [optional] |
 | **claims** | [**AadhaarClaims**](AadhaarClaims.md) | The claims extracted from the Aadhaar document. | [optional] |
 | **localized_claims** | [**AadhaarLocalizedClaims**](AadhaarLocalizedClaims.md) | The localized claims extracted from the Aadhaar document. | [optional] |
-| **document_signature_validated** | **Boolean** | Whether our own validation of the Aadhaar document signature and certificate chain succeeded.              When the signed document (e.g. Digilocker XML) is available, we validate it using the standard CCA/SafeScrypt chain. When the document is not returned, the signature cannot be validated and this is false. Some providers (e.g. Signzy) also supply a separate DSC validation indicator in the webhook payload; that is independent of this flag, which reflects only our validation. |  |
+| **document_signature_validated** | **Boolean** | Whether our own validation of the Aadhaar document signature and certificate chain succeeded.              When the signed document (e.g. Digilocker XML) is available, we validate it using the standard CCA/SafeScrypt chain. When the document is not returned, the signature cannot be validated and this is false. Some providers (e.g. Signzy) also supply a separate DSC validation indicator in the webhook payload; that is independent of this flag, which reflects only our validation. | [optional] |
 
 ## Example
 

data/docs/DiiaProviderOutput.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **subject** | [**DiiaSubjectOutput**](DiiaSubjectOutput.md) | Diia.Signature user data. |  |
-| **issuer** | [**DiiaIssuerOutput**](DiiaIssuerOutput.md) | Diia.Signature issuer data. |  |
+| **subject** | [**DiiaSubjectOutput**](DiiaSubjectOutput.md) | Diia.Signature user data. | [optional] |
+| **issuer** | [**DiiaIssuerOutput**](DiiaIssuerOutput.md) | Diia.Signature issuer data. | [optional] |
 
 ## Example
 

data/docs/ElSalvadorDuiProviderOutput.md

@@ -4,9 +4,9 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **full_name** | **String** | Full name as it appears on the DUI (Documento Único de Identidad), as returned by Verifik from official records administered by the Registro Nacional de las Personas Naturales (RNPN). |  |
-| **document_number** | **String** | The DUI (Documento Único de Identidad) document number as returned by Verifik for the matched record.              Nine numeric digits after sanitization. Commonly printed as ########-# (hyphen before the final digit). The output will be stripped of the hyphen and will preserve leading zeros.              The ninth digit is a check digit. This is not publicly documented by the Salvadoran government, but the algorithm is available in the public domain for those who seek it. |  |
-| **date_of_birth** | **Date** | The date of birth that was supplied for the lookup and confirmed as matching the DUI record. |  |
+| **full_name** | **String** | Full name as it appears on the DUI (Documento Único de Identidad), as returned by Verifik from official records administered by the Registro Nacional de las Personas Naturales (RNPN). | [optional] |
+| **document_number** | **String** | The DUI (Documento Único de Identidad) document number as returned by Verifik for the matched record.              Nine numeric digits after sanitization. Commonly printed as ########-# (hyphen before the final digit). The output will be stripped of the hyphen and will preserve leading zeros.              The ninth digit is a check digit. This is not publicly documented by the Salvadoran government, but the algorithm is available in the public domain for those who seek it. | [optional] |
+| **date_of_birth** | **Date** | The date of birth that was supplied for the lookup and confirmed as matching the DUI record. | [optional] |
 
 ## Example
 

data/docs/EstoniaIdCardProviderOutput.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 |  |
-| **personal_identification_code** | **String** | The 11-digit Estonian personal identification code (\"isikukood\") of the verified individual.              This is in the format GYYMMDDSSSC, where: - G combines the century and sex of birth - YYMMDD is the date of birth within the given century - SSS is a serial number distinguishing people born on the same date - C is a checksum digit              If G is odd, the individual is male. If G is even, the individual is female.              If G is 1 or 2, the individual was born in the 19th century (1800-1899). If G is 3 or 4, the individual was born in the 20th century (1900-1999). If G is 5 or 6, the individual was born in the 21st century (2000-2099). If G is 7 or 8, the individual was born in the 22nd century (2100-2199). |  |
+| **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] |
+| **personal_identification_code** | **String** | The 11-digit Estonian personal identification code (\"isikukood\") of the verified individual.              This is in the format GYYMMDDSSSC, where: - G combines the century and sex of birth - YYMMDD is the date of birth within the given century - SSS is a serial number distinguishing people born on the same date - C is a checksum digit              If G is odd, the individual is male. If G is even, the individual is female.              If G is 1 or 2, the individual was born in the 19th century (1800-1899). If G is 3 or 4, the individual was born in the 20th century (1900-1999). If G is 5 or 6, the individual was born in the 21st century (2000-2099). If G is 7 or 8, the individual was born in the 22nd century (2100-2199). | [optional] |
 
 ## Example
 

data/docs/EudiAgeVerificationCredential.md

@@ -5,8 +5,6 @@
 | 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
 
@@ -14,9 +12,7 @@
 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
+  age_over: [{"age":18,"isOver":true},{"age":21,"isOver":true}]
 )
 ```
 

data/docs/EudiReferenceWalletProviderOutput.md

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

data/docs/EvrotrustAddressComponents.md

@@ -0,0 +1,48 @@
+# TrinsicApi::EvrotrustAddressComponents
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **district** | **String** | The district fragment of the address. | [optional] |
+| **district_local** | **String** | The local-language district fragment of the address. | [optional] |
+| **municipality** | **String** | The municipality fragment of the address. | [optional] |
+| **municipality_local** | **String** | The local-language municipality fragment of the address. | [optional] |
+| **settlement** | **String** | The settlement fragment of the address. | [optional] |
+| **settlement_local** | **String** | The local-language settlement fragment of the address. | [optional] |
+| **location** | **String** | The location or street fragment of the address. | [optional] |
+| **location_local** | **String** | The local-language location or street fragment of the address. | [optional] |
+| **building_number** | **String** | The building number fragment of the address. | [optional] |
+| **building_number_local** | **String** | The local-language building number fragment of the address. | [optional] |
+| **entrance** | **String** | The entrance fragment of the address. | [optional] |
+| **entrance_local** | **String** | The local-language entrance fragment of the address. | [optional] |
+| **floor** | **String** | The floor fragment of the address. | [optional] |
+| **floor_local** | **String** | The local-language floor fragment of the address. | [optional] |
+| **apartment** | **String** | The apartment fragment of the address. | [optional] |
+| **apartment_local** | **String** | The local-language apartment fragment of the address. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::EvrotrustAddressComponents.new(
+  district: Sofia City,
+  district_local: Sofia City Local,
+  municipality: Stolichna,
+  municipality_local: Stolichna Local,
+  settlement: Sofia,
+  settlement_local: Sofia Local,
+  location: Vitosha Blvd,
+  location_local: Vitosha Blvd Local,
+  building_number: 2,
+  building_number_local: 2,
+  entrance: A,
+  entrance_local: A,
+  floor: 4,
+  floor_local: 4,
+  apartment: 12,
+  apartment_local: 12
+)
+```
+

data/docs/EvrotrustInput.md

@@ -0,0 +1,20 @@
+# TrinsicApi::EvrotrustInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email_address** | **String** | The user's email address.              Either an email address or phone number must be provided to identify the user. | [optional] |
+| **phone_number** | **String** | The user's phone number.              Either an email address or phone number must be provided to identify the user. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::EvrotrustInput.new(
+  email_address: null,
+  phone_number: null
+)
+```
+