trinsic_api 3.1.0.pre.preview1 → 3.1.0
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/AgeOverOutput.md +20 -0
- data/docs/AppleWalletProviderOutput.md +2 -0
- data/docs/EudiAgeVerificationCredential.md +22 -0
- data/docs/EudiPidCredential.md +70 -0
- data/docs/FranceIdentiteProviderOutput.md +4 -0
- data/docs/GoogleWalletIdPassCredential.md +40 -0
- data/docs/GoogleWalletProviderOutput.md +4 -0
- data/docs/Iso180132BiometricDataBlockProduct.md +20 -0
- data/docs/Iso180132BiometricGroupTemplate.md +18 -0
- data/docs/Iso180132BiometricTemplate.md +24 -0
- data/docs/Iso180132BiometricTemplateHeader.md +36 -0
- data/docs/Iso180132BiometricValidityPeriod.md +20 -0
- data/docs/Iso180135AamvaDomesticDrivingPrivilege.md +22 -0
- data/docs/Iso180135AamvaDomesticVehicleClass.md +24 -0
- data/docs/Iso180135AamvaDomesticVehicleEndorsement.md +20 -0
- data/docs/Iso180135AamvaDomesticVehicleRestriction.md +20 -0
- data/docs/Iso180135AamvaNamespaceOutput.md +70 -0
- data/docs/Iso180135AamvaWeightRange.md +20 -0
- data/docs/Iso180135DrivingPrivilege.md +24 -0
- data/docs/Iso180135DrivingPrivilegeCode.md +22 -0
- data/docs/Iso180135MobileDriversLicenseCredential.md +20 -0
- data/docs/Iso180135StandardNamespaceOutput.md +86 -0
- data/docs/SamsungWalletProviderOutput.md +2 -0
- data/lib/trinsic_api/models/age_over_output.rb +193 -0
- data/lib/trinsic_api/models/apple_wallet_provider_output.rb +12 -1
- data/lib/trinsic_api/models/eudi_age_verification_credential.rb +174 -0
- data/lib/trinsic_api/models/eudi_pid_credential.rb +438 -0
- data/lib/trinsic_api/models/france_identite_provider_output.rb +23 -1
- data/lib/trinsic_api/models/google_wallet_id_pass_credential.rb +273 -0
- data/lib/trinsic_api/models/google_wallet_provider_output.rb +23 -1
- data/lib/trinsic_api/models/iso180132_biometric_data_block_product.rb +193 -0
- data/lib/trinsic_api/models/iso180132_biometric_group_template.rb +168 -0
- data/lib/trinsic_api/models/iso180132_biometric_template.rb +231 -0
- data/lib/trinsic_api/models/iso180132_biometric_template_header.rb +297 -0
- data/lib/trinsic_api/models/iso180132_biometric_validity_period.rb +193 -0
- data/lib/trinsic_api/models/iso180135_aamva_domestic_driving_privilege.rb +176 -0
- data/lib/trinsic_api/models/iso180135_aamva_domestic_vehicle_class.rb +215 -0
- data/lib/trinsic_api/models/iso180135_aamva_domestic_vehicle_endorsement.rb +177 -0
- data/lib/trinsic_api/models/iso180135_aamva_domestic_vehicle_restriction.rb +177 -0
- data/lib/trinsic_api/models/iso180135_aamva_namespace_output.rb +438 -0
- data/lib/trinsic_api/models/iso180135_aamva_weight_range.rb +177 -0
- data/lib/trinsic_api/models/iso180135_driving_privilege.rb +201 -0
- data/lib/trinsic_api/models/iso180135_driving_privilege_code.rb +188 -0
- data/lib/trinsic_api/models/iso180135_mobile_drivers_license_credential.rb +161 -0
- data/lib/trinsic_api/models/iso180135_standard_namespace_output.rb +528 -0
- data/lib/trinsic_api/models/samsung_wallet_provider_output.rb +12 -1
- data/lib/trinsic_api/version.rb +1 -1
- data/lib/trinsic_api.rb +19 -0
- data/spec/models/age_over_output_spec.rb +42 -0
- data/spec/models/apple_wallet_provider_output_spec.rb +6 -0
- data/spec/models/eudi_age_verification_credential_spec.rb +48 -0
- data/spec/models/eudi_pid_credential_spec.rb +192 -0
- data/spec/models/france_identite_provider_output_spec.rb +12 -0
- data/spec/models/google_wallet_id_pass_credential_spec.rb +102 -0
- data/spec/models/google_wallet_provider_output_spec.rb +12 -0
- data/spec/models/iso180132_biometric_data_block_product_spec.rb +42 -0
- data/spec/models/iso180132_biometric_group_template_spec.rb +36 -0
- data/spec/models/iso180132_biometric_template_header_spec.rb +90 -0
- data/spec/models/iso180132_biometric_template_spec.rb +54 -0
- data/spec/models/iso180132_biometric_validity_period_spec.rb +42 -0
- data/spec/models/iso180135_aamva_domestic_driving_privilege_spec.rb +48 -0
- data/spec/models/iso180135_aamva_domestic_vehicle_class_spec.rb +54 -0
- data/spec/models/iso180135_aamva_domestic_vehicle_endorsement_spec.rb +42 -0
- data/spec/models/iso180135_aamva_domestic_vehicle_restriction_spec.rb +42 -0
- data/spec/models/iso180135_aamva_namespace_output_spec.rb +192 -0
- data/spec/models/iso180135_aamva_weight_range_spec.rb +42 -0
- data/spec/models/iso180135_driving_privilege_code_spec.rb +48 -0
- data/spec/models/iso180135_driving_privilege_spec.rb +54 -0
- data/spec/models/iso180135_mobile_drivers_license_credential_spec.rb +42 -0
- data/spec/models/iso180135_standard_namespace_output_spec.rb +240 -0
- data/spec/models/samsung_wallet_provider_output_spec.rb +6 -0
- metadata +78 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 1dedc1ab5718362ada7ea3e97628b1e73f1cf4a57dbd4cc4e900996fdbd01eb6
|
|
4
|
+
data.tar.gz: 1e38d6c9272ae2b7be75f767d4a85c74b675fa181b6ed822c49d3dec83be8162
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 387542add211e894e33f176d88c751e557064aa9c9b33886423965ea0519479e1b5d671f592bbd84fbe90ead88d2bde7fae2f9a58e1e97aafd02b1aaebbf1dcf
|
|
7
|
+
data.tar.gz: 633fb8e576c6e37703b9d2dd1c7456bdd461fbd3f9c86a35c2119ccb569ee27896c7d08fa7907b1107360697449e5118a857ed88b57fe9c9e8d4bbdb5e405e83
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# TrinsicApi::AgeOverOutput
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **age** | **Integer** | The age threshold from the `age over X` claim. | |
|
|
8
|
+
| **is_over** | **Boolean** | Whether the individual is at least the given age. | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'trinsic_api'
|
|
14
|
+
|
|
15
|
+
instance = TrinsicApi::AgeOverOutput.new(
|
|
16
|
+
age: 21,
|
|
17
|
+
is_over: true
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -4,6 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **mobile_drivers_license** | [**Iso180135MobileDriversLicenseCredential**](Iso180135MobileDriversLicenseCredential.md) | A standard 18013-5 Mobile Driver's License credential, retrieved from the individual's wallet. | [optional] |
|
|
7
8
|
| **raw_mdl_output** | [**MdlOutput**](MdlOutput.md) | The raw output of the mDL exchange performed through Apple Wallet. | |
|
|
8
9
|
|
|
9
10
|
## Example
|
|
@@ -12,6 +13,7 @@
|
|
|
12
13
|
require 'trinsic_api'
|
|
13
14
|
|
|
14
15
|
instance = TrinsicApi::AppleWalletProviderOutput.new(
|
|
16
|
+
mobile_drivers_license: null,
|
|
15
17
|
raw_mdl_output: null
|
|
16
18
|
)
|
|
17
19
|
```
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# TrinsicApi::EudiAgeVerificationCredential
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **age_over** | [**Array<AgeOverOutput>**](AgeOverOutput.md) | Processed age-over claims returned by the credential. | [optional] |
|
|
8
|
+
| **expiry_date** | **Date** | Date when the age verification data expires. | [optional] |
|
|
9
|
+
| **issuing_country** | **String** | ISO 3166-1 alpha-2 country code of the country or territory of the issuer of the credential. | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'trinsic_api'
|
|
15
|
+
|
|
16
|
+
instance = TrinsicApi::EudiAgeVerificationCredential.new(
|
|
17
|
+
age_over: [{"age":18,"isOver":true},{"age":21,"isOver":true}],
|
|
18
|
+
expiry_date: Thu Jan 31 00:00:00 UTC 2030,
|
|
19
|
+
issuing_country: FR
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
# TrinsicApi::EudiPidCredential
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **given_name** | **String** | Current first name(s), including middle name(s) where applicable, of the individual to whom the PID relates. | [optional] |
|
|
8
|
+
| **given_name_birth** | **String** | First name(s), including middle name(s), of the individual at the time of birth. | [optional] |
|
|
9
|
+
| **family_name** | **String** | Current last name(s) or surname(s) of the individuals. | [optional] |
|
|
10
|
+
| **family_name_birth** | **String** | Last name(s) or surname(s) of the individual at the time of birth. | [optional] |
|
|
11
|
+
| **date_of_birth** | **Date** | The date of birth of the individual. | [optional] |
|
|
12
|
+
| **birth_place** | **String** | Country (ISO 3166-1 alpha-2), state, province, district, local area, municipality, city, town, or village where the individual was born. | [optional] |
|
|
13
|
+
| **nationality** | **Array<String>** | One or more ISO 3166-1 alpha-2 country codes representing the nationality of the individual. | [optional] |
|
|
14
|
+
| **expiry_date** | **Date** | Date when the PID expires. Because PIDs are not necessarily backed by a physical document, this does not correspond to the expiration date of such. | [optional] |
|
|
15
|
+
| **issuing_authority** | **String** | Name of the administrative authority that issued the PID, or the ISO 3166 alpha-2 country code of the respective Member State if there is no separate authority entitled to issue PIDs. | [optional] |
|
|
16
|
+
| **issuing_country** | **String** | ISO 3166-1 alpha-2 country code of the country or territory of the issuer of the PID. | [optional] |
|
|
17
|
+
| **issuance_date** | **Date** | Date when the PID was issued and/or the administrative validity period began. | [optional] |
|
|
18
|
+
| **trust_anchor** | **String** | URL where a machine-readable trust anchor for verifying the PID can be found. | [optional] |
|
|
19
|
+
| **attestation_legal_category** | **String** | Indicator that this credential has been issued specifically as PID. When present, typically equal to \"PID\". | [optional] |
|
|
20
|
+
| **document_number** | **String** | A number assigned to the PID by the issuer. This does not correspond to the document number of a physical document. | [optional] |
|
|
21
|
+
| **issuing_jurisdiction** | **String** | ISO 3166-2 country-subdivision code for the jurisdiction that issued the PID. | [optional] |
|
|
22
|
+
| **location_status** | **String** | Location of validity status information for the PID, where revocation information is published. | [optional] |
|
|
23
|
+
| **sex** | **Integer** | Sex of the individual. This is a superset of the ISO/IEC 5218 sex code standard, defining additional \"other\", \"inter\", \"diverse\", and \"open\" values. Possible values: - 0: Unknown - 1: Male - 2: Female - 3: Other - 4: Inter - 5: Diverse - 6: Open - 9: Not Applicable For values 0, 1, 2, and 9, ISO/IEC 5218 applies. | [optional] |
|
|
24
|
+
| **email_address** | **String** | The individual's email address. | [optional] |
|
|
25
|
+
| **mobile_phone_number** | **String** | The mobile phone number of the individual, in international format. | [optional] |
|
|
26
|
+
| **personal_administrative_number** | **String** | A value assigned to the individual that is unique among all personal administrative numbers issued by the provider. | [optional] |
|
|
27
|
+
| **resident_address** | **String** | The full address of the individual's permanent residence. | [optional] |
|
|
28
|
+
| **resident_street** | **String** | The street name of the individual's permanent residence. | [optional] |
|
|
29
|
+
| **resident_house_number** | **String** | The house number of the individual's permanent residence. | [optional] |
|
|
30
|
+
| **resident_city** | **String** | The municipality, city, town, or village of the individual's permanent residence. | [optional] |
|
|
31
|
+
| **resident_state** | **String** | The state, province, district, or local area of the individual's permanent residence. | [optional] |
|
|
32
|
+
| **resident_postal_code** | **String** | The postal code of the individual's permanent residence. | [optional] |
|
|
33
|
+
| **resident_country** | **String** | The ISO 3166-1 alpha-2 country code of the individual's permanent residence. | [optional] |
|
|
34
|
+
|
|
35
|
+
## Example
|
|
36
|
+
|
|
37
|
+
```ruby
|
|
38
|
+
require 'trinsic_api'
|
|
39
|
+
|
|
40
|
+
instance = TrinsicApi::EudiPidCredential.new(
|
|
41
|
+
given_name: JEAN,
|
|
42
|
+
given_name_birth: JEAN,
|
|
43
|
+
family_name: DUPONT,
|
|
44
|
+
family_name_birth: DUPONT,
|
|
45
|
+
date_of_birth: Wed Jan 31 00:00:00 UTC 1990,
|
|
46
|
+
birth_place: PARIS,
|
|
47
|
+
nationality: ["FR"],
|
|
48
|
+
expiry_date: Thu Jan 31 00:00:00 UTC 2030,
|
|
49
|
+
issuing_authority: FR,
|
|
50
|
+
issuing_country: FR,
|
|
51
|
+
issuance_date: Fri Jan 31 00:00:00 UTC 2020,
|
|
52
|
+
trust_anchor: https://trust.example.test/anchor,
|
|
53
|
+
attestation_legal_category: PID,
|
|
54
|
+
document_number: P1234567,
|
|
55
|
+
issuing_jurisdiction: FR-75,
|
|
56
|
+
location_status: https://status.example.test/pid,
|
|
57
|
+
sex: 1,
|
|
58
|
+
email_address: jean.dupont@example.test,
|
|
59
|
+
mobile_phone_number: +33612345678,
|
|
60
|
+
personal_administrative_number: 123456789,
|
|
61
|
+
resident_address: 1 RUE DE LA PAIX, 75001 PARIS,
|
|
62
|
+
resident_street: RUE DE LA PAIX,
|
|
63
|
+
resident_house_number: 1,
|
|
64
|
+
resident_city: PARIS,
|
|
65
|
+
resident_state: ILE-DE-FRANCE,
|
|
66
|
+
resident_postal_code: 75001,
|
|
67
|
+
resident_country: FR
|
|
68
|
+
)
|
|
69
|
+
```
|
|
70
|
+
|
|
@@ -4,6 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **pid** | [**EudiPidCredential**](EudiPidCredential.md) | An EUDI Person Identification Data (PID) credential, retrieved from the individual's wallet. | [optional] |
|
|
8
|
+
| **age_verification** | [**EudiAgeVerificationCredential**](EudiAgeVerificationCredential.md) | An EUDI Age Verification credential, retrieved from the individual's wallet. | [optional] |
|
|
7
9
|
| **raw18013_output** | [**MdlOutput**](MdlOutput.md) | The raw output of the 18013-7 exchange performed through France Identité. | |
|
|
8
10
|
|
|
9
11
|
## Example
|
|
@@ -12,6 +14,8 @@
|
|
|
12
14
|
require 'trinsic_api'
|
|
13
15
|
|
|
14
16
|
instance = TrinsicApi::FranceIdentiteProviderOutput.new(
|
|
17
|
+
pid: null,
|
|
18
|
+
age_verification: null,
|
|
15
19
|
raw18013_output: null
|
|
16
20
|
)
|
|
17
21
|
```
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# TrinsicApi::GoogleWalletIdPassCredential
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **given_name** | **String** | First name(s), other name(s), or secondary identifier of the individual. | [optional] |
|
|
8
|
+
| **family_name** | **String** | Last name, surname, or primary identifier of the individual. | [optional] |
|
|
9
|
+
| **date_of_birth** | **Date** | The date of birth of the individual. | [optional] |
|
|
10
|
+
| **issue_date** | **Date** | The date when the ID Pass was issued. This is not the same as the issue date of the underlying physical passport used to create the ID Pass. | [optional] |
|
|
11
|
+
| **expiry_date** | **Date** | The date when the ID Pass expires. This is not necessarily the same as the expiration date of the underlying physical passport used to create the ID Pass. | [optional] |
|
|
12
|
+
| **issuing_country** | **String** | Alpha-2 country code of the issuing authority's country or territory. | [optional] |
|
|
13
|
+
| **issuing_authority** | **String** | Name or identifier of the mDL issuing authority. This field's contents are arbitrary; it has no guaranteed format. | [optional] |
|
|
14
|
+
| **nationality** | **String** | Nationality of the individual as an ISO 3166-1 alpha-2 country code. | [optional] |
|
|
15
|
+
| **document_number** | **String** | The number of the underlying passport used to create the ID Pass. | [optional] |
|
|
16
|
+
| **sex** | **Integer** | The individual's sex as an ISO/IEC 5218 code. Possible values: - 0: Unknown - 1: Male - 2: Female - 9: Not Applicable | [optional] |
|
|
17
|
+
| **age_over** | [**Array<AgeOverOutput>**](AgeOverOutput.md) | Processed age-over claims returned by the ID Pass. | [optional] |
|
|
18
|
+
| **issue_date_of_underlying_document** | **Date** | Date when the underlying passport backing this digital credential was originally issued. | [optional] |
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
```ruby
|
|
23
|
+
require 'trinsic_api'
|
|
24
|
+
|
|
25
|
+
instance = TrinsicApi::GoogleWalletIdPassCredential.new(
|
|
26
|
+
given_name: JOHN,
|
|
27
|
+
family_name: DOE,
|
|
28
|
+
date_of_birth: Wed Jan 31 00:00:00 UTC 1990,
|
|
29
|
+
issue_date: Fri Jan 31 00:00:00 UTC 2020,
|
|
30
|
+
expiry_date: Thu Jan 31 00:00:00 UTC 2030,
|
|
31
|
+
issuing_country: US,
|
|
32
|
+
issuing_authority: US Department of State,
|
|
33
|
+
nationality: US,
|
|
34
|
+
document_number: P1234567,
|
|
35
|
+
sex: 1,
|
|
36
|
+
age_over: [{"age":18,"isOver":true},{"age":21,"isOver":true}],
|
|
37
|
+
issue_date_of_underlying_document: Fri Jun 15 00:00:00 UTC 2018
|
|
38
|
+
)
|
|
39
|
+
```
|
|
40
|
+
|
|
@@ -4,6 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **mobile_drivers_license** | [**Iso180135MobileDriversLicenseCredential**](Iso180135MobileDriversLicenseCredential.md) | A standard 18013-5 Mobile Driver's License credential, retrieved from the individual's wallet. | [optional] |
|
|
8
|
+
| **id_pass** | [**GoogleWalletIdPassCredential**](GoogleWalletIdPassCredential.md) | A Google Wallet ID Pass credential (`com.google.wallet.idcard.1`), retrieved from the individual's wallet. | [optional] |
|
|
7
9
|
| **raw_mdl_output** | [**MdlOutput**](MdlOutput.md) | The raw output of the mDL exchange performed through Google Wallet. | |
|
|
8
10
|
|
|
9
11
|
## Example
|
|
@@ -12,6 +14,8 @@
|
|
|
12
14
|
require 'trinsic_api'
|
|
13
15
|
|
|
14
16
|
instance = TrinsicApi::GoogleWalletProviderOutput.new(
|
|
17
|
+
mobile_drivers_license: null,
|
|
18
|
+
id_pass: null,
|
|
15
19
|
raw_mdl_output: null
|
|
16
20
|
)
|
|
17
21
|
```
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# TrinsicApi::Iso180132BiometricDataBlockProduct
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **product_owner** | **Integer** | Identifier of the product owner. | |
|
|
8
|
+
| **product_type** | **Integer** | Identifier of the product type. | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'trinsic_api'
|
|
14
|
+
|
|
15
|
+
instance = TrinsicApi::Iso180132BiometricDataBlockProduct.new(
|
|
16
|
+
product_owner: 4660,
|
|
17
|
+
product_type: 22136
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# TrinsicApi::Iso180132BiometricGroupTemplate
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **templates** | [**Array<Iso180132BiometricTemplate>**](Iso180132BiometricTemplate.md) | Individual biometric templates contained in this group. | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'trinsic_api'
|
|
13
|
+
|
|
14
|
+
instance = TrinsicApi::Iso180132BiometricGroupTemplate.new(
|
|
15
|
+
templates: []
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# TrinsicApi::Iso180132BiometricTemplate
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **header** | [**Iso180132BiometricTemplateHeader**](Iso180132BiometricTemplateHeader.md) | Header describing the biometric template. | |
|
|
8
|
+
| **data_block** | **String** | The raw data block, in a biometric type- and format-specific encoding. For `face` and `signature_usual_mark`, this is a raw JPEG or JPEG2000 image. See ISO 18013-2 and 18013-5. | |
|
|
9
|
+
| **data_is_encrypted** | **Boolean** | Whether the data block is encrypted. | |
|
|
10
|
+
| **biometric_information_record_payload** | **String** | Optional Biometric Information Record payload, containing arbitrary domestic data. | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'trinsic_api'
|
|
16
|
+
|
|
17
|
+
instance = TrinsicApi::Iso180132BiometricTemplate.new(
|
|
18
|
+
header: null,
|
|
19
|
+
data_block: null,
|
|
20
|
+
data_is_encrypted: false,
|
|
21
|
+
biometric_information_record_payload: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# TrinsicApi::Iso180132BiometricTemplateHeader
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **patron_header_version** | **Integer** | Patron header version (defaults to 0x0101). | |
|
|
8
|
+
| **biometric_type** | **Integer** | Biometric type code per ISO 18013-2. | [optional] |
|
|
9
|
+
| **biometric_sub_type** | **Integer** | Biometric sub-type code per ISO 18013-2. | [optional] |
|
|
10
|
+
| **creation_date** | **Time** | Date and time the biometric template was created. | [optional] |
|
|
11
|
+
| **biometric_information_record_creator** | **String** | Name of the Biometric Information Record (BIR) creator. | [optional] |
|
|
12
|
+
| **validity_period** | [**Iso180132BiometricValidityPeriod**](Iso180132BiometricValidityPeriod.md) | Validity period of the biometric data block. | [optional] |
|
|
13
|
+
| **biometric_data_block_product** | [**Iso180132BiometricDataBlockProduct**](Iso180132BiometricDataBlockProduct.md) | Owner and type identifying the product that produced the biometric data block. | [optional] |
|
|
14
|
+
| **biometric_data_block_format_owner** | **Integer** | Format owner of the biometric data block. | |
|
|
15
|
+
| **biometric_data_block_format_type** | **Integer** | Format type of the biometric data block. | |
|
|
16
|
+
| **biometric_information_record_index** | **String** | Index identifier of the Biometric Information Record, when present. | [optional] |
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```ruby
|
|
21
|
+
require 'trinsic_api'
|
|
22
|
+
|
|
23
|
+
instance = TrinsicApi::Iso180132BiometricTemplateHeader.new(
|
|
24
|
+
patron_header_version: 257,
|
|
25
|
+
biometric_type: 2,
|
|
26
|
+
biometric_sub_type: 1,
|
|
27
|
+
creation_date: 2020-01-31T12:34:56Z,
|
|
28
|
+
biometric_information_record_creator: BiometricVendor,
|
|
29
|
+
validity_period: null,
|
|
30
|
+
biometric_data_block_product: null,
|
|
31
|
+
biometric_data_block_format_owner: 257,
|
|
32
|
+
biometric_data_block_format_type: 8,
|
|
33
|
+
biometric_information_record_index: idx-1
|
|
34
|
+
)
|
|
35
|
+
```
|
|
36
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# TrinsicApi::Iso180132BiometricValidityPeriod
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **not_before** | **Date** | Date the biometric data block becomes valid. | |
|
|
8
|
+
| **not_after** | **Date** | Date the biometric data block expires. | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'trinsic_api'
|
|
14
|
+
|
|
15
|
+
instance = TrinsicApi::Iso180132BiometricValidityPeriod.new(
|
|
16
|
+
not_before: Fri Jan 31 00:00:00 UTC 2020,
|
|
17
|
+
not_after: Thu Jan 31 00:00:00 UTC 2030
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# TrinsicApi::Iso180135AamvaDomesticDrivingPrivilege
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **vehicle_class** | [**Iso180135AamvaDomesticVehicleClass**](Iso180135AamvaDomesticVehicleClass.md) | Vehicle class describing the category of vehicle the holder is authorized to operate. | [optional] |
|
|
8
|
+
| **vehicle_restrictions** | [**Array<Iso180135AamvaDomesticVehicleRestriction>**](Iso180135AamvaDomesticVehicleRestriction.md) | Restrictions attached to this domestic driving privilege. | [optional] |
|
|
9
|
+
| **vehicle_endorsements** | [**Array<Iso180135AamvaDomesticVehicleEndorsement>**](Iso180135AamvaDomesticVehicleEndorsement.md) | Endorsements attached to this domestic driving privilege. | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'trinsic_api'
|
|
15
|
+
|
|
16
|
+
instance = TrinsicApi::Iso180135AamvaDomesticDrivingPrivilege.new(
|
|
17
|
+
vehicle_class: null,
|
|
18
|
+
vehicle_restrictions: [{"code":"B","description":"Corrective Lenses"}],
|
|
19
|
+
vehicle_endorsements: [{"code":"H","description":"Hazardous Materials"}]
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# TrinsicApi::Iso180135AamvaDomesticVehicleClass
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **code** | **String** | Vehicle class code. | |
|
|
8
|
+
| **description** | **String** | Human-readable description of the vehicle class. | |
|
|
9
|
+
| **issue_date** | **Date** | Date when this vehicle class privilege was issued. | [optional] |
|
|
10
|
+
| **expiry_date** | **Date** | Date when this vehicle class privilege expires. | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'trinsic_api'
|
|
16
|
+
|
|
17
|
+
instance = TrinsicApi::Iso180135AamvaDomesticVehicleClass.new(
|
|
18
|
+
code: C,
|
|
19
|
+
description: Passenger Vehicles,
|
|
20
|
+
issue_date: Fri Jan 31 00:00:00 UTC 2020,
|
|
21
|
+
expiry_date: Thu Jan 31 00:00:00 UTC 2030
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# TrinsicApi::Iso180135AamvaDomesticVehicleEndorsement
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **code** | **String** | Endorsement code, when present. | [optional] |
|
|
8
|
+
| **description** | **String** | Human-readable description of the endorsement. | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'trinsic_api'
|
|
14
|
+
|
|
15
|
+
instance = TrinsicApi::Iso180135AamvaDomesticVehicleEndorsement.new(
|
|
16
|
+
code: H,
|
|
17
|
+
description: Hazardous Materials
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# TrinsicApi::Iso180135AamvaDomesticVehicleRestriction
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **code** | **String** | Restriction code, when present. | [optional] |
|
|
8
|
+
| **description** | **String** | Human-readable description of the restriction. | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'trinsic_api'
|
|
14
|
+
|
|
15
|
+
instance = TrinsicApi::Iso180135AamvaDomesticVehicleRestriction.new(
|
|
16
|
+
code: B,
|
|
17
|
+
description: Corrective Lenses
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
# TrinsicApi::Iso180135AamvaNamespaceOutput
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **domestic_driving_privileges** | [**Array<Iso180135AamvaDomesticDrivingPrivilege>**](Iso180135AamvaDomesticDrivingPrivilege.md) | Domestic categories of vehicles, restrictions, and conditions, parsed per AAMVA Section 7.2.4. | [optional] |
|
|
8
|
+
| **name_suffix** | **String** | Name suffix of the individual that has been issued the credential. | [optional] |
|
|
9
|
+
| **organ_donor** | **Boolean** | Whether the individual is an organ donor. | [optional] |
|
|
10
|
+
| **veteran** | **Boolean** | Whether the individual is a veteran. | [optional] |
|
|
11
|
+
| **family_name_truncation** | **String** | Indicates whether the family name has been truncated. Possible values: - 'T': Truncated - 'N': Not truncated - 'U': Unknown whether truncated | [optional] |
|
|
12
|
+
| **given_name_truncation** | **String** | Indicates whether the given name has been truncated. Possible values: - 'T': Truncated - 'N': Not truncated - 'U': Unknown whether truncated | [optional] |
|
|
13
|
+
| **aka_family_name_v2** | **String** | Other family name by which the individual is known. | [optional] |
|
|
14
|
+
| **aka_given_name_v2** | **String** | Other given name by which the individual is known. | [optional] |
|
|
15
|
+
| **aka_suffix** | **String** | Other suffix by which the individual is known. | [optional] |
|
|
16
|
+
| **weight_range** | [**Iso180135AamvaWeightRange**](Iso180135AamvaWeightRange.md) | Approximate weight range of the individual, in kilograms. | [optional] |
|
|
17
|
+
| **race_ethnicity** | **String** | AAMVA D20 race or ethnicity code of the individual. | [optional] |
|
|
18
|
+
| **sex** | **Integer** | The sex of the individual as an AAMVA-defined sex code. This is distinct from an ISO/IEC 5218 sex code in two ways: there is no \"Unknown\" value, and \"Not Applicable\" is replaced with \"Not Specified\". Possible values: - 1: Male - 2: Female - 9: Not Specified | [optional] |
|
|
19
|
+
| **first_name** | **String** | First name of the individual. | [optional] |
|
|
20
|
+
| **middle_names** | **String** | Middle name or names of the individual. | [optional] |
|
|
21
|
+
| **first_name_truncation** | **String** | Whether the first name has been truncated. | [optional] |
|
|
22
|
+
| **middle_names_truncation** | **String** | Whether the middle name has been truncated. | [optional] |
|
|
23
|
+
| **edl_credential** | **Integer** | Deprecated AAMVA EDL (Enhanced Driver's License) credential indicator. If present, indicates the type of the EDL credential. Possible values: 1: Driver's License 2: Identification Card | [optional] |
|
|
24
|
+
| **edl_credential_v2** | **Boolean** | Whether the credential is an Enhanced Driver's License (EDL). | [optional] |
|
|
25
|
+
| **dhs_compliance** | **Boolean** | Whether the credential is REAL ID compliant. `true` for fully compliant (\"F\"), `false` for non-compliant (\"N\"), `null` when not present. | [optional] |
|
|
26
|
+
| **resident_county** | **String** | Deprecated county code for the county where the individual lives. | [optional] |
|
|
27
|
+
| **resident_county_v2** | **String** | County code for the county where the individual lives. | [optional] |
|
|
28
|
+
| **hazmat_endorsement_expiration_date** | **Date** | Date on which the hazardous material endorsement expires. | [optional] |
|
|
29
|
+
| **cdl_indicator** | **Boolean** | Whether the credential is a Commercial Driver's License (CDL) per FMCSA. | [optional] |
|
|
30
|
+
| **cdl_non_domiciled** | **Boolean** | Deprecated. Whether the CDL holder is non-domiciled in the issuing jurisdiction. | [optional] |
|
|
31
|
+
| **cdl_non_domiciled_v2** | **Boolean** | Whether the CDL holder is non-domiciled in the issuing jurisdiction. | [optional] |
|
|
32
|
+
| **dhs_compliance_text** | **String** | Text agreed on between the issuing authority and DHS for non-compliant credentials. | [optional] |
|
|
33
|
+
| **dhs_temporary_lawful_status** | **Boolean** | Whether the individual has DHS temporary lawful status. | [optional] |
|
|
34
|
+
|
|
35
|
+
## Example
|
|
36
|
+
|
|
37
|
+
```ruby
|
|
38
|
+
require 'trinsic_api'
|
|
39
|
+
|
|
40
|
+
instance = TrinsicApi::Iso180135AamvaNamespaceOutput.new(
|
|
41
|
+
domestic_driving_privileges: [{"vehicleClass":{"code":"C","description":"Passenger Vehicles"}}],
|
|
42
|
+
name_suffix: JR,
|
|
43
|
+
organ_donor: true,
|
|
44
|
+
veteran: true,
|
|
45
|
+
family_name_truncation: N,
|
|
46
|
+
given_name_truncation: N,
|
|
47
|
+
aka_family_name_v2: SMITH,
|
|
48
|
+
aka_given_name_v2: JOHN,
|
|
49
|
+
aka_suffix: JR,
|
|
50
|
+
weight_range: null,
|
|
51
|
+
race_ethnicity: U,
|
|
52
|
+
sex: 1,
|
|
53
|
+
first_name: JOHN,
|
|
54
|
+
middle_names: ALBERT,
|
|
55
|
+
first_name_truncation: N,
|
|
56
|
+
middle_names_truncation: N,
|
|
57
|
+
edl_credential: 1,
|
|
58
|
+
edl_credential_v2: true,
|
|
59
|
+
dhs_compliance: true,
|
|
60
|
+
resident_county: 067,
|
|
61
|
+
resident_county_v2: 067,
|
|
62
|
+
hazmat_endorsement_expiration_date: Thu Jan 31 00:00:00 UTC 2030,
|
|
63
|
+
cdl_indicator: true,
|
|
64
|
+
cdl_non_domiciled: true,
|
|
65
|
+
cdl_non_domiciled_v2: true,
|
|
66
|
+
dhs_compliance_text: Federal Limits Apply,
|
|
67
|
+
dhs_temporary_lawful_status: true
|
|
68
|
+
)
|
|
69
|
+
```
|
|
70
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# TrinsicApi::Iso180135AamvaWeightRange
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **min_kilograms** | **Integer** | Minimum weight in the range, in kilograms. | |
|
|
8
|
+
| **max_kilograms** | **Integer** | Maximum weight in the range, in kilograms. If null, the maximum weight has no limit. | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'trinsic_api'
|
|
14
|
+
|
|
15
|
+
instance = TrinsicApi::Iso180135AamvaWeightRange.new(
|
|
16
|
+
min_kilograms: 71,
|
|
17
|
+
max_kilograms: 86
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# TrinsicApi::Iso180135DrivingPrivilege
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **vehicle_category_code** | **String** | Vehicle category code that the holder is authorized to operate. | |
|
|
8
|
+
| **issue_date** | **Date** | Date when this driving privilege was issued. | [optional] |
|
|
9
|
+
| **expiry_date** | **Date** | Date when this driving privilege expires. | [optional] |
|
|
10
|
+
| **codes** | [**Array<Iso180135DrivingPrivilegeCode>**](Iso180135DrivingPrivilegeCode.md) | Restriction, condition, or special privilege codes attached to this entry. | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'trinsic_api'
|
|
16
|
+
|
|
17
|
+
instance = TrinsicApi::Iso180135DrivingPrivilege.new(
|
|
18
|
+
vehicle_category_code: C,
|
|
19
|
+
issue_date: Fri Jan 31 00:00:00 UTC 2020,
|
|
20
|
+
expiry_date: Thu Jan 31 00:00:00 UTC 2030,
|
|
21
|
+
codes: [{"code":"B","sign":"<=","value":"70"}]
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# TrinsicApi::Iso180135DrivingPrivilegeCode
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **code** | **String** | The code identifier. | |
|
|
8
|
+
| **sign** | **String** | Optional comparison sign applied to the code's value. | [optional] |
|
|
9
|
+
| **value** | **String** | Optional value applied to the code. | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'trinsic_api'
|
|
15
|
+
|
|
16
|
+
instance = TrinsicApi::Iso180135DrivingPrivilegeCode.new(
|
|
17
|
+
code: B,
|
|
18
|
+
sign: <=,
|
|
19
|
+
value: 70
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# TrinsicApi::Iso180135MobileDriversLicenseCredential
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **standard** | [**Iso180135StandardNamespaceOutput**](Iso180135StandardNamespaceOutput.md) | Fields from the standard `org.iso.18013.5.1` namespace within the Mobile Driver's License. This namespace is the primary dataset defined for Mobile Driver's License credentials. | [optional] |
|
|
8
|
+
| **aamva** | [**Iso180135AamvaNamespaceOutput**](Iso180135AamvaNamespaceOutput.md) | Fields from the `org.iso.18013.5.1.aamva` namespace. This namespace is an additional dataset defined by AAMVA (American Association of Motor Vehicle Administrators). | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'trinsic_api'
|
|
14
|
+
|
|
15
|
+
instance = TrinsicApi::Iso180135MobileDriversLicenseCredential.new(
|
|
16
|
+
standard: null,
|
|
17
|
+
aamva: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|