trinsic_api 3.0.0 → 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.
- checksums.yaml +4 -4
- data/docs/AadhaarClaims.md +46 -0
- data/docs/AadhaarLanguage.md +20 -0
- data/docs/AadhaarLocalizedClaims.md +40 -0
- data/docs/AppleWalletInput.md +3 -1
- data/docs/ConnectIdAddress.md +26 -0
- data/docs/ConnectIdAgeVerification.md +20 -0
- data/docs/ConnectIdBeneficiaryAccount.md +24 -0
- data/docs/ConnectIdProviderOutput.md +38 -0
- data/docs/CzechMojeIdAddressOutput.md +28 -0
- data/docs/CzechMojeIdProviderOutput.md +62 -0
- data/docs/DigilockerAadhaarProviderOutput.md +30 -0
- data/docs/FaydaProviderOutput.md +7 -1
- data/docs/FinnishTrustNetworkProviderOutput.md +38 -0
- data/docs/FranceIdentiteInput.md +18 -0
- data/docs/FranceIdentiteProviderOutput.md +18 -0
- data/docs/FrejaIndirectProviderOutput.md +24 -0
- data/docs/FrejaProviderOutput.md +36 -8
- data/docs/GetProviderResponse.md +18 -0
- data/docs/GoogleWalletInput.md +3 -1
- data/docs/KenyaNidLookup2Address.md +26 -0
- data/docs/KenyaNidLookup2ProviderOutput.md +38 -0
- data/docs/NigeriaNinLookup2ProviderOutput.md +40 -0
- data/docs/NorwegianBankIdProviderOutput.md +32 -0
- data/docs/OneIdProviderAddress.md +26 -0
- data/docs/OneIdProviderOutput.md +28 -0
- data/docs/OutputFrejaAddress.md +24 -0
- data/docs/OutputFrejaDocument.md +24 -0
- data/docs/PhilippinesDigitalNidProviderOutput.md +21 -1
- data/docs/PhilippinesPhysicalNidProviderOutput.md +17 -1
- data/docs/ProviderInput.md +6 -0
- data/docs/ProviderOutput.md +26 -2
- data/docs/ProvidersApi.md +70 -0
- data/docs/Raw18013DocumentRequest.md +20 -0
- data/docs/Raw18013RequestInput.md +18 -0
- data/docs/RecommendProvidersResponse.md +3 -1
- data/docs/SamsungWalletInput.md +18 -0
- data/docs/UkEvisaLookupInput.md +20 -0
- data/docs/UnitedKingdomEvisaProviderOutput.md +38 -0
- data/docs/VerificationProfileResponse.md +2 -0
- data/docs/VerificationProfilesApi.md +4 -0
- data/docs/YotiDeeplinkProviderOutput.md +40 -0
- data/lib/trinsic_api/api/providers_api.rb +63 -0
- data/lib/trinsic_api/api/verification_profiles_api.rb +6 -0
- data/lib/trinsic_api/models/aadhaar_claims.rb +376 -0
- data/lib/trinsic_api/models/aadhaar_language.rb +250 -0
- data/lib/trinsic_api/models/aadhaar_localized_claims.rb +343 -0
- data/lib/trinsic_api/models/apple_wallet_input.rb +16 -5
- data/lib/trinsic_api/models/connect_id_address.rb +266 -0
- data/lib/trinsic_api/models/connect_id_age_verification.rb +233 -0
- data/lib/trinsic_api/models/connect_id_beneficiary_account.rb +255 -0
- data/lib/trinsic_api/models/connect_id_provider_output.rb +333 -0
- data/lib/trinsic_api/models/czech_moje_id_address_output.rb +277 -0
- data/lib/trinsic_api/models/czech_moje_id_provider_output.rb +465 -0
- data/lib/trinsic_api/models/digilocker_aadhaar_provider_output.rb +305 -0
- data/lib/trinsic_api/models/fayda_provider_output.rb +38 -5
- data/lib/trinsic_api/models/finnish_trust_network_provider_output.rb +333 -0
- data/lib/trinsic_api/models/france_identite_input.rb +222 -0
- data/lib/trinsic_api/models/france_identite_provider_output.rb +239 -0
- data/lib/trinsic_api/models/freja_indirect_provider_output.rb +320 -0
- data/lib/trinsic_api/models/freja_provider_output.rb +185 -91
- data/lib/trinsic_api/models/get_provider_response.rb +238 -0
- data/lib/trinsic_api/models/google_wallet_input.rb +16 -5
- data/lib/trinsic_api/models/integration_step.rb +1 -1
- data/lib/trinsic_api/models/kenya_nid_lookup2_address.rb +269 -0
- data/lib/trinsic_api/models/kenya_nid_lookup2_provider_output.rb +429 -0
- data/lib/trinsic_api/models/nigeria_nin_lookup2_provider_output.rb +392 -0
- data/lib/trinsic_api/models/norwegian_bank_id_provider_output.rb +300 -0
- data/lib/trinsic_api/models/one_id_provider_address.rb +266 -0
- data/lib/trinsic_api/models/one_id_provider_output.rb +278 -0
- data/lib/trinsic_api/models/output_freja_address.rb +255 -0
- data/lib/trinsic_api/models/output_freja_document.rb +255 -0
- data/lib/trinsic_api/models/philippines_digital_nid_provider_output.rb +114 -4
- data/lib/trinsic_api/models/philippines_physical_nid_provider_output.rb +92 -4
- data/lib/trinsic_api/models/provider_input.rb +34 -1
- data/lib/trinsic_api/models/provider_output.rb +138 -6
- data/lib/trinsic_api/models/raw18013_document_request.rb +276 -0
- data/lib/trinsic_api/models/raw18013_request_input.rb +259 -0
- data/lib/trinsic_api/models/recommend_providers_response.rb +33 -4
- data/lib/trinsic_api/models/samsung_wallet_input.rb +222 -0
- data/lib/trinsic_api/models/uk_evisa_lookup_input.rb +283 -0
- data/lib/trinsic_api/models/united_kingdom_evisa_provider_output.rb +333 -0
- data/lib/trinsic_api/models/verification_profile_response.rb +28 -1
- data/lib/trinsic_api/models/yoti_deeplink_provider_output.rb +344 -0
- data/lib/trinsic_api/version.rb +1 -1
- data/lib/trinsic_api.rb +29 -0
- data/spec/api/providers_api_spec.rb +12 -0
- data/spec/api/verification_profiles_api_spec.rb +2 -0
- data/spec/models/aadhaar_claims_spec.rb +120 -0
- data/spec/models/aadhaar_language_spec.rb +42 -0
- data/spec/models/aadhaar_localized_claims_spec.rb +102 -0
- data/spec/models/apple_wallet_input_spec.rb +6 -0
- data/spec/models/connect_id_address_spec.rb +60 -0
- data/spec/models/connect_id_age_verification_spec.rb +42 -0
- data/spec/models/connect_id_beneficiary_account_spec.rb +54 -0
- data/spec/models/connect_id_provider_output_spec.rb +96 -0
- data/spec/models/czech_moje_id_address_output_spec.rb +66 -0
- data/spec/models/czech_moje_id_provider_output_spec.rb +168 -0
- data/spec/models/digilocker_aadhaar_provider_output_spec.rb +72 -0
- data/spec/models/fayda_provider_output_spec.rb +18 -0
- data/spec/models/finnish_trust_network_provider_output_spec.rb +96 -0
- data/spec/models/france_identite_input_spec.rb +36 -0
- data/spec/models/france_identite_provider_output_spec.rb +36 -0
- data/spec/models/freja_indirect_provider_output_spec.rb +54 -0
- data/spec/models/freja_provider_output_spec.rb +88 -4
- data/spec/models/get_provider_response_spec.rb +36 -0
- data/spec/models/google_wallet_input_spec.rb +6 -0
- data/spec/models/kenya_nid_lookup2_address_spec.rb +60 -0
- data/spec/models/kenya_nid_lookup2_provider_output_spec.rb +96 -0
- data/spec/models/nigeria_nin_lookup2_provider_output_spec.rb +102 -0
- data/spec/models/norwegian_bank_id_provider_output_spec.rb +78 -0
- data/spec/models/one_id_provider_address_spec.rb +60 -0
- data/spec/models/one_id_provider_output_spec.rb +66 -0
- data/spec/models/output_freja_address_spec.rb +54 -0
- data/spec/models/output_freja_document_spec.rb +54 -0
- data/spec/models/philippines_digital_nid_provider_output_spec.rb +60 -0
- data/spec/models/philippines_physical_nid_provider_output_spec.rb +48 -0
- data/spec/models/provider_input_spec.rb +18 -0
- data/spec/models/provider_output_spec.rb +72 -0
- data/spec/models/raw18013_document_request_spec.rb +42 -0
- data/spec/models/raw18013_request_input_spec.rb +36 -0
- data/spec/models/recommend_providers_response_spec.rb +6 -0
- data/spec/models/samsung_wallet_input_spec.rb +36 -0
- data/spec/models/uk_evisa_lookup_input_spec.rb +42 -0
- data/spec/models/united_kingdom_evisa_provider_output_spec.rb +96 -0
- data/spec/models/verification_profile_response_spec.rb +6 -0
- data/spec/models/yoti_deeplink_provider_output_spec.rb +102 -0
- metadata +236 -120
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# TrinsicApi::KenyaNidLookup2ProviderOutput
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **first_name** | **String** | The first name (given name) of the ID holder as recorded in IPRS. | |
|
|
8
|
+
| **surname** | **String** | The surname (family name) of the ID holder as recorded in IPRS. | |
|
|
9
|
+
| **other_name** | **String** | The other name (middle name) of the ID holder as recorded in IPRS. | [optional] |
|
|
10
|
+
| **sex** | **String** | The sex of the ID holder as recorded on the National ID. Possible values: - Male - Female | |
|
|
11
|
+
| **date_of_birth** | **Date** | The date of birth of the ID holder as recorded in IPRS. | [optional] |
|
|
12
|
+
| **citizenship** | **String** | Citizenship status as recorded in the IPRS civil registry database. For the Kenya National ID lookup, this value will always be \"Kenyan\" as the National ID is only issued to Kenyan citizens. Non-citizens residing in Kenya are issued different identification documents (Alien ID cards, refugee documentation, etc.) which are not supported by this provider. | |
|
|
13
|
+
| **id_number** | **String** | The Kenya National ID Number (Nambari ya Kitambulisho). This is the primary unique identifier for Kenyan citizens in all government systems, issued by the National Registration Bureau (NRB). The format is 1 to 9 numeric digits (regex: /^[0-9]{1,9}$/). This number is assigned upon first registration at age 18 (or upon naturalization for new citizens) and remains constant for life. | |
|
|
14
|
+
| **serial_number** | **String** | The physical card serial number printed on the Kenya National ID card. This is distinct from the ID Number and serves as a card issuance tracking identifier maintained by IPRS. This value changes each time a new physical card is issued (loss, damage, renewal). | |
|
|
15
|
+
| **date_of_issue** | **Date** | The date the National ID was issued by the National Registration Bureau (NRB). | [optional] |
|
|
16
|
+
| **place_of_birth** | [**KenyaNidLookup2Address**](KenyaNidLookup2Address.md) | Place of birth as recorded in Kenya's civil registry (IPRS). This is structured according to Kenya's pre-2010 administrative hierarchy (District > Division > Location). | [optional] |
|
|
17
|
+
| **place_of_residence** | [**KenyaNidLookup2Address**](KenyaNidLookup2Address.md) | Current residence address as registered in IPRS. This represents the address on file at the time of ID registration or last update, structured according to Kenya's pre-2010 administrative hierarchy (District > Division > Location). | [optional] |
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```ruby
|
|
22
|
+
require 'trinsic_api'
|
|
23
|
+
|
|
24
|
+
instance = TrinsicApi::KenyaNidLookup2ProviderOutput.new(
|
|
25
|
+
first_name: JUMA,
|
|
26
|
+
surname: ODHIAMBO,
|
|
27
|
+
other_name: OTIENO,
|
|
28
|
+
sex: Male,
|
|
29
|
+
date_of_birth: Tue Jan 01 00:00:00 UTC 1985,
|
|
30
|
+
citizenship: Kenyan,
|
|
31
|
+
id_number: 12345678,
|
|
32
|
+
serial_number: 98765432,
|
|
33
|
+
date_of_issue: Tue Jun 15 00:00:00 UTC 2010,
|
|
34
|
+
place_of_birth: null,
|
|
35
|
+
place_of_residence: null
|
|
36
|
+
)
|
|
37
|
+
```
|
|
38
|
+
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# TrinsicApi::NigeriaNinLookup2ProviderOutput
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **first_name** | **String** | The first name (given name) of the ID holder. | |
|
|
8
|
+
| **middle_name** | **String** | The middle name of the ID holder. | [optional] |
|
|
9
|
+
| **surname** | **String** | The surname (family name) of the ID holder. | |
|
|
10
|
+
| **sex** | **String** | The sex of the ID holder. Possible values: - Male - Female | [optional] |
|
|
11
|
+
| **date_of_birth** | **Date** | The date of birth of the ID holder. | [optional] |
|
|
12
|
+
| **birth_country** | **String** | Country of birth as an ISO 3166-1 alpha-2 code. | [optional] |
|
|
13
|
+
| **national_identity_number** | **String** | National Identification Number (NIN). This is a unique, permanent identifier assigned by the National Identity Management Commission upon enrollment. Format: 11 numeric digits (regex: /^[0-9]{11}$/). The digits are validated using the Verhoeff algorithm, meaning the last digit serves as a check digit. | |
|
|
14
|
+
| **phone_number** | **String** | Phone number registered with the National Identity Management Commission. | [optional] |
|
|
15
|
+
| **email** | **String** | Email address registered with the National Identity Management Commission. | [optional] |
|
|
16
|
+
| **address** | **String** | Full residential address as a single string, normalized to lowercase without delimiters. | [optional] |
|
|
17
|
+
| **local_government_area** | **String** | Local Government Area of residence. Nigeria is divided into 774 Local Government Areas (LGAs), which are the third-tier administrative divisions below states and the Federal Capital Territory. LGAs are roughly equivalent to counties or municipalities in other countries. | [optional] |
|
|
18
|
+
| **state** | **String** | State of residence. | [optional] |
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
```ruby
|
|
23
|
+
require 'trinsic_api'
|
|
24
|
+
|
|
25
|
+
instance = TrinsicApi::NigeriaNinLookup2ProviderOutput.new(
|
|
26
|
+
first_name: MUSA,
|
|
27
|
+
middle_name: IBRAHIM,
|
|
28
|
+
surname: MOHAMMED,
|
|
29
|
+
sex: Male,
|
|
30
|
+
date_of_birth: Wed Jan 31 00:00:00 UTC 1990,
|
|
31
|
+
birth_country: NG,
|
|
32
|
+
national_identity_number: 12345678901,
|
|
33
|
+
phone_number: +2340123456789,
|
|
34
|
+
email: user@example.com,
|
|
35
|
+
address: 816 ahmadu bello way central business district abuja,
|
|
36
|
+
local_government_area: Abuja Municipal,
|
|
37
|
+
state: Federal Capital Territory
|
|
38
|
+
)
|
|
39
|
+
```
|
|
40
|
+
|
|
@@ -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
|
|
data/docs/ProviderInput.md
CHANGED
|
@@ -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
|
)
|
data/docs/ProviderOutput.md
CHANGED
|
@@ -9,33 +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** | [**
|
|
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] |
|
|
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] |
|
|
27
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] |
|
|
28
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] |
|
|
29
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] |
|
|
30
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] |
|
|
31
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] |
|
|
32
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] |
|
|
33
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] |
|
|
34
44
|
| **samsung_wallet** | [**SamsungWalletProviderOutput**](SamsungWalletProviderOutput.md) | Exposed properties for the `samsung-wallet` Provider which do not directly map to the normalized IdentityData model. | [optional] |
|
|
35
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] |
|
|
36
47
|
| **sweden_bankid** | [**SwedenBankIdProviderOutput**](SwedenBankIdProviderOutput.md) | Exposed properties for the `sweden-bankid` Provider which do not directly map to the normalized IdentityData model. | [optional] |
|
|
37
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] |
|
|
38
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] |
|
|
39
51
|
|
|
40
52
|
## Example
|
|
41
53
|
|
|
@@ -55,26 +67,38 @@ instance = TrinsicApi::ProviderOutput.new(
|
|
|
55
67
|
a_lv_eparaksts_mobile_login: null,
|
|
56
68
|
a_mojeid: null,
|
|
57
69
|
a_pl_mojeid_login: null,
|
|
70
|
+
australia_connect_id: null,
|
|
71
|
+
czech_republic_mojeid: null,
|
|
58
72
|
a_pt_id_login: null,
|
|
59
73
|
a_rs_id_login: null,
|
|
60
74
|
apple_wallet: null,
|
|
61
75
|
denmark_mitid: null,
|
|
62
76
|
ethiopia_fayda: null,
|
|
77
|
+
finnish_trust_network: null,
|
|
78
|
+
france_identite: null,
|
|
63
79
|
france_identite_numerique: null,
|
|
80
|
+
freja: null,
|
|
64
81
|
google_wallet: null,
|
|
82
|
+
india_digilocker_aadhaar: null,
|
|
65
83
|
italy_spid: null,
|
|
84
|
+
kenya_nid_lookup_2: null,
|
|
66
85
|
lloyds_smart_id: null,
|
|
67
86
|
mexico_curp_lookup: null,
|
|
68
87
|
mobile_id: null,
|
|
88
|
+
nigeria_nin_lookup_2: null,
|
|
89
|
+
oneid: null,
|
|
69
90
|
peru_dni_lookup: null,
|
|
91
|
+
norway_bankid: null,
|
|
70
92
|
philippines_digital_national_id_qr: null,
|
|
71
93
|
philippines_physical_national_id_qr: null,
|
|
72
94
|
post_office_easyid: null,
|
|
73
95
|
samsung_wallet: null,
|
|
74
96
|
smart_id: null,
|
|
97
|
+
uk_evisa_lookup: null,
|
|
75
98
|
sweden_bankid: null,
|
|
76
99
|
usa_louisiana_wallet: null,
|
|
77
|
-
yoti: null
|
|
100
|
+
yoti: null,
|
|
101
|
+
yoti_deeplink: null
|
|
78
102
|
)
|
|
79
103
|
```
|
|
80
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: - \"org.iso.18013.5.1.mDL\" -- a Mobile Driver's License - \"eu.europa.ec.eudi.pid.1\" -- an EUDI Wallet PID - \"com.google.wallet.idcard.1\" -- a Google Wallet ID Pass - \"org.iso.23220.photoid.1\" -- a generic ISO 23220-2 compliant Photo ID (used by Apple Wallet's ID Pass) | |
|
|
8
|
+
| **name_spaces** | **Hash<String, Hash<String, Boolean>>** | The namespaces and attributes (PII) to request from the document. This is a map of (nameSpaceName -> (attributeName -> 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: - \"org.iso.18013.5.1\" -- the primary namespace of a Mobile Driver's License or a Google Wallet ID Pass - \"org.iso.18013.5.1.aamva\" -- the secondary, AAMVA-defined namespace of a Mobile Driver's License - \"eu.europa.ec.eudi.pid.1\" -- the primary namespace of an EUDI Wallet PID - \"org.iso.23220.1\" -- 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: {"org.iso.18013.5.1":{"given_name":true,"family_name":true,"portrait":false},"org.iso.18013.5.1.aamva":{"name_suffix":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<Raw18013DocumentRequest>**](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<RecommendProviderInformation>**](RecommendProviderInformation.md) | | |
|
|
8
|
+
| **remainder** | [**Array<RecommendProviderInformation>**](RecommendProviderInformation.md) | All Providers available to your Verification Profile which are not in `recommendedProviders` | |
|
|
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's date of birth, in `YYYY-MM-DD` 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: \"pass\" or \"fail\". | [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's logo. | |
|
|
11
11
|
| **primary_color** | **String** | The primary color of the verification profile. | |
|
|
12
12
|
| **enabled_providers** | **Array<String>** | 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
|
```
|