trulioo_sdk 1.0.3

data/docs/LocationAdditionalFields.md

@@ -0,0 +1,18 @@
+# Trulioo::LocationAdditionalFields
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **address1** | **String** | Address1 is available in certain countries. It can be used to pass a compiled address field instead of sending individual address attributes (such as UnitNumber, BuidlingNumber, BuildingName, StreetName and StreetType).   GlobalGateway will provide a pass through of Address1 directly to connected datasources for the selected country.   Please note: each datasource requires the address fields to be configured in a certain manner, implementing and sending Address1 instead of individual address fields may affect your ability to verify this address. | [optional] |
+
+## Example
+
+```ruby
+require 'trulioo_sdk'
+
+instance = Trulioo::LocationAdditionalFields.new(
+  address1: null
+)
+```
+

data/docs/NationalId.md

@@ -0,0 +1,28 @@
+# Trulioo::NationalId
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **number** | **String** |  | [optional] |
+| **type** | **String** | Supported Types: NationalID, Health, SocialService, TaxIDNumber | [optional] |
+| **district_of_issue** | **String** | District that issued the ID | [optional] |
+| **city_of_issue** | **String** | City that issued the ID | [optional] |
+| **province_of_issue** | **String** | Province that issued the ID | [optional] |
+| **county_of_issue** | **String** | County that issued the ID | [optional] |
+
+## Example
+
+```ruby
+require 'trulioo_sdk'
+
+instance = Trulioo::NationalId.new(
+  number: null,
+  type: null,
+  district_of_issue: null,
+  city_of_issue: null,
+  province_of_issue: null,
+  county_of_issue: null
+)
+```
+

data/docs/NormalizedDatasourceField.md

@@ -0,0 +1,20 @@
+# Trulioo::NormalizedDatasourceField
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **field_name** | **String** | Field Name | [optional] |
+| **type** | **String** | Type | [optional] |
+
+## Example
+
+```ruby
+require 'trulioo_sdk'
+
+instance = Trulioo::NormalizedDatasourceField.new(
+  field_name: null,
+  type: null
+)
+```
+

data/docs/NormalizedDatasourceGroupCountry.md

@@ -0,0 +1,34 @@
+# Trulioo::NormalizedDatasourceGroupCountry
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Name | [optional] |
+| **description** | **String** | Description | [optional] |
+| **required_fields** | [**Array<NormalizedDatasourceField>**](NormalizedDatasourceField.md) | Required Fields | [optional] |
+| **optional_fields** | [**Array<NormalizedDatasourceField>**](NormalizedDatasourceField.md) | Optional Fields | [optional] |
+| **appended_fields** | [**Array<NormalizedDatasourceField>**](NormalizedDatasourceField.md) | Appended Fields | [optional] |
+| **output_fields** | [**Array<NormalizedDatasourceField>**](NormalizedDatasourceField.md) | Output Fields | [optional] |
+| **source_type** | **String** | Source Type | [optional] |
+| **update_frequency** | **String** | Update Frequency | [optional] |
+| **coverage** | **String** | Coverage | [optional] |
+
+## Example
+
+```ruby
+require 'trulioo_sdk'
+
+instance = Trulioo::NormalizedDatasourceGroupCountry.new(
+  name: null,
+  description: null,
+  required_fields: null,
+  optional_fields: null,
+  appended_fields: null,
+  output_fields: null,
+  source_type: null,
+  update_frequency: null,
+  coverage: null
+)
+```
+

data/docs/Passport.md

@@ -0,0 +1,28 @@
+# Trulioo::Passport
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mrz1** | **String** | Line 1 of the passport MRZ | [optional] |
+| **mrz2** | **String** | line 2 of the passport MRZ | [optional] |
+| **number** | **String** | Passport Number | [optional] |
+| **day_of_expiry** | **Integer** | Passport's Licence day of expiry of the individual to be verified | [optional] |
+| **month_of_expiry** | **Integer** | Passport's Licence month of expiry of the individual to be verified | [optional] |
+| **year_of_expiry** | **Integer** | Passport's Licence year of expiry of the individual to be verified | [optional] |
+
+## Example
+
+```ruby
+require 'trulioo_sdk'
+
+instance = Trulioo::Passport.new(
+  mrz1: null,
+  mrz2: null,
+  number: null,
+  day_of_expiry: null,
+  month_of_expiry: null,
+  year_of_expiry: null
+)
+```
+

data/docs/PersonInfo.md

@@ -0,0 +1,38 @@
+# Trulioo::PersonInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **first_given_name** | **String** | First name of the individual to be verified | [optional] |
+| **middle_name** | **String** | Second given name of the individual to be verified | [optional] |
+| **first_sur_name** | **String** | First (paternal) family name of the individual to be verified | [optional] |
+| **second_surname** | **String** | second family name of the individual to be verified | [optional] |
+| **iso_latin1_name** | **String** | Enter full name in ISO Latin-1 character set | [optional] |
+| **day_of_birth** | **Integer** | Day of birth date (e.g. 23 for a date of birth of 23/11/1975) | [optional] |
+| **month_of_birth** | **Integer** | Month of birth date (e.g. 11 for a date of birth of 23/11/1975) | [optional] |
+| **year_of_birth** | **Integer** | Year of birth date (e.g. 1975 for a date of birth of 23/11/1975) | [optional] |
+| **minimum_age** | **Integer** | Minimum permitted age of the individual | [optional] |
+| **gender** | **String** | Single character M / F (M = Male, F = Female) | [optional] |
+| **additional_fields** | [**PersonInfoAdditionalFields**](PersonInfoAdditionalFields.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'trulioo_sdk'
+
+instance = Trulioo::PersonInfo.new(
+  first_given_name: null,
+  middle_name: null,
+  first_sur_name: null,
+  second_surname: null,
+  iso_latin1_name: null,
+  day_of_birth: null,
+  month_of_birth: null,
+  year_of_birth: null,
+  minimum_age: null,
+  gender: null,
+  additional_fields: null
+)
+```
+

data/docs/PersonInfoAdditionalFields.md

@@ -0,0 +1,18 @@
+# Trulioo::PersonInfoAdditionalFields
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **full_name** | **String** | Full name of of the individual to be verified | [optional] |
+
+## Example
+
+```ruby
+require 'trulioo_sdk'
+
+instance = Trulioo::PersonInfoAdditionalFields.new(
+  full_name: null
+)
+```
+

data/docs/Record.md

@@ -0,0 +1,26 @@
+# Trulioo::Record
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **transaction_record_id** | **String** | The TransactionRecordID, this is the ID you will use to fetch the transaction again. | [optional] |
+| **record_status** | **String** | 'match' or 'nomatch' if the verification passed the rules configured on your account this will be 'match'. | [optional] |
+| **datasource_results** | [**Array<DatasourceResult>**](DatasourceResult.md) | Results for each datasource that was queried | [optional] |
+| **errors** | [**Array<ServiceError>**](ServiceError.md) |  | [optional] |
+| **rule** | [**RecordRule**](RecordRule.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'trulioo_sdk'
+
+instance = Trulioo::Record.new(
+  transaction_record_id: null,
+  record_status: null,
+  datasource_results: null,
+  errors: null,
+  rule: null
+)
+```
+

data/docs/RecordRule.md

@@ -0,0 +1,20 @@
+# Trulioo::RecordRule
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **rule_name** | **String** | Name of RecordRule. | [optional] |
+| **note** | **String** | Rule Description. | [optional] |
+
+## Example
+
+```ruby
+require 'trulioo_sdk'
+
+instance = Trulioo::RecordRule.new(
+  rule_name: null,
+  note: null
+)
+```
+

data/docs/Result.md

@@ -0,0 +1,62 @@
+# Trulioo::Result
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **index** | **String** |  | [optional] |
+| **business_name** | **String** |  | [optional] |
+| **matching_score** | **String** |  | [optional] |
+| **business_registration_number** | **String** |  | [optional] |
+| **duns_number** | **String** |  | [optional] |
+| **business_tax_id_number** | **String** |  | [optional] |
+| **business_license_number** | **String** |  | [optional] |
+| **jurisdiction_of_incorporation** | **String** |  | [optional] |
+| **full_address** | **String** |  | [optional] |
+| **business_status** | **String** | Business Status | [optional] |
+| **trade_style_name** | **String** | Trade Style Name | [optional] |
+| **business_type** | **String** | Business Type | [optional] |
+| **address** | [**Address**](Address.md) |  | [optional] |
+| **other_business_names** | **Array<String>** |  | [optional] |
+| **website** | **String** |  | [optional] |
+| **telephone** | **String** |  | [optional] |
+| **tax_id_number** | **String** |  | [optional] |
+| **tax_id_numbers** | **Array<String>** |  | [optional] |
+| **email_address** | **String** |  | [optional] |
+| **web_domain** | **String** |  | [optional] |
+| **web_domains** | **Array<String>** |  | [optional] |
+| **naics** | [**Array<BusinessSearchResponseIndustryCode>**](BusinessSearchResponseIndustryCode.md) | North American Industry Classification System | [optional] |
+| **sic** | [**Array<BusinessSearchResponseIndustryCode>**](BusinessSearchResponseIndustryCode.md) | Standard Industrial Classification | [optional] |
+
+## Example
+
+```ruby
+require 'trulioo_sdk'
+
+instance = Trulioo::Result.new(
+  index: null,
+  business_name: null,
+  matching_score: null,
+  business_registration_number: null,
+  duns_number: null,
+  business_tax_id_number: null,
+  business_license_number: null,
+  jurisdiction_of_incorporation: null,
+  full_address: null,
+  business_status: null,
+  trade_style_name: null,
+  business_type: null,
+  address: null,
+  other_business_names: null,
+  website: null,
+  telephone: null,
+  tax_id_number: null,
+  tax_id_numbers: null,
+  email_address: null,
+  web_domain: null,
+  web_domains: null,
+  naics: null,
+  sic: null
+)
+```
+

data/docs/ServiceError.md

@@ -0,0 +1,20 @@
+# Trulioo::ServiceError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** |  | [optional] |
+| **message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'trulioo_sdk'
+
+instance = Trulioo::ServiceError.new(
+  code: null,
+  message: null
+)
+```
+

data/docs/TestEntityDataFields.md

@@ -0,0 +1,36 @@
+# Trulioo::TestEntityDataFields
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **test_entity_name** | **String** | Friendly name for the test entity | [optional] |
+| **person_info** | [**PersonInfo**](PersonInfo.md) |  | [optional] |
+| **location** | [**Location**](Location.md) |  | [optional] |
+| **communication** | [**Communication**](Communication.md) |  | [optional] |
+| **driver_licence** | [**DriverLicence**](DriverLicence.md) |  | [optional] |
+| **national_ids** | [**Array<NationalId>**](NationalId.md) | National Identification Information | [optional] |
+| **passport** | [**Passport**](Passport.md) |  | [optional] |
+| **document** | [**Document**](Document.md) |  | [optional] |
+| **business** | [**Business**](Business.md) |  | [optional] |
+| **country_specific** | **Hash<String, Hash<String, String>>** | CountrySpecific fields  {\"CountryCode\" : {\"Field1\" : \"Value\",  \"Field2\" : \"Value\"  }} | [optional] |
+
+## Example
+
+```ruby
+require 'trulioo_sdk'
+
+instance = Trulioo::TestEntityDataFields.new(
+  test_entity_name: null,
+  person_info: null,
+  location: null,
+  communication: null,
+  driver_licence: null,
+  national_ids: null,
+  passport: null,
+  document: null,
+  business: null,
+  country_specific: null
+)
+```
+

data/docs/TransactionRecordResult.md

@@ -0,0 +1,32 @@
+# Trulioo::TransactionRecordResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **transaction_id** | **String** | The id for the transaction it will be a GUID | [optional] |
+| **uploaded_dt** | **Time** | Time in UTC | [optional] |
+| **country_code** | **String** | Country Code | [optional] |
+| **product_name** | **String** | Product Name | [optional] |
+| **record** | [**Record**](Record.md) |  | [optional] |
+| **customer_reference_id** | **String** | Customer Reference Id | [optional] |
+| **errors** | [**Array<ServiceError>**](ServiceError.md) |  | [optional] |
+| **input_fields** | [**Array<DataField>**](DataField.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'trulioo_sdk'
+
+instance = Trulioo::TransactionRecordResult.new(
+  transaction_id: null,
+  uploaded_dt: null,
+  country_code: null,
+  product_name: null,
+  record: null,
+  customer_reference_id: null,
+  errors: null,
+  input_fields: null
+)
+```
+

data/docs/TransactionRecordResultAllOf.md

@@ -0,0 +1,18 @@
+# Trulioo::TransactionRecordResultAllOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **input_fields** | [**Array<DataField>**](DataField.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'trulioo_sdk'
+
+instance = Trulioo::TransactionRecordResultAllOf.new(
+  input_fields: null
+)
+```
+

data/docs/TransactionStatus.md

@@ -0,0 +1,26 @@
+# Trulioo::TransactionStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **transaction_id** | **String** | Transaction ID of the transaction | [optional] |
+| **transaction_record_id** | **String** | Transaction Record ID of the transaction available once the transaction has finished processing | [optional] |
+| **status** | **String** | Status of the transaction. Possible Values: Uploading, Processing, Completed, InProgress, Failed, WaitAsync, ToBeResumed, Canceled, TimeoutCanceled. Call GetTransactionRecord when status changes to Completed, Failed, Canceled or TimeoutCanceled to get the verification results. | [optional] |
+| **uploaded_dt** | **Time** | Uploaded date for transaction | [optional] |
+| **is_timed_out** | **Boolean** | Set to true when transaction has timed out | [optional] |
+
+## Example
+
+```ruby
+require 'trulioo_sdk'
+
+instance = Trulioo::TransactionStatus.new(
+  transaction_id: null,
+  transaction_record_id: null,
+  status: null,
+  uploaded_dt: null,
+  is_timed_out: null
+)
+```
+