trinsic_api 3.0.1 → 3.0.2.pre.preview

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (122) hide show
  1. checksums.yaml +4 -4
  2. data/docs/AadhaarClaims.md +46 -0
  3. data/docs/AadhaarLanguage.md +20 -0
  4. data/docs/AadhaarLocalizedClaims.md +40 -0
  5. data/docs/AppleWalletInput.md +3 -1
  6. data/docs/ConnectIdAddress.md +26 -0
  7. data/docs/ConnectIdAgeVerification.md +20 -0
  8. data/docs/ConnectIdBeneficiaryAccount.md +24 -0
  9. data/docs/ConnectIdProviderOutput.md +38 -0
  10. data/docs/CzechMojeIdAddressOutput.md +28 -0
  11. data/docs/CzechMojeIdProviderOutput.md +62 -0
  12. data/docs/DigilockerAadhaarProviderOutput.md +30 -0
  13. data/docs/FaydaProviderOutput.md +7 -1
  14. data/docs/FinnishTrustNetworkProviderOutput.md +38 -0
  15. data/docs/FranceIdentiteInput.md +18 -0
  16. data/docs/FranceIdentiteProviderOutput.md +18 -0
  17. data/docs/FrejaIndirectProviderOutput.md +24 -0
  18. data/docs/FrejaProviderOutput.md +36 -8
  19. data/docs/GetProviderResponse.md +18 -0
  20. data/docs/GoogleWalletInput.md +3 -1
  21. data/docs/NigeriaNinLookup2ProviderOutput.md +40 -0
  22. data/docs/NorwegianBankIdProviderOutput.md +32 -0
  23. data/docs/OneIdProviderAddress.md +26 -0
  24. data/docs/OneIdProviderOutput.md +28 -0
  25. data/docs/OutputFrejaAddress.md +24 -0
  26. data/docs/OutputFrejaDocument.md +24 -0
  27. data/docs/PhilippinesDigitalNidProviderOutput.md +21 -1
  28. data/docs/PhilippinesPhysicalNidProviderOutput.md +17 -1
  29. data/docs/ProviderInput.md +6 -0
  30. data/docs/ProviderOutput.md +24 -2
  31. data/docs/ProvidersApi.md +70 -0
  32. data/docs/Raw18013DocumentRequest.md +20 -0
  33. data/docs/Raw18013RequestInput.md +18 -0
  34. data/docs/RecommendProvidersResponse.md +3 -1
  35. data/docs/SamsungWalletInput.md +18 -0
  36. data/docs/UkEvisaLookupInput.md +20 -0
  37. data/docs/UnitedKingdomEvisaProviderOutput.md +38 -0
  38. data/docs/VerificationProfileResponse.md +2 -0
  39. data/docs/VerificationProfilesApi.md +4 -0
  40. data/docs/YotiDeeplinkProviderOutput.md +40 -0
  41. data/lib/trinsic_api/api/providers_api.rb +63 -0
  42. data/lib/trinsic_api/api/verification_profiles_api.rb +6 -0
  43. data/lib/trinsic_api/models/aadhaar_claims.rb +376 -0
  44. data/lib/trinsic_api/models/aadhaar_language.rb +250 -0
  45. data/lib/trinsic_api/models/aadhaar_localized_claims.rb +343 -0
  46. data/lib/trinsic_api/models/apple_wallet_input.rb +16 -5
  47. data/lib/trinsic_api/models/connect_id_address.rb +266 -0
  48. data/lib/trinsic_api/models/connect_id_age_verification.rb +233 -0
  49. data/lib/trinsic_api/models/connect_id_beneficiary_account.rb +255 -0
  50. data/lib/trinsic_api/models/connect_id_provider_output.rb +333 -0
  51. data/lib/trinsic_api/models/czech_moje_id_address_output.rb +277 -0
  52. data/lib/trinsic_api/models/czech_moje_id_provider_output.rb +465 -0
  53. data/lib/trinsic_api/models/digilocker_aadhaar_provider_output.rb +305 -0
  54. data/lib/trinsic_api/models/fayda_provider_output.rb +38 -5
  55. data/lib/trinsic_api/models/finnish_trust_network_provider_output.rb +333 -0
  56. data/lib/trinsic_api/models/france_identite_input.rb +222 -0
  57. data/lib/trinsic_api/models/france_identite_provider_output.rb +239 -0
  58. data/lib/trinsic_api/models/freja_indirect_provider_output.rb +320 -0
  59. data/lib/trinsic_api/models/freja_provider_output.rb +185 -91
  60. data/lib/trinsic_api/models/get_provider_response.rb +238 -0
  61. data/lib/trinsic_api/models/google_wallet_input.rb +16 -5
  62. data/lib/trinsic_api/models/integration_step.rb +1 -1
  63. data/lib/trinsic_api/models/nigeria_nin_lookup2_provider_output.rb +392 -0
  64. data/lib/trinsic_api/models/norwegian_bank_id_provider_output.rb +300 -0
  65. data/lib/trinsic_api/models/one_id_provider_address.rb +266 -0
  66. data/lib/trinsic_api/models/one_id_provider_output.rb +278 -0
  67. data/lib/trinsic_api/models/output_freja_address.rb +255 -0
  68. data/lib/trinsic_api/models/output_freja_document.rb +255 -0
  69. data/lib/trinsic_api/models/philippines_digital_nid_provider_output.rb +114 -4
  70. data/lib/trinsic_api/models/philippines_physical_nid_provider_output.rb +92 -4
  71. data/lib/trinsic_api/models/provider_input.rb +34 -1
  72. data/lib/trinsic_api/models/provider_output.rb +127 -6
  73. data/lib/trinsic_api/models/raw18013_document_request.rb +276 -0
  74. data/lib/trinsic_api/models/raw18013_request_input.rb +259 -0
  75. data/lib/trinsic_api/models/recommend_providers_response.rb +33 -4
  76. data/lib/trinsic_api/models/samsung_wallet_input.rb +222 -0
  77. data/lib/trinsic_api/models/uk_evisa_lookup_input.rb +283 -0
  78. data/lib/trinsic_api/models/united_kingdom_evisa_provider_output.rb +333 -0
  79. data/lib/trinsic_api/models/verification_profile_response.rb +28 -1
  80. data/lib/trinsic_api/models/yoti_deeplink_provider_output.rb +344 -0
  81. data/lib/trinsic_api/version.rb +1 -1
  82. data/lib/trinsic_api.rb +27 -0
  83. data/spec/api/providers_api_spec.rb +12 -0
  84. data/spec/api/verification_profiles_api_spec.rb +2 -0
  85. data/spec/models/aadhaar_claims_spec.rb +120 -0
  86. data/spec/models/aadhaar_language_spec.rb +42 -0
  87. data/spec/models/aadhaar_localized_claims_spec.rb +102 -0
  88. data/spec/models/apple_wallet_input_spec.rb +6 -0
  89. data/spec/models/connect_id_address_spec.rb +60 -0
  90. data/spec/models/connect_id_age_verification_spec.rb +42 -0
  91. data/spec/models/connect_id_beneficiary_account_spec.rb +54 -0
  92. data/spec/models/connect_id_provider_output_spec.rb +96 -0
  93. data/spec/models/czech_moje_id_address_output_spec.rb +66 -0
  94. data/spec/models/czech_moje_id_provider_output_spec.rb +168 -0
  95. data/spec/models/digilocker_aadhaar_provider_output_spec.rb +72 -0
  96. data/spec/models/fayda_provider_output_spec.rb +18 -0
  97. data/spec/models/finnish_trust_network_provider_output_spec.rb +96 -0
  98. data/spec/models/france_identite_input_spec.rb +36 -0
  99. data/spec/models/france_identite_provider_output_spec.rb +36 -0
  100. data/spec/models/freja_indirect_provider_output_spec.rb +54 -0
  101. data/spec/models/freja_provider_output_spec.rb +88 -4
  102. data/spec/models/get_provider_response_spec.rb +36 -0
  103. data/spec/models/google_wallet_input_spec.rb +6 -0
  104. data/spec/models/nigeria_nin_lookup2_provider_output_spec.rb +102 -0
  105. data/spec/models/norwegian_bank_id_provider_output_spec.rb +78 -0
  106. data/spec/models/one_id_provider_address_spec.rb +60 -0
  107. data/spec/models/one_id_provider_output_spec.rb +66 -0
  108. data/spec/models/output_freja_address_spec.rb +54 -0
  109. data/spec/models/output_freja_document_spec.rb +54 -0
  110. data/spec/models/philippines_digital_nid_provider_output_spec.rb +60 -0
  111. data/spec/models/philippines_physical_nid_provider_output_spec.rb +48 -0
  112. data/spec/models/provider_input_spec.rb +18 -0
  113. data/spec/models/provider_output_spec.rb +66 -0
  114. data/spec/models/raw18013_document_request_spec.rb +42 -0
  115. data/spec/models/raw18013_request_input_spec.rb +36 -0
  116. data/spec/models/recommend_providers_response_spec.rb +6 -0
  117. data/spec/models/samsung_wallet_input_spec.rb +36 -0
  118. data/spec/models/uk_evisa_lookup_input_spec.rb +42 -0
  119. data/spec/models/united_kingdom_evisa_provider_output_spec.rb +96 -0
  120. data/spec/models/verification_profile_response_spec.rb +6 -0
  121. data/spec/models/yoti_deeplink_provider_output_spec.rb +102 -0
  122. metadata +230 -122
@@ -0,0 +1,32 @@
1
+ # TrinsicApi::NorwegianBankIdProviderOutput
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **full_name** | **String** | The full name of the individual. | [optional] |
8
+ | **date_of_birth** | **Date** | The date of birth of the individual. | [optional] |
9
+ | **personal_identifier** | **String** | The personal identifier for Norwegian BankID. This uniquely identifies the user in the Norwegian BankID system and is considered a stable identifier to use. | [optional] |
10
+ | **national_identity_number** | **String** | The 11-digit Norwegian National Identity Number (fødselsnummer) of the verified individual. This is in the format DDMMYYZZZCC, where: - DDMMYY is the date of birth (In some cases, this is not the date of birth due to no available identity numbers for some dates - ZZZ is an individual number, indicating gender - CC is a checksum character If ZZZ is even, the individual is female. If ZZZ is odd, the individual is male. | [optional] |
11
+ | **given_name** | **String** | The given name of the individual. | [optional] |
12
+ | **family_name** | **String** | The family name of the individual. | [optional] |
13
+ | **level_of_assurance** | **String** | The level of assurance (LOA) for the verification. The LOA refers to the degree of confidence in the claimed identity of a person. The European Digital Identity Framework (EUDI) measures the confidence of the digital identity's verification and authentication strength by a set of requirements for different levels. To learn more, see: https://ec.europa.eu/digital-building-blocks/sites/spaces/DIGITAL/pages/467110081/eIDAS+Levels+of+Assurance Possible values: - Low: The user has self asserted their identity and multifactor authentication is not required. - Substantial: The user has performed either a remote or in-person identity verification and multifactor authentication is required. - High: The user has performed an in-person identity proofing with an authorized representative and has strong cryptographic authentication requirements such as using a smart card. | [optional] |
14
+ | **authentication_method** | **String** | The authentication method used by the individual. Possible values: - urn:bankid:bis - BankID with Biometrics - urn:bankid:bid - Standard BankID with High Assurance | [optional] |
15
+
16
+ ## Example
17
+
18
+ ```ruby
19
+ require 'trinsic_api'
20
+
21
+ instance = TrinsicApi::NorwegianBankIdProviderOutput.new(
22
+ full_name: Ove Henriksen,
23
+ date_of_birth: Sun Aug 15 00:00:00 UTC 1943,
24
+ personal_identifier: 9578-5999-4-1765512,
25
+ national_identity_number: 30069012345,
26
+ given_name: Ole,
27
+ family_name: Olsen,
28
+ level_of_assurance: High,
29
+ authentication_method: urn:bankid:bis
30
+ )
31
+ ```
32
+
@@ -0,0 +1,26 @@
1
+ # TrinsicApi::OneIdProviderAddress
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **street_address** | **String** | The line or street portion of the address. | [optional] |
8
+ | **locality** | **String** | The locality or city portion of the address. | [optional] |
9
+ | **region** | **String** | The region or subdivision portion of the address. | [optional] |
10
+ | **postal_code** | **String** | The postal code of the address. | [optional] |
11
+ | **country_code** | **String** | The alpha-2 country code of the address. | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'trinsic_api'
17
+
18
+ instance = TrinsicApi::OneIdProviderAddress.new(
19
+ street_address: 80 Temple Way, Winterton-On-Sea,
20
+ locality: Great Yarmouth,
21
+ region: Norfolk,
22
+ postal_code: NR29 9QS,
23
+ country_code: GB
24
+ )
25
+ ```
26
+
@@ -0,0 +1,28 @@
1
+ # TrinsicApi::OneIdProviderOutput
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **sub** | **String** | The OpenID Connect (OIDC) subject identifier (sub). | [optional] |
8
+ | **full_name** | **String** | The individual's full name. | [optional] |
9
+ | **given_name** | **String** | The individual's given name. | [optional] |
10
+ | **family_name** | **String** | The individual's family name. | [optional] |
11
+ | **birthdate** | **Date** | The date of birth of the individual. | [optional] |
12
+ | **address** | [**OneIdProviderAddress**](OneIdProviderAddress.md) | The address of the individual. | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'trinsic_api'
18
+
19
+ instance = TrinsicApi::OneIdProviderOutput.new(
20
+ sub: 458924ee-f856-59ad-ae9f-6de2429a3c74,
21
+ full_name: John Smith,
22
+ given_name: John,
23
+ family_name: Smith,
24
+ birthdate: Thu Jan 31 00:00:00 UTC 1985,
25
+ address: null
26
+ )
27
+ ```
28
+
@@ -0,0 +1,24 @@
1
+ # TrinsicApi::OutputFrejaAddress
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **line1** | **String** | The line1 portion of the address. Incorporates all address details that are not included by city, postal code, and country. | [optional] |
8
+ | **city** | **String** | The name of the city associated with the address. | [optional] |
9
+ | **postal_code** | **String** | The postal code associated with the address. | [optional] |
10
+ | **country** | **String** | The ISO 3166-1 alpha-2 country code associated with the address. | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'trinsic_api'
16
+
17
+ instance = TrinsicApi::OutputFrejaAddress.new(
18
+ line1: 123 Residential St,
19
+ city: New York,
20
+ postal_code: 12345,
21
+ country: SE
22
+ )
23
+ ```
24
+
@@ -0,0 +1,24 @@
1
+ # TrinsicApi::OutputFrejaDocument
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **type** | **String** | Type of document. Possible values are: * \"PASS\": Passport * \"DRILIC\": Driver's License * \"NATID\": National ID * \"IDSIS\": SiS certified ID document * \"TAXID\": Tax Agency ID card * \"OTHERID\": Other IDs | [optional] |
8
+ | **serial_number** | **String** | The document serial number. The structure of this number depends on the type and nationality of the document. | [optional] |
9
+ | **expiration_date** | **Date** | Expiration date of the document. Formatted as an ISO 8601 Date. | [optional] |
10
+ | **country** | **String** | The ISO 3166-1 alpha-2 country code associated with the document. | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'trinsic_api'
16
+
17
+ instance = TrinsicApi::OutputFrejaDocument.new(
18
+ type: PASS,
19
+ serial_number: SA1234567890,
20
+ expiration_date: Sun Dec 31 00:00:00 UTC 2028,
21
+ country: SE
22
+ )
23
+ ```
24
+
@@ -5,6 +5,16 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **philsys_card_number** | **String** | The PhilSys Card Number (PCN). Every citizen or resident alien registered in PhilSys has a PhilSys Number (PSN). This number is tokenized into a card number to protect the PSN. The PhilSys Card Number is 12 characters long, and often is written in octets with dashes in between. | |
8
+ | **given_name** | **String** | The given (first) name of the individual. | [optional] |
9
+ | **middle_name** | **String** | The middle name of the individual. | [optional] |
10
+ | **family_name** | **String** | The family (last) name of the individual. | [optional] |
11
+ | **date_of_birth** | **Date** | The date of birth of the individual. | [optional] |
12
+ | **suffix** | **String** | The name suffix of the individual (e.g. Jr., III). | [optional] |
13
+ | **sex** | **String** | The sex of the individual. Possible values: - Male - Female | [optional] |
14
+ | **place_of_birth** | **String** | The place of birth of the individual as recorded on the PhilSys credential. | [optional] |
15
+ | **document_issue_date** | **Date** | The date the document was issued. | [optional] |
16
+ | **document_number** | **String** | The document number of the digital National ID. | [optional] |
17
+ | **issuing_authority** | **String** | The issuing authority of the document. | [optional] |
8
18
 
9
19
  ## Example
10
20
 
@@ -12,7 +22,17 @@
12
22
  require 'trinsic_api'
13
23
 
14
24
  instance = TrinsicApi::PhilippinesDigitalNidProviderOutput.new(
15
- philsys_card_number: 1234-5678-9101-1213
25
+ philsys_card_number: 1234-5678-9101-1213,
26
+ given_name: Juan,
27
+ middle_name: Santos,
28
+ family_name: Dela Cruz,
29
+ date_of_birth: Thu Jan 31 00:00:00 UTC 1985,
30
+ suffix: Jr.,
31
+ sex: Male,
32
+ place_of_birth: Manila,
33
+ document_issue_date: Fri Mar 15 00:00:00 UTC 2024,
34
+ document_number: 12345678901234,
35
+ issuing_authority: Philippine Statistics Authority
16
36
  )
17
37
  ```
18
38
 
@@ -5,6 +5,14 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **philsys_card_number** | **String** | The PhilSys Card Number (PCN). Every citizen or resident alien registered in PhilSys has a PhilSys Number (PSN). This number is tokenized into a card number to protect the PSN. The PhilSys Card Number is 12 characters long, and often is written in octets with dashes in between. | |
8
+ | **given_name** | **String** | The given (first) name of the individual. | [optional] |
9
+ | **middle_name** | **String** | The middle name of the individual. | [optional] |
10
+ | **family_name** | **String** | The family (last) name of the individual. | [optional] |
11
+ | **date_of_birth** | **Date** | The date of birth of the individual. | [optional] |
12
+ | **suffix** | **String** | The name suffix of the individual (e.g. Jr., III). | [optional] |
13
+ | **sex** | **String** | The sex of the individual. Possible values: - Male - Female | [optional] |
14
+ | **place_of_birth** | **String** | The place of birth of the individual as recorded on the PhilSys credential. | [optional] |
15
+ | **document_issue_date** | **Date** | The date the document was issued. | [optional] |
8
16
 
9
17
  ## Example
10
18
 
@@ -12,7 +20,15 @@
12
20
  require 'trinsic_api'
13
21
 
14
22
  instance = TrinsicApi::PhilippinesPhysicalNidProviderOutput.new(
15
- philsys_card_number: 1234-5678-9101-1213
23
+ philsys_card_number: 1234-5678-9101-1213,
24
+ given_name: Juan,
25
+ middle_name: Santos,
26
+ family_name: Dela Cruz,
27
+ date_of_birth: Thu Jan 31 00:00:00 UTC 1985,
28
+ suffix: Jr.,
29
+ sex: Male,
30
+ place_of_birth: Manila,
31
+ document_issue_date: Fri Mar 15 00:00:00 UTC 2024
16
32
  )
17
33
  ```
18
34
 
@@ -34,7 +34,10 @@
34
34
  | **italy_spid** | [**SpidInput**](SpidInput.md) | Input for the `italy-spid` provider | [optional] |
35
35
  | **google_wallet** | [**GoogleWalletInput**](GoogleWalletInput.md) | Input for the `google-wallet` provider | [optional] |
36
36
  | **apple_wallet** | [**AppleWalletInput**](AppleWalletInput.md) | Input for the `apple-wallet` provider | [optional] |
37
+ | **samsung_wallet** | [**SamsungWalletInput**](SamsungWalletInput.md) | Input for the `samsung-wallet` provider | [optional] |
38
+ | **france_identite** | [**FranceIdentiteInput**](FranceIdentiteInput.md) | Input for the `france-identite` provider | [optional] |
37
39
  | **peru_dni_lookup** | [**PeruDniLookupInput**](PeruDniLookupInput.md) | Input for the `peru-dni-lookup` provider | [optional] |
40
+ | **uk_evisa_lookup** | [**UkEvisaLookupInput**](UkEvisaLookupInput.md) | Input for the `uk-evisa-lookup` provider | [optional] |
38
41
  | **trinsic_test_database_lookup** | [**TrinsicTestDatabaseLookupInput**](TrinsicTestDatabaseLookupInput.md) | *TEST MODE ONLY.* Input for the `trinsic-test-database-lookup` provider | [optional] |
39
42
  | **trinsic_test_sub_providers** | [**TrinsicTestSubProvidersInput**](TrinsicTestSubProvidersInput.md) | *TEST MODE ONLY.* Input for the `trinsic-test-sub-providers` provider | [optional] |
40
43
 
@@ -74,7 +77,10 @@ instance = TrinsicApi::ProviderInput.new(
74
77
  italy_spid: null,
75
78
  google_wallet: null,
76
79
  apple_wallet: null,
80
+ samsung_wallet: null,
81
+ france_identite: null,
77
82
  peru_dni_lookup: null,
83
+ uk_evisa_lookup: null,
78
84
  trinsic_test_database_lookup: null,
79
85
  trinsic_test_sub_providers: null
80
86
  )
@@ -9,34 +9,45 @@
9
9
  | **a_edoapp_eid_login** | [**PolandEdoAppProviderOutput**](PolandEdoAppProviderOutput.md) | Exposed properties for the `a-edoapp-eid-login` Provider which do not directly map to the normalized IdentityData model. | [optional] |
10
10
  | **a_ee_web_eid_login** | [**EstoniaIdCardProviderOutput**](EstoniaIdCardProviderOutput.md) | Exposed properties for the `a-ee-web-eid-login` Provider which do not directly map to the normalized IdentityData model. | [optional] |
11
11
  | **a_fi_id_login** | [**FinlandIdCardProviderOutput**](FinlandIdCardProviderOutput.md) | Exposed properties for the `a-fi-id-login` Provider which do not directly map to the normalized IdentityData model. | [optional] |
12
- | **a_freja_eid_login** | [**FrejaProviderOutput**](FrejaProviderOutput.md) | Exposed properties for the `a-freja-eid-login` Provider which do not directly map to the normalized IdentityData model. | [optional] |
12
+ | **a_freja_eid_login** | [**FrejaIndirectProviderOutput**](FrejaIndirectProviderOutput.md) | Exposed properties for the `a-freja-eid-login` Provider which do not directly map to the normalized IdentityData model. | [optional] |
13
13
  | **a_itsme_login** | [**ItsmeProviderOutput**](ItsmeProviderOutput.md) | Exposed properties for the `a-itsme-login` Provider which do not directly map to the normalized IdentityData model. | [optional] |
14
14
  | **a_lt_id_login** | [**LithuaniaIdCardProviderOutput**](LithuaniaIdCardProviderOutput.md) | Exposed properties for the `a-lt-id-login` Provider which do not directly map to the normalized IdentityData model. | [optional] |
15
15
  | **a_lv_eparaksts_id_login** | [**LatviaEparakstsProviderOutput**](LatviaEparakstsProviderOutput.md) | Exposed properties for the `a-lv-eparaksts-id-login` Provider which do not directly map to the normalized IdentityData model. | [optional] |
16
16
  | **a_lv_eparaksts_mobile_login** | [**LatviaEparakstsMobileProviderOutput**](LatviaEparakstsMobileProviderOutput.md) | Exposed properties for the `a-lv-eparaksts-mobile-login` Provider which do not directly map to the normalized IdentityData model. | [optional] |
17
17
  | **a_mojeid** | [**CzechiaMojeIdProviderOutput**](CzechiaMojeIdProviderOutput.md) | Exposed properties for the `a-mojeid` Provider which do not directly map to the normalized IdentityData model. | [optional] |
18
18
  | **a_pl_mojeid_login** | [**PolandMojeIdProviderOutput**](PolandMojeIdProviderOutput.md) | Exposed properties for the `a-pl-mojeid-login` Provider which do not directly map to the normalized IdentityData model. | [optional] |
19
+ | **australia_connect_id** | [**ConnectIdProviderOutput**](ConnectIdProviderOutput.md) | Exposed properties for the `australia-connect-id` Provider which do not directly map to the normalized IdentityData model. | [optional] |
20
+ | **czech_republic_mojeid** | [**CzechMojeIdProviderOutput**](CzechMojeIdProviderOutput.md) | Exposed properties for the `czech-moje-id` Provider which do not directly map to the normalized IdentityData model. | [optional] |
19
21
  | **a_pt_id_login** | [**PortugalIdCardProviderOutput**](PortugalIdCardProviderOutput.md) | Exposed properties for the `a-pt-id-login` Provider which do not directly map to the normalized IdentityData model. | [optional] |
20
22
  | **a_rs_id_login** | [**SerbiaIdCardProviderOutput**](SerbiaIdCardProviderOutput.md) | Exposed properties for the `a-rs-id-login` Provider which do not directly map to the normalized IdentityData model. | [optional] |
21
23
  | **apple_wallet** | [**AppleWalletProviderOutput**](AppleWalletProviderOutput.md) | Exposed properties for the `apple-wallet` Provider which do not directly map to the normalized IdentityData model. | [optional] |
22
24
  | **denmark_mitid** | [**MitIdProviderOutput**](MitIdProviderOutput.md) | Exposed properties for the `denmark-mitid` Provider which do not directly map to the normalized IdentityData model. | [optional] |
23
25
  | **ethiopia_fayda** | [**FaydaProviderOutput**](FaydaProviderOutput.md) | Exposed properties for the `ethiopia-fayda` Provider which do not directly map to the normalized IdentityData model. | [optional] |
26
+ | **finnish_trust_network** | [**FinnishTrustNetworkProviderOutput**](FinnishTrustNetworkProviderOutput.md) | Exposed properties for the `finnish-trust-network` Provider which do not directly map to the normalized IdentityData model. | [optional] |
27
+ | **france_identite** | [**FranceIdentiteProviderOutput**](FranceIdentiteProviderOutput.md) | Exposed properties for the `france-identite` Provider which do not directly map to the normalized IdentityData model. | [optional] |
24
28
  | **france_identite_numerique** | [**FrenchNumeriqueProviderOutput**](FrenchNumeriqueProviderOutput.md) | Exposed properties for the `france-identite-numerique` Provider which do not directly map to the normalized IdentityData model. | [optional] |
29
+ | **freja** | [**FrejaProviderOutput**](FrejaProviderOutput.md) | Exposed properties for the `freja` Provider which do not directly map to the normalized IdentityData model. | [optional] |
25
30
  | **google_wallet** | [**GoogleWalletProviderOutput**](GoogleWalletProviderOutput.md) | Exposed properties for the `google-wallet` Provider which do not directly map to the normalized IdentityData model. | [optional] |
31
+ | **india_digilocker_aadhaar** | [**DigilockerAadhaarProviderOutput**](DigilockerAadhaarProviderOutput.md) | Exposed properties for the `india-digilocker-aadhaar` Provider which do not directly map to the normalized IdentityData model. | [optional] |
26
32
  | **italy_spid** | [**SpidProviderOutput**](SpidProviderOutput.md) | Exposed properties for the `italy-spid` Provider which do not directly map to the normalized IdentityData model. | [optional] |
27
33
  | **kenya_nid_lookup_2** | [**KenyaNidLookup2ProviderOutput**](KenyaNidLookup2ProviderOutput.md) | Exposed properties for the `kenya-nid-lookup-2` Provider which do not directly map to the normalized IdentityData model. | [optional] |
28
34
  | **lloyds_smart_id** | [**LloydsSmartIdProviderOutput**](LloydsSmartIdProviderOutput.md) | Exposed properties for the `lloyds-smart-id` Provider which do not directly map to the normalized IdentityData model. | [optional] |
29
35
  | **mexico_curp_lookup** | [**MexicoCurpProviderOutput**](MexicoCurpProviderOutput.md) | Exposed properties for the `mexico-curp-lookup` Provider which do not directly map to the normalized IdentityData model. | [optional] |
30
36
  | **mobile_id** | [**MobileIdProviderOutput**](MobileIdProviderOutput.md) | Exposed properties for the `mobile-id` Provider which do not directly map to the normalized IdentityData model. | [optional] |
37
+ | **nigeria_nin_lookup_2** | [**NigeriaNinLookup2ProviderOutput**](NigeriaNinLookup2ProviderOutput.md) | Exposed properties for the `nigeria-nin-lookup-2` Provider which do not directly map to the normalized IdentityData model. | [optional] |
38
+ | **oneid** | [**OneIdProviderOutput**](OneIdProviderOutput.md) | Exposed properties for the `oneid` Provider which do not directly map to the normalized IdentityData model. | [optional] |
31
39
  | **peru_dni_lookup** | [**PeruDniProviderOutput**](PeruDniProviderOutput.md) | Exposed properties for the `peru-dni-lookup` Provider which do not directly map to the normalized IdentityData model. | [optional] |
40
+ | **norway_bankid** | [**NorwegianBankIdProviderOutput**](NorwegianBankIdProviderOutput.md) | Exposed properties for the `norway-bankid` Provider which do not directly map to the normalized IdentityData model. | [optional] |
32
41
  | **philippines_digital_national_id_qr** | [**PhilippinesDigitalNidProviderOutput**](PhilippinesDigitalNidProviderOutput.md) | Exposed properties for the `philippines-digital-national-id-qr` Provider which do not directly map to the normalized IdentityData model. | [optional] |
33
42
  | **philippines_physical_national_id_qr** | [**PhilippinesPhysicalNidProviderOutput**](PhilippinesPhysicalNidProviderOutput.md) | Exposed properties for the `philippines-physical-national-id-qr` Provider which do not directly map to the normalized IdentityData model. | [optional] |
34
43
  | **post_office_easyid** | [**PostOfficeEasyIdProviderOutput**](PostOfficeEasyIdProviderOutput.md) | Exposed properties for the `post-office-easyid` Provider which do not directly map to the normalized IdentityData model. | [optional] |
35
44
  | **samsung_wallet** | [**SamsungWalletProviderOutput**](SamsungWalletProviderOutput.md) | Exposed properties for the `samsung-wallet` Provider which do not directly map to the normalized IdentityData model. | [optional] |
36
45
  | **smart_id** | [**SmartIdProviderOutput**](SmartIdProviderOutput.md) | Exposed properties for the `smart-id` Provider which do not directly map to the normalized IdentityData model. | [optional] |
46
+ | **uk_evisa_lookup** | [**UnitedKingdomEvisaProviderOutput**](UnitedKingdomEvisaProviderOutput.md) | Exposed properties for the `uk-evisa-lookup` Provider which do not directly map to the normalized IdentityData model. | [optional] |
37
47
  | **sweden_bankid** | [**SwedenBankIdProviderOutput**](SwedenBankIdProviderOutput.md) | Exposed properties for the `sweden-bankid` Provider which do not directly map to the normalized IdentityData model. | [optional] |
38
48
  | **usa_louisiana_wallet** | [**LaWalletProviderOutput**](LaWalletProviderOutput.md) | Exposed properties for the `usa-louisiana-wallet` Provider which do not directly map to the normalized IdentityData model. | [optional] |
39
49
  | **yoti** | [**YotiProviderOutput**](YotiProviderOutput.md) | Exposed properties for the `yoti` Provider which do not directly map to the normalized IdentityData model. | [optional] |
50
+ | **yoti_deeplink** | [**YotiDeeplinkProviderOutput**](YotiDeeplinkProviderOutput.md) | Exposed properties for the `yoti-deeplink` Provider which do not directly map to the normalized IdentityData model. | [optional] |
40
51
 
41
52
  ## Example
42
53
 
@@ -56,27 +67,38 @@ instance = TrinsicApi::ProviderOutput.new(
56
67
  a_lv_eparaksts_mobile_login: null,
57
68
  a_mojeid: null,
58
69
  a_pl_mojeid_login: null,
70
+ australia_connect_id: null,
71
+ czech_republic_mojeid: null,
59
72
  a_pt_id_login: null,
60
73
  a_rs_id_login: null,
61
74
  apple_wallet: null,
62
75
  denmark_mitid: null,
63
76
  ethiopia_fayda: null,
77
+ finnish_trust_network: null,
78
+ france_identite: null,
64
79
  france_identite_numerique: null,
80
+ freja: null,
65
81
  google_wallet: null,
82
+ india_digilocker_aadhaar: null,
66
83
  italy_spid: null,
67
84
  kenya_nid_lookup_2: null,
68
85
  lloyds_smart_id: null,
69
86
  mexico_curp_lookup: null,
70
87
  mobile_id: null,
88
+ nigeria_nin_lookup_2: null,
89
+ oneid: null,
71
90
  peru_dni_lookup: null,
91
+ norway_bankid: null,
72
92
  philippines_digital_national_id_qr: null,
73
93
  philippines_physical_national_id_qr: null,
74
94
  post_office_easyid: null,
75
95
  samsung_wallet: null,
76
96
  smart_id: null,
97
+ uk_evisa_lookup: null,
77
98
  sweden_bankid: null,
78
99
  usa_louisiana_wallet: null,
79
- yoti: null
100
+ yoti: null,
101
+ yoti_deeplink: null
80
102
  )
81
103
  ```
82
104
 
data/docs/ProvidersApi.md CHANGED
@@ -4,9 +4,79 @@ All URIs are relative to *https://api.trinsic.id*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
+ | [**get_provider**](ProvidersApi.md#get_provider) | **GET** /api/v1/providers/{providerId} | Get Provider |
7
8
  | [**list_providers**](ProvidersApi.md#list_providers) | **GET** /api/v1/providers | List Providers |
8
9
 
9
10
 
11
+ ## get_provider
12
+
13
+ > <GetProviderResponse> get_provider(provider_id)
14
+
15
+ Get Provider
16
+
17
+ Get a single identity provider by ID, including its license status.
18
+
19
+ ### Examples
20
+
21
+ ```ruby
22
+ require 'time'
23
+ require 'trinsic_api'
24
+ # setup authorization
25
+ TrinsicApi.configure do |config|
26
+ # Configure Bearer authorization: Bearer
27
+ config.access_token = 'YOUR_BEARER_TOKEN'
28
+ end
29
+
30
+ api_instance = TrinsicApi::ProvidersApi.new
31
+ provider_id = 'provider_id_example' # String | The ID of the provider to retrieve
32
+
33
+ begin
34
+ # Get Provider
35
+ result = api_instance.get_provider(provider_id)
36
+ p result
37
+ rescue TrinsicApi::ApiError => e
38
+ puts "Error when calling ProvidersApi->get_provider: #{e}"
39
+ end
40
+ ```
41
+
42
+ #### Using the get_provider_with_http_info variant
43
+
44
+ This returns an Array which contains the response data, status code and headers.
45
+
46
+ > <Array(<GetProviderResponse>, Integer, Hash)> get_provider_with_http_info(provider_id)
47
+
48
+ ```ruby
49
+ begin
50
+ # Get Provider
51
+ data, status_code, headers = api_instance.get_provider_with_http_info(provider_id)
52
+ p status_code # => 2xx
53
+ p headers # => { ... }
54
+ p data # => <GetProviderResponse>
55
+ rescue TrinsicApi::ApiError => e
56
+ puts "Error when calling ProvidersApi->get_provider_with_http_info: #{e}"
57
+ end
58
+ ```
59
+
60
+ ### Parameters
61
+
62
+ | Name | Type | Description | Notes |
63
+ | ---- | ---- | ----------- | ----- |
64
+ | **provider_id** | **String** | The ID of the provider to retrieve | |
65
+
66
+ ### Return type
67
+
68
+ [**GetProviderResponse**](GetProviderResponse.md)
69
+
70
+ ### Authorization
71
+
72
+ [Bearer](../README.md#Bearer)
73
+
74
+ ### HTTP request headers
75
+
76
+ - **Content-Type**: Not defined
77
+ - **Accept**: text/plain, application/json, text/json, application/problem+json
78
+
79
+
10
80
  ## list_providers
11
81
 
12
82
  > <ListProvidersResponse> list_providers(opts)
@@ -0,0 +1,20 @@
1
+ # TrinsicApi::Raw18013DocumentRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **document_type** | **String** | The type of the document being requested, as defined by ISO specifications 18013-5, 18013-7, 23220-2, or a similar or related standard. Common values: - \&quot;org.iso.18013.5.1.mDL\&quot; -- a Mobile Driver&#39;s License - \&quot;eu.europa.ec.eudi.pid.1\&quot; -- an EUDI Wallet PID - \&quot;com.google.wallet.idcard.1\&quot; -- a Google Wallet ID Pass - \&quot;org.iso.23220.photoid.1\&quot; -- a generic ISO 23220-2 compliant Photo ID (used by Apple Wallet&#39;s ID Pass) | |
8
+ | **name_spaces** | **Hash&lt;String, Hash&lt;String, Boolean&gt;&gt;** | The namespaces and attributes (PII) to request from the document. This is a map of (nameSpaceName -&gt; (attributeName -&gt; willRetain)), where: - nameSpaceName is the name of a NameSpace within the document - attributeName is the name of a specific attribute within the NameSpace - willRetain indicates, to the Wallet, whether you as the Relying Party intend to retain the data for longer than the scope of the transaction Common namespace values: - \&quot;org.iso.18013.5.1\&quot; -- the primary namespace of a Mobile Driver&#39;s License or a Google Wallet ID Pass - \&quot;org.iso.18013.5.1.aamva\&quot; -- the secondary, AAMVA-defined namespace of a Mobile Driver&#39;s License - \&quot;eu.europa.ec.eudi.pid.1\&quot; -- the primary namespace of an EUDI Wallet PID - \&quot;org.iso.23220.1\&quot; -- the primary namespace of an ISO 23220-2 credential or an Apple Wallet ID Pass | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'trinsic_api'
14
+
15
+ instance = TrinsicApi::Raw18013DocumentRequest.new(
16
+ document_type: org.iso.18013.5.1.mDL,
17
+ name_spaces: {&quot;org.iso.18013.5.1&quot;:{&quot;given_name&quot;:true,&quot;family_name&quot;:true,&quot;portrait&quot;:false},&quot;org.iso.18013.5.1.aamva&quot;:{&quot;name_suffix&quot;:true}}
18
+ )
19
+ ```
20
+
@@ -0,0 +1,18 @@
1
+ # TrinsicApi::Raw18013RequestInput
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **document_requests** | [**Array&lt;Raw18013DocumentRequest&gt;**](Raw18013DocumentRequest.md) | A collection of requests for specific document(s), any of which may be used to satisfy the verification. At least one request must be provided. No more than 10 requests may be provided. | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'trinsic_api'
13
+
14
+ instance = TrinsicApi::Raw18013RequestInput.new(
15
+ document_requests: null
16
+ )
17
+ ```
18
+
@@ -5,6 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **recommended_providers** | [**Array&lt;RecommendProviderInformation&gt;**](RecommendProviderInformation.md) | | |
8
+ | **remainder** | [**Array&lt;RecommendProviderInformation&gt;**](RecommendProviderInformation.md) | All Providers available to your Verification Profile which are not in &#x60;recommendedProviders&#x60; | |
8
9
 
9
10
  ## Example
10
11
 
@@ -12,7 +13,8 @@
12
13
  require 'trinsic_api'
13
14
 
14
15
  instance = TrinsicApi::RecommendProvidersResponse.new(
15
- recommended_providers: null
16
+ recommended_providers: null,
17
+ remainder: null
16
18
  )
17
19
  ```
18
20
 
@@ -0,0 +1,18 @@
1
+ # TrinsicApi::SamsungWalletInput
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **preview_raw18013_request** | [**Raw18013RequestInput**](Raw18013RequestInput.md) | **Preview feature: not suitable for production use cases** The raw 18013-7 exchange request to use for this verification. If set, this overrides any default configuration on your Verification Profile. | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'trinsic_api'
13
+
14
+ instance = TrinsicApi::SamsungWalletInput.new(
15
+ preview_raw18013_request: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,20 @@
1
+ # TrinsicApi::UkEvisaLookupInput
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **share_code** | **String** | The 9-character share code. | |
8
+ | **date_of_birth** | **Date** | The user&#39;s date of birth, in &#x60;YYYY-MM-DD&#x60; format. | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'trinsic_api'
14
+
15
+ instance = TrinsicApi::UkEvisaLookupInput.new(
16
+ share_code: R9Z3X7K2P,
17
+ date_of_birth: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,38 @@
1
+ # TrinsicApi::UnitedKingdomEvisaProviderOutput
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **first_name** | **String** | The first name of the individual as recorded on the eVisa. | [optional] |
8
+ | **last_name** | **String** | The last name of the individual as recorded on the eVisa. | [optional] |
9
+ | **date_of_birth** | **Date** | The date of birth of the individual. | [optional] |
10
+ | **share_code** | **String** | The 9-character share code used for the verification. | [optional] |
11
+ | **reference_number** | **String** | The eVisa reference number issued by UK Visas and Immigration (UKVI). | [optional] |
12
+ | **expiration_date** | **Date** | The expiration date of the eVisa. Only present for immigration_status verifications. | [optional] |
13
+ | **valid_from** | **Date** | The start date from which the eVisa is valid. Only returned for immigration_status and right_to_rent verifications — not returned for right_to_work. | [optional] |
14
+ | **nationality** | **String** | The nationality of the individual as recorded on the eVisa. Only present for immigration_status verifications. | [optional] |
15
+ | **immigration_status** | **String** | The immigration status of the individual. Only present for immigration_status verifications. This is a personalized record for each individual, and there is no single definitive list. Some common values: - Settled - Pre-settled - Student - Graduate - Youth Mobility - Global Talent - Skilled Worker - Limited leave | [optional] |
16
+ | **outcome** | **String** | Overall verification outcome: \&quot;pass\&quot; or \&quot;fail\&quot;. | [optional] |
17
+ | **evidence_type** | **String** | Type of verification. List of possible values: - immigration_status - right_to_work - right_to_rent | [optional] |
18
+
19
+ ## Example
20
+
21
+ ```ruby
22
+ require 'trinsic_api'
23
+
24
+ instance = TrinsicApi::UnitedKingdomEvisaProviderOutput.new(
25
+ first_name: MUSA,
26
+ last_name: MOHAMMED,
27
+ date_of_birth: Tue May 15 00:00:00 UTC 1990,
28
+ share_code: W86BC8RAH,
29
+ reference_number: ABC1234567,
30
+ expiration_date: Sun Dec 31 00:00:00 UTC 2028,
31
+ valid_from: Mon Jan 15 00:00:00 UTC 2024,
32
+ nationality: NG,
33
+ immigration_status: Settled,
34
+ outcome: pass,
35
+ evidence_type: immigration_status
36
+ )
37
+ ```
38
+
@@ -10,6 +10,7 @@
10
10
  | **logo_url** | **String** | The URL of the verification profile&#39;s logo. | |
11
11
  | **primary_color** | **String** | The primary color of the verification profile. | |
12
12
  | **enabled_providers** | **Array&lt;String&gt;** | The providers that are currently enabled for the verification profile. | |
13
+ | **session_expiration** | **String** | The session expiration for verification sessions created with this profile. | |
13
14
  | **is_production_usage** | **Boolean** | Whether this profile is for production usage. Only applicable for Live environment profiles. | |
14
15
 
15
16
  ## Example
@@ -24,6 +25,7 @@ instance = TrinsicApi::VerificationProfileResponse.new(
24
25
  logo_url: null,
25
26
  primary_color: null,
26
27
  enabled_providers: null,
28
+ session_expiration: null,
27
29
  is_production_usage: null
28
30
  )
29
31
  ```
@@ -35,6 +35,8 @@ opts = {
35
35
  primary_color: 'primary_color_example', # String | The primary color of the verification profile. Must be a 6-character hex string prefixed with a '#' character. Example: #000000
36
36
  providers: ['inner_example'], # Array<String> | The list of providers you'd like to select for this profile. We will not currently enable any providers.
37
37
  logo: File.new('/path/to/some/file'), # File | The logo of the verification profile.
38
+ redaction_period: 'redaction_period_example', # String | The redaction period for verification data. Must be between 0 and 31 days, and at least 15 minutes greater than the session expiration. If not specified, defaults to 31 days.
39
+ session_expiration: 'session_expiration_example', # String | The session expiration for verification sessions created with this profile. Must be between 15 minutes and 24 hours. Defaults to 1 hour if not specified.
38
40
  is_production_usage: true # Boolean | Whether this profile is for production usage. Only applicable for Live environment profiles. If not specified for Live profiles, defaults to false (Demo).
39
41
  }
40
42
 
@@ -74,6 +76,8 @@ end
74
76
  | **primary_color** | **String** | The primary color of the verification profile. Must be a 6-character hex string prefixed with a &#39;#&#39; character. Example: #000000 | [optional] |
75
77
  | **providers** | [**Array&lt;String&gt;**](String.md) | The list of providers you&#39;d like to select for this profile. We will not currently enable any providers. | [optional] |
76
78
  | **logo** | **File** | The logo of the verification profile. | [optional] |
79
+ | **redaction_period** | **String** | The redaction period for verification data. Must be between 0 and 31 days, and at least 15 minutes greater than the session expiration. If not specified, defaults to 31 days. | [optional] |
80
+ | **session_expiration** | **String** | The session expiration for verification sessions created with this profile. Must be between 15 minutes and 24 hours. Defaults to 1 hour if not specified. | [optional] |
77
81
  | **is_production_usage** | **Boolean** | Whether this profile is for production usage. Only applicable for Live environment profiles. If not specified for Live profiles, defaults to false (Demo). | [optional] |
78
82
 
79
83
  ### Return type
@@ -0,0 +1,40 @@
1
+ # TrinsicApi::YotiDeeplinkProviderOutput
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **remember_me_id** | **String** | The unique id for your service of the individual. This is not shared between different services so if the user logs into a different service, the user will have a new id for the other service. | [optional] |
8
+ | **email** | **String** | The email address of the individual | [optional] |
9
+ | **given_name** | **String** | The given name of the individual. This can correspond to first and middle names in English. | [optional] |
10
+ | **family_name** | **String** | The family name of the individual | [optional] |
11
+ | **full_name** | **String** | Full name of the individual which is composed of the given and family name. Unverified full name may be safe to use. For example, Aadhaar card provides full name, but due to certain limitations of verifying Aadhaar, Yoti is unable to verify this property so it is listed as \&quot;unverified\&quot;. | [optional] |
12
+ | **date_of_birth** | **Date** | The date of birth of the individual. Unverified date of birth may be safe to use. For example, Aadhaar card provides date of birth, but due to certain limitations of verifying Aadhaar, Yoti is unable to verify this property so it is listed as \&quot;unverified\&quot;. | [optional] |
13
+ | **gender** | **String** | The gender of the individual. Depending on the source or country, gender may not be verified. This is a setting that can be configured while setting up scopes. Unverified gender may be safe to use. For example, Aadhaar card provides gender, but due to certain limitations of verifying Aadhaar, Yoti is unable to verify this property so it is listed as \&quot;unverified\&quot;. In some countries Possible values: - \&quot;MALE\&quot; - \&quot;FEMALE\&quot; - \&quot;TRANSGENDER\&quot; - \&quot;OTHER\&quot; | [optional] |
14
+ | **nationality** | **String** | The nationality of the individual as a ISO alpha-3 code | [optional] |
15
+ | **mobile_number** | **String** | The mobile phone number of the individual. This number was verified with a one time password (OTP) during the user&#39;s registration with Yoti. In some cases, Yoti may do additional checks against its sources to confirm the user&#39;s identity. | [optional] |
16
+ | **structured_postal_address** | [**YotiStructuredPostalAddress**](YotiStructuredPostalAddress.md) | A structured postal address for the individual that comes from the underlying document or can be manually added. In the case of being manually added, the address is considered \&quot;unverified\&quot;. Unverified addresses may be safe to use. For example, Aadhaar card provides an address, but due to certain limitations of verifying Aadhaar, Yoti is unable to verify this property so it is listed as \&quot;unverified\&quot;. | [optional] |
17
+ | **postal_address** | **String** | The whole address for the individual that comes from the underlying document or can be manually added. In the case of being manually added, the address is considered \&quot;unverified\&quot;. The format of this will be different for each country. Refer to &#x60;StructuredPostalAddress&#x60; for a detailed version of the address. | [optional] |
18
+ | **document_details** | [**YotiDocumentDetails**](YotiDocumentDetails.md) | The details of the underlying document used to help create the Yoti credential | [optional] |
19
+
20
+ ## Example
21
+
22
+ ```ruby
23
+ require 'trinsic_api'
24
+
25
+ instance = TrinsicApi::YotiDeeplinkProviderOutput.new(
26
+ remember_me_id: 9f63ff98-e1e3-433c-9b86-7c697d0b4e5f,
27
+ email: johndoe@example.com,
28
+ given_name: John Alvin,
29
+ family_name: Doe,
30
+ full_name: John Alvin Doe,
31
+ date_of_birth: Thu Jan 31 00:00:00 UTC 1985,
32
+ gender: MALE,
33
+ nationality: GBR,
34
+ mobile_number: +447777123456,
35
+ structured_postal_address: null,
36
+ postal_address: 6th Floor, 107 Leadenhall St, London, EC3A 4AF,
37
+ document_details: null
38
+ )
39
+ ```
40
+