trinsic_api 3.1.0.pre.preview1 → 3.2.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/AppleWalletDigitalIdBirthDate.md +20 -0
- data/docs/AppleWalletDigitalIdCredential.md +54 -0
- data/docs/AppleWalletProviderOutput.md +4 -0
- data/docs/BrazilCnhFacialBiometryOutput.md +24 -0
- data/docs/BrazilCnhMatchFieldDateOnly.md +20 -0
- data/docs/BrazilCnhMatchFieldString.md +20 -0
- data/docs/BrazilCnhProviderOutput.md +48 -0
- data/docs/CreateDirectProviderSessionRequest.md +1 -1
- data/docs/CreateHostedProviderSessionRequest.md +1 -1
- data/docs/CzechBankIdAddress.md +36 -0
- data/docs/CzechBankIdCard.md +30 -0
- data/docs/CzechBankIdProviderOutput.md +78 -0
- data/docs/CzechBankIdTitle.md +20 -0
- data/docs/CzechBankIdVerification.md +22 -0
- data/docs/DiiaIssuerOutput.md +28 -0
- data/docs/DiiaProviderOutput.md +20 -0
- data/docs/DiiaSubjectOutput.md +26 -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/IdemiaPreviewProviderAddress.md +32 -0
- data/docs/IdemiaPreviewProviderOutput.md +76 -0
- data/docs/IndiaDigilockerAadhaarMatchDateOfBirthField.md +20 -0
- data/docs/IndiaDigilockerAadhaarMatchFullNameField.md +20 -0
- data/docs/IndiaDigilockerAadhaarMatchProviderOutput.md +20 -0
- data/docs/IndonesiaDukcapilMatchDateOfBirthField.md +20 -0
- data/docs/IndonesiaDukcapilMatchFullNameField.md +20 -0
- data/docs/IndonesiaDukcapilMatchNationalIdNumberField.md +20 -0
- data/docs/IndonesiaDukcapilMatchProviderOutput.md +38 -0
- data/docs/IndonesiaNikMatch.md +34 -0
- data/docs/IndonesiaNikMatchField.md +20 -0
- data/docs/InteracAddress.md +26 -0
- data/docs/InteracProviderOutput.md +34 -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/ItsmeAddress.md +28 -0
- data/docs/ItsmeProviderOutput.md +19 -1
- data/docs/KenyaNidMatch2DateOfBirthField.md +20 -0
- data/docs/KenyaNidMatch2FullNameField.md +20 -0
- data/docs/KenyaNidMatch2NationalIdNumberField.md +20 -0
- data/docs/KenyaNidMatch2ProviderOutput.md +24 -0
- data/docs/KenyaNidMatch2SexField.md +20 -0
- data/docs/LloydsSmartIdProviderOutput.md +2 -2
- data/docs/MexicoCurpProviderOutput.md +23 -1
- data/docs/NigeriaNinLookup2Input.md +1 -1
- data/docs/NigeriaNinLookup2ProviderOutput.md +2 -2
- data/docs/NigeriaNinMatch2DateOfBirthField.md +20 -0
- data/docs/NigeriaNinMatch2FullNameField.md +20 -0
- data/docs/NigeriaNinMatch2Input.md +1 -1
- data/docs/NigeriaNinMatch2NationalIdNumberField.md +20 -0
- data/docs/NigeriaNinMatch2PhoneNumberField.md +20 -0
- data/docs/NigeriaNinMatch2ProviderOutput.md +26 -0
- data/docs/NigeriaNinMatch2SexField.md +20 -0
- data/docs/PhilippinesPhilsysMatchProviderOutput.md +26 -0
- data/docs/PostOfficeEasyIdProviderOutput.md +2 -2
- data/docs/ProviderInput.md +0 -6
- data/docs/ProviderOutput.md +37 -3
- data/docs/SamsungWalletProviderOutput.md +2 -0
- data/docs/SouthAfricaNidLookup2Input.md +1 -1
- data/docs/SouthAfricaNidLookup2ProviderOutput.md +36 -0
- data/docs/SouthAfricaNidMatch2DateOfBirthField.md +20 -0
- data/docs/SouthAfricaNidMatch2FullNameField.md +20 -0
- data/docs/SouthAfricaNidMatch2Input.md +2 -4
- data/docs/SouthAfricaNidMatch2NationalIdNumberField.md +20 -0
- data/docs/SouthAfricaNidMatch2ProviderOutput.md +26 -0
- data/docs/SouthAfricaNidMatch2SexField.md +20 -0
- data/docs/UAEPassProviderOutput.md +62 -0
- data/docs/UgandaNidMatch2DateOfBirthField.md +20 -0
- data/docs/UgandaNidMatch2Input.md +1 -1
- data/docs/UgandaNidMatch2NationalIdNumberField.md +20 -0
- data/docs/UgandaNidMatch2ProviderOutput.md +22 -0
- data/docs/UgandaNidMatch2SecondaryIdNumberField.md +20 -0
- data/docs/VerimiAddressOutput.md +28 -0
- data/docs/VerimiProviderOutput.md +68 -0
- data/docs/YotiDeeplinkProviderOutput.md +2 -2
- data/docs/YotiProviderOutput.md +2 -2
- data/docs/ZimbabweNidLookup2Input.md +1 -1
- data/docs/ZimbabweNidLookup2ProviderOutput.md +34 -0
- data/lib/trinsic_api/models/age_over_output.rb +193 -0
- data/lib/trinsic_api/models/apple_wallet_digital_id_birth_date.rb +177 -0
- data/lib/trinsic_api/models/apple_wallet_digital_id_credential.rb +350 -0
- data/lib/trinsic_api/models/apple_wallet_provider_output.rb +23 -1
- data/lib/trinsic_api/models/brazil_cnh_facial_biometry_output.rb +198 -0
- data/lib/trinsic_api/models/brazil_cnh_match_field_date_only.rb +176 -0
- data/lib/trinsic_api/models/brazil_cnh_match_field_string.rb +160 -0
- data/lib/trinsic_api/models/brazil_cnh_provider_output.rb +315 -0
- data/lib/trinsic_api/models/create_direct_provider_session_request.rb +1 -1
- data/lib/trinsic_api/models/create_hosted_provider_session_request.rb +1 -1
- data/lib/trinsic_api/models/czech_bank_id_address.rb +296 -0
- data/lib/trinsic_api/models/czech_bank_id_card.rb +279 -0
- data/lib/trinsic_api/models/czech_bank_id_provider_output.rb +504 -0
- data/lib/trinsic_api/models/czech_bank_id_title.rb +160 -0
- data/lib/trinsic_api/models/czech_bank_id_verification.rb +203 -0
- data/lib/trinsic_api/models/diia_issuer_output.rb +204 -0
- data/lib/trinsic_api/models/diia_provider_output.rb +193 -0
- data/lib/trinsic_api/models/diia_subject_output.rb +193 -0
- data/lib/trinsic_api/models/{south_africa_nid_biometric2_input.rb → eudi_age_verification_credential.rb} +31 -30
- 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/idemia_preview_provider_address.rb +226 -0
- data/lib/trinsic_api/models/idemia_preview_provider_output.rb +469 -0
- data/lib/trinsic_api/models/india_digilocker_aadhaar_match_date_of_birth_field.rb +192 -0
- data/lib/trinsic_api/models/india_digilocker_aadhaar_match_full_name_field.rb +192 -0
- data/lib/trinsic_api/models/india_digilocker_aadhaar_match_provider_output.rb +161 -0
- data/lib/trinsic_api/models/indonesia_dukcapil_match_date_of_birth_field.rb +192 -0
- data/lib/trinsic_api/models/indonesia_dukcapil_match_full_name_field.rb +192 -0
- data/lib/trinsic_api/models/indonesia_dukcapil_match_national_id_number_field.rb +192 -0
- data/lib/trinsic_api/models/indonesia_dukcapil_match_provider_output.rb +404 -0
- data/lib/trinsic_api/models/indonesia_nik_match.rb +238 -0
- data/lib/trinsic_api/models/indonesia_nik_match_field.rb +192 -0
- data/lib/trinsic_api/models/{kenya_nid_biometric2_input.rb → interac_address.rb} +50 -30
- data/lib/trinsic_api/models/interac_provider_output.rb +237 -0
- 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/{nigeria_nin_biometric2_input.rb → iso180135_aamva_weight_range.rb} +37 -33
- 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/itsme_address.rb +204 -0
- data/lib/trinsic_api/models/itsme_provider_output.rb +104 -5
- data/lib/trinsic_api/models/kenya_nid_match2_date_of_birth_field.rb +192 -0
- data/lib/trinsic_api/models/kenya_nid_match2_full_name_field.rb +192 -0
- data/lib/trinsic_api/models/kenya_nid_match2_national_id_number_field.rb +192 -0
- data/lib/trinsic_api/models/kenya_nid_match2_provider_output.rb +215 -0
- data/lib/trinsic_api/models/kenya_nid_match2_sex_field.rb +192 -0
- data/lib/trinsic_api/models/lloyds_smart_id_provider_output.rb +8 -8
- data/lib/trinsic_api/models/mexico_curp_provider_output.rb +126 -5
- data/lib/trinsic_api/models/nigeria_nin_lookup2_input.rb +1 -1
- data/lib/trinsic_api/models/nigeria_nin_lookup2_provider_output.rb +1 -1
- data/lib/trinsic_api/models/nigeria_nin_match2_date_of_birth_field.rb +192 -0
- data/lib/trinsic_api/models/nigeria_nin_match2_full_name_field.rb +192 -0
- data/lib/trinsic_api/models/nigeria_nin_match2_input.rb +1 -1
- data/lib/trinsic_api/models/nigeria_nin_match2_national_id_number_field.rb +192 -0
- data/lib/trinsic_api/models/nigeria_nin_match2_phone_number_field.rb +192 -0
- data/lib/trinsic_api/models/nigeria_nin_match2_provider_output.rb +226 -0
- data/lib/trinsic_api/models/nigeria_nin_match2_sex_field.rb +192 -0
- data/lib/trinsic_api/models/philippines_philsys_match_provider_output.rb +226 -0
- data/lib/trinsic_api/models/post_office_easy_id_provider_output.rb +8 -8
- data/lib/trinsic_api/models/provider_input.rb +1 -34
- data/lib/trinsic_api/models/provider_output.rb +203 -16
- data/lib/trinsic_api/models/samsung_wallet_provider_output.rb +12 -1
- data/lib/trinsic_api/models/south_africa_nid_lookup2_input.rb +1 -1
- data/lib/trinsic_api/models/south_africa_nid_lookup2_provider_output.rb +377 -0
- data/lib/trinsic_api/models/south_africa_nid_match2_date_of_birth_field.rb +192 -0
- data/lib/trinsic_api/models/south_africa_nid_match2_full_name_field.rb +192 -0
- data/lib/trinsic_api/models/south_africa_nid_match2_input.rb +6 -17
- data/lib/trinsic_api/models/south_africa_nid_match2_national_id_number_field.rb +192 -0
- data/lib/trinsic_api/models/south_africa_nid_match2_provider_output.rb +226 -0
- data/lib/trinsic_api/models/south_africa_nid_match2_sex_field.rb +192 -0
- data/lib/trinsic_api/models/uae_pass_provider_output.rb +394 -0
- data/lib/trinsic_api/models/uganda_nid_match2_date_of_birth_field.rb +192 -0
- data/lib/trinsic_api/models/uganda_nid_match2_input.rb +1 -1
- data/lib/trinsic_api/models/uganda_nid_match2_national_id_number_field.rb +192 -0
- data/lib/trinsic_api/models/uganda_nid_match2_provider_output.rb +220 -0
- data/lib/trinsic_api/models/uganda_nid_match2_secondary_id_number_field.rb +192 -0
- data/lib/trinsic_api/models/verimi_address_output.rb +204 -0
- data/lib/trinsic_api/models/verimi_provider_output.rb +425 -0
- data/lib/trinsic_api/models/yoti_deeplink_provider_output.rb +8 -8
- data/lib/trinsic_api/models/yoti_provider_output.rb +8 -8
- data/lib/trinsic_api/models/zimbabwe_nid_lookup2_input.rb +1 -1
- data/lib/trinsic_api/models/zimbabwe_nid_lookup2_provider_output.rb +334 -0
- data/lib/trinsic_api/version.rb +1 -1
- data/lib/trinsic_api.rb +73 -3
- data/spec/models/age_over_output_spec.rb +42 -0
- data/spec/models/apple_wallet_digital_id_birth_date_spec.rb +42 -0
- data/spec/models/apple_wallet_digital_id_credential_spec.rb +144 -0
- data/spec/models/apple_wallet_provider_output_spec.rb +12 -0
- data/spec/models/brazil_cnh_facial_biometry_output_spec.rb +54 -0
- data/spec/models/brazil_cnh_match_field_date_only_spec.rb +42 -0
- data/spec/models/brazil_cnh_match_field_string_spec.rb +42 -0
- data/spec/models/brazil_cnh_provider_output_spec.rb +126 -0
- data/spec/models/czech_bank_id_address_spec.rb +90 -0
- data/spec/models/czech_bank_id_card_spec.rb +72 -0
- data/spec/models/czech_bank_id_provider_output_spec.rb +216 -0
- data/spec/models/czech_bank_id_title_spec.rb +42 -0
- data/spec/models/{kenya_nid_biometric2_input_spec.rb → czech_bank_id_verification_spec.rb} +9 -9
- data/spec/models/diia_issuer_output_spec.rb +66 -0
- data/spec/models/diia_provider_output_spec.rb +42 -0
- data/spec/models/diia_subject_output_spec.rb +60 -0
- data/spec/models/{south_africa_nid_biometric2_input_spec.rb → eudi_age_verification_credential_spec.rb} +9 -9
- 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/idemia_preview_provider_address_spec.rb +78 -0
- data/spec/models/idemia_preview_provider_output_spec.rb +210 -0
- data/spec/models/india_digilocker_aadhaar_match_date_of_birth_field_spec.rb +42 -0
- data/spec/models/india_digilocker_aadhaar_match_full_name_field_spec.rb +42 -0
- data/spec/models/india_digilocker_aadhaar_match_provider_output_spec.rb +42 -0
- data/spec/models/indonesia_dukcapil_match_date_of_birth_field_spec.rb +42 -0
- data/spec/models/indonesia_dukcapil_match_full_name_field_spec.rb +42 -0
- data/spec/models/indonesia_dukcapil_match_national_id_number_field_spec.rb +42 -0
- data/spec/models/indonesia_dukcapil_match_provider_output_spec.rb +96 -0
- data/spec/models/indonesia_nik_match_field_spec.rb +42 -0
- data/spec/models/indonesia_nik_match_spec.rb +84 -0
- data/spec/models/interac_address_spec.rb +60 -0
- data/spec/models/interac_provider_output_spec.rb +84 -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/{nigeria_nin_biometric2_input_spec.rb → iso180135_driving_privilege_code_spec.rb} +9 -9
- 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/itsme_address_spec.rb +66 -0
- data/spec/models/itsme_provider_output_spec.rb +54 -0
- data/spec/models/kenya_nid_match2_date_of_birth_field_spec.rb +42 -0
- data/spec/models/kenya_nid_match2_full_name_field_spec.rb +42 -0
- data/spec/models/kenya_nid_match2_national_id_number_field_spec.rb +42 -0
- data/spec/models/kenya_nid_match2_provider_output_spec.rb +54 -0
- data/spec/models/kenya_nid_match2_sex_field_spec.rb +42 -0
- data/spec/models/lloyds_smart_id_provider_output_spec.rb +1 -1
- data/spec/models/mexico_curp_provider_output_spec.rb +66 -0
- data/spec/models/nigeria_nin_match2_date_of_birth_field_spec.rb +42 -0
- data/spec/models/nigeria_nin_match2_full_name_field_spec.rb +42 -0
- data/spec/models/nigeria_nin_match2_national_id_number_field_spec.rb +42 -0
- data/spec/models/nigeria_nin_match2_phone_number_field_spec.rb +42 -0
- data/spec/models/nigeria_nin_match2_provider_output_spec.rb +60 -0
- data/spec/models/nigeria_nin_match2_sex_field_spec.rb +42 -0
- data/spec/models/philippines_philsys_match_provider_output_spec.rb +60 -0
- data/spec/models/post_office_easy_id_provider_output_spec.rb +1 -1
- data/spec/models/provider_input_spec.rb +0 -18
- data/spec/models/provider_output_spec.rb +108 -6
- data/spec/models/samsung_wallet_provider_output_spec.rb +6 -0
- data/spec/models/south_africa_nid_lookup2_provider_output_spec.rb +90 -0
- data/spec/models/south_africa_nid_match2_date_of_birth_field_spec.rb +42 -0
- data/spec/models/south_africa_nid_match2_full_name_field_spec.rb +42 -0
- data/spec/models/south_africa_nid_match2_input_spec.rb +0 -6
- data/spec/models/south_africa_nid_match2_national_id_number_field_spec.rb +42 -0
- data/spec/models/south_africa_nid_match2_provider_output_spec.rb +60 -0
- data/spec/models/south_africa_nid_match2_sex_field_spec.rb +42 -0
- data/spec/models/uae_pass_provider_output_spec.rb +168 -0
- data/spec/models/uganda_nid_match2_date_of_birth_field_spec.rb +42 -0
- data/spec/models/uganda_nid_match2_national_id_number_field_spec.rb +42 -0
- data/spec/models/uganda_nid_match2_provider_output_spec.rb +48 -0
- data/spec/models/uganda_nid_match2_secondary_id_number_field_spec.rb +42 -0
- data/spec/models/verimi_address_output_spec.rb +66 -0
- data/spec/models/verimi_provider_output_spec.rb +186 -0
- data/spec/models/yoti_deeplink_provider_output_spec.rb +1 -1
- data/spec/models/yoti_provider_output_spec.rb +1 -1
- data/spec/models/zimbabwe_nid_lookup2_provider_output_spec.rb +84 -0
- metadata +466 -186
- data/docs/KenyaNidBiometric2Input.md +0 -22
- data/docs/NigeriaNinBiometric2Input.md +0 -22
- data/docs/SouthAfricaNidBiometric2Input.md +0 -22
|
@@ -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
|
+
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
# TrinsicApi::Iso180135StandardNamespaceOutput
|
|
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
|
+
| **given_name_national_character** | **String** | The given name of the individual using the full UTF-8 character set. | [optional] |
|
|
9
|
+
| **family_name** | **String** | Last name, surname, or primary identifier of the individual. | [optional] |
|
|
10
|
+
| **family_name_national_character** | **String** | The family name of the individual using the full UTF-8 character set. | [optional] |
|
|
11
|
+
| **date_of_birth** | **Date** | The date of birth of the individual. | [optional] |
|
|
12
|
+
| **issue_date** | **Date** | The date when the mDL was issued. This date marks the beginning of the Administrative Validity Period of the mDL, which is usually (but not necessarily always) the same as the issue date of the underlying physical document used to create the mDL, if one exists. | [optional] |
|
|
13
|
+
| **expiry_date** | **Date** | The date when the mDL expires. This date marks the end of the Administrative Validity Period of the mDL, which is usually (but not necessarily always) the same as the expiration date of the underlying physical document used to create the mDL, if one exists. | [optional] |
|
|
14
|
+
| **issuing_country** | **String** | Alpha-2 country code of the issuing authority's country or territory. | [optional] |
|
|
15
|
+
| **issuing_authority** | **String** | Name or identifier of the mDL issuing authority. This field's contents are arbitrary; it has no guaranteed format. | [optional] |
|
|
16
|
+
| **issuing_jurisdiction** | **String** | ISO 3166-2 country-subdivision code for the jurisdiction that issued the mDL. | [optional] |
|
|
17
|
+
| **nationality** | **String** | Nationality of the individual as an ISO 3166-1 alpha-2 country code. | [optional] |
|
|
18
|
+
| **document_number** | **String** | The document number assigned to the mDL. This is typically the same as the document number of the underlying physical document used to create the mDL, if one exists. | [optional] |
|
|
19
|
+
| **driving_privileges** | [**Array<Iso180135DrivingPrivilege>**](Iso180135DrivingPrivilege.md) | Driving privileges of the individual, parsed per ISO 18013-5. | [optional] |
|
|
20
|
+
| **un_distinguishing_sign** | **String** | The UN Distinguishing sign of the issuing country according to ISO/IEC 18013-1. | [optional] |
|
|
21
|
+
| **administrative_number** | **String** | Audit control number assigned by the issuing authority. The meaning and semantics of this field are defined by the issuing authority in question. | [optional] |
|
|
22
|
+
| **sex** | **Integer** | The individual's sex as an ISO/IEC 5218 code. Possible values: - 0: Unknown - 1: Male - 2: Female - 9: Not Applicable | [optional] |
|
|
23
|
+
| **height_centimeters** | **Integer** | The individual's height in centimeters. | [optional] |
|
|
24
|
+
| **weight_kilograms** | **Integer** | The individual's weight in kilograms. | [optional] |
|
|
25
|
+
| **eye_color** | **String** | The individual's eye color. Possible values: - \"black\" - \"blue\" - \"brown\" - \"dichromatic\" - \"grey\" - \"green\" - \"hazel\" - \"maroon\" - \"pink\" - \"unknown\" | [optional] |
|
|
26
|
+
| **hair_color** | **String** | The individual's hair color. Possible values: - \"bald\" - \"black\" - \"blond\" - \"brown\" - \"grey\" - \"red\" - \"auburn\" - \"sandy\" - \"white\" - \"unknown\" | [optional] |
|
|
27
|
+
| **birth_place** | **String** | Country and municipality or state/province where the individual was born. | [optional] |
|
|
28
|
+
| **resident_address** | **String** | Address where the individual resides. The exact format of this field is variable and depends on the issuer. It may map exactly to a \"Line1\", or it may include city, state, and/or zip code as well. | [optional] |
|
|
29
|
+
| **resident_city** | **String** | City where the individual resides. | [optional] |
|
|
30
|
+
| **resident_state** | **String** | State, province, or district where the individual resides. | [optional] |
|
|
31
|
+
| **resident_postal_code** | **String** | Postal code where the individual resides. | [optional] |
|
|
32
|
+
| **resident_country** | **String** | Country where the individual resides as an ISO 3166-1 alpha-2 country code. | [optional] |
|
|
33
|
+
| **portrait_capture_date** | **Time** | Date and time when the portrait image was captured. | [optional] |
|
|
34
|
+
| **age_in_years** | **Integer** | Age of the individual in years. | [optional] |
|
|
35
|
+
| **age_birth_year** | **Integer** | Year of birth of the individual. | [optional] |
|
|
36
|
+
| **age_over** | [**Array<AgeOverOutput>**](AgeOverOutput.md) | Processed age-over claims returned by the mDL. | [optional] |
|
|
37
|
+
| **biometric_template_face** | [**Iso180132BiometricGroupTemplate**](Iso180132BiometricGroupTemplate.md) | Facial biometric template group from `biometric_template_face`, parsed per ISO 18013-2 Annex C. | [optional] |
|
|
38
|
+
| **biometric_template_voice** | [**Iso180132BiometricGroupTemplate**](Iso180132BiometricGroupTemplate.md) | Vocal biometric template group from `biometric_template_voice`, parsed per ISO 18013-2 Annex C. | [optional] |
|
|
39
|
+
| **biometric_template_finger** | [**Iso180132BiometricGroupTemplate**](Iso180132BiometricGroupTemplate.md) | Fingerprint biometric template group from `biometric_template_finger`, parsed per ISO 18013-2 Annex C. | [optional] |
|
|
40
|
+
| **biometric_template_iris** | [**Iso180132BiometricGroupTemplate**](Iso180132BiometricGroupTemplate.md) | Iris biometric template group from `biometric_template_iris`, parsed per ISO 18013-2 Annex C. | [optional] |
|
|
41
|
+
| **biometric_template_retina** | [**Iso180132BiometricGroupTemplate**](Iso180132BiometricGroupTemplate.md) | Retinal biometric template group from `biometric_template_retina`, parsed per ISO 18013-2 Annex C. | [optional] |
|
|
42
|
+
|
|
43
|
+
## Example
|
|
44
|
+
|
|
45
|
+
```ruby
|
|
46
|
+
require 'trinsic_api'
|
|
47
|
+
|
|
48
|
+
instance = TrinsicApi::Iso180135StandardNamespaceOutput.new(
|
|
49
|
+
given_name: JOHN,
|
|
50
|
+
given_name_national_character: JOHN,
|
|
51
|
+
family_name: DOE,
|
|
52
|
+
family_name_national_character: DOE,
|
|
53
|
+
date_of_birth: Wed Jan 31 00:00:00 UTC 1990,
|
|
54
|
+
issue_date: Fri Jan 31 00:00:00 UTC 2020,
|
|
55
|
+
expiry_date: Thu Jan 31 00:00:00 UTC 2030,
|
|
56
|
+
issuing_country: US,
|
|
57
|
+
issuing_authority: CA,USA,
|
|
58
|
+
issuing_jurisdiction: US-CA,
|
|
59
|
+
nationality: US,
|
|
60
|
+
document_number: D1234567,
|
|
61
|
+
driving_privileges: [{"vehicleCategoryCode":"C","issueDate":"2020-01-31","expiryDate":"2030-01-31"}],
|
|
62
|
+
un_distinguishing_sign: USA,
|
|
63
|
+
administrative_number: 123456789,
|
|
64
|
+
sex: 1,
|
|
65
|
+
height_centimeters: 180,
|
|
66
|
+
weight_kilograms: 75,
|
|
67
|
+
eye_color: brown,
|
|
68
|
+
hair_color: black,
|
|
69
|
+
birth_place: SACRAMENTO, CA,
|
|
70
|
+
resident_address: 123 MAIN ST,
|
|
71
|
+
resident_city: SACRAMENTO,
|
|
72
|
+
resident_state: CA,
|
|
73
|
+
resident_postal_code: 95814,
|
|
74
|
+
resident_country: US,
|
|
75
|
+
portrait_capture_date: 2020-01-31T12:34:56Z,
|
|
76
|
+
age_in_years: 35,
|
|
77
|
+
age_birth_year: 1990,
|
|
78
|
+
age_over: [{"age":18,"isOver":true},{"age":21,"isOver":true}],
|
|
79
|
+
biometric_template_face: null,
|
|
80
|
+
biometric_template_voice: null,
|
|
81
|
+
biometric_template_finger: null,
|
|
82
|
+
biometric_template_iris: null,
|
|
83
|
+
biometric_template_retina: null
|
|
84
|
+
)
|
|
85
|
+
```
|
|
86
|
+
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# TrinsicApi::ItsmeAddress
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **street_address** | **String** | The full street address on a single line. | [optional] |
|
|
8
|
+
| **street** | **String** | The street name component of the address. | [optional] |
|
|
9
|
+
| **house_number** | **String** | The house number component of the address. | [optional] |
|
|
10
|
+
| **postal_code** | **String** | The postal code of the address. | [optional] |
|
|
11
|
+
| **city** | **String** | The city of the address. | [optional] |
|
|
12
|
+
| **country** | **String** | The country of the address as an ISO 3166-1 alpha-2 code. | [optional] |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'trinsic_api'
|
|
18
|
+
|
|
19
|
+
instance = TrinsicApi::ItsmeAddress.new(
|
|
20
|
+
street_address: Rue du Bailli 81,
|
|
21
|
+
street: Rue du Bailli,
|
|
22
|
+
house_number: 81,
|
|
23
|
+
postal_code: 1050,
|
|
24
|
+
city: Ixelles,
|
|
25
|
+
country: BE
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
data/docs/ItsmeProviderOutput.md
CHANGED
|
@@ -9,6 +9,15 @@
|
|
|
9
9
|
| **date_of_birth** | **Date** | The date of birth of the verified individual | |
|
|
10
10
|
| **hashed_national_register_number** | **String** | The hashed version of the Belgian National Register Number of the verified individual. By default, itsme does not return the raw National Register Number of the individual; instead, only a hashed version is returned. Your account must be approved by itsme to receive the raw, unhashed National Register Number. | [optional] |
|
|
11
11
|
| **national_register_number** | **String** | The raw (not hashed) Belgian National Register Number (\"Rijksregisternummer\") of the verified individual. Only returned if your account has been explicitly authorized to receive it by itsme; by law, this data is considered sensitive personal data. This is an 11-digit number in the format YYMMDDXXXCC, where: - YYMMDD represents the individual's date of birth (year, month, day). - XXX is a sequential birth number, odd for females and even for males. - CC is a checksum, calculated with the equation: 97 - (YYMMDDXXX mod 97) For births in the year 2000 or later, the digit '2' is prepended to the first 9 digits during checksum calculation. | [optional] |
|
|
12
|
+
| **email** | **String** | The individual's email address. | [optional] |
|
|
13
|
+
| **phone_number** | **String** | The individual's phone number in international format. | [optional] |
|
|
14
|
+
| **gender** | **String** | The individual's gender. Possible values: - Male - Female - Unknown - Not Applicable | [optional] |
|
|
15
|
+
| **nationality** | **String** | The individual's nationality as an ISO 3166-1 alpha-3 code. | [optional] |
|
|
16
|
+
| **birth_place** | **String** | The individual's place of birth. | [optional] |
|
|
17
|
+
| **document_number** | **String** | The document number | [optional] |
|
|
18
|
+
| **identity_document_expiration_date** | **Date** | The expiration date of the identity document. | [optional] |
|
|
19
|
+
| **language** | **String** | The individual's language as an ISO 639-1 code. Expected values: NL, FR, DE, EN. | [optional] |
|
|
20
|
+
| **address** | [**ItsmeAddress**](ItsmeAddress.md) | The individual's address | [optional] |
|
|
12
21
|
|
|
13
22
|
## Example
|
|
14
23
|
|
|
@@ -20,7 +29,16 @@ instance = TrinsicApi::ItsmeProviderOutput.new(
|
|
|
20
29
|
last_name: Doe,
|
|
21
30
|
date_of_birth: Tue Dec 10 00:00:00 UTC 1985,
|
|
22
31
|
hashed_national_register_number: 5d17e158243dff0bd79fbfd06b27b80d04a40a6a0425e1bbb474c7634a2918f7,
|
|
23
|
-
national_register_number: 83122412413
|
|
32
|
+
national_register_number: 83122412413,
|
|
33
|
+
email: louison.brunet@example.com,
|
|
34
|
+
phone_number: +32479350919,
|
|
35
|
+
gender: Male,
|
|
36
|
+
nationality: BEL,
|
|
37
|
+
birth_place: Namur,
|
|
38
|
+
document_number: 351907284611,
|
|
39
|
+
identity_document_expiration_date: Tue Jun 16 00:00:00 UTC 2026,
|
|
40
|
+
language: EN,
|
|
41
|
+
address: null
|
|
24
42
|
)
|
|
25
43
|
```
|
|
26
44
|
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# TrinsicApi::KenyaNidMatch2DateOfBirthField
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **input_value** | **Date** | The date of birth submitted for this check. | |
|
|
8
|
+
| **outcome** | **String** | The outcome of comparing the submitted date of birth against the Integrated Population Registration System (IPRS). Possible values: - Exact Match - Partial Match - Transposed - No Match - Not Returned | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'trinsic_api'
|
|
14
|
+
|
|
15
|
+
instance = TrinsicApi::KenyaNidMatch2DateOfBirthField.new(
|
|
16
|
+
input_value: Wed Jan 02 00:00:00 UTC 1985,
|
|
17
|
+
outcome: Partial Match
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# TrinsicApi::KenyaNidMatch2FullNameField
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **input_value** | **String** | The full name string submitted for this check (as provided in the match input). | |
|
|
8
|
+
| **outcome** | **String** | The outcome of comparing the submitted full name against the Integrated Population Registration System (IPRS). Possible values: - Exact Match - Partial Match - Transposed - No Match - Not Returned | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'trinsic_api'
|
|
14
|
+
|
|
15
|
+
instance = TrinsicApi::KenyaNidMatch2FullNameField.new(
|
|
16
|
+
input_value: OTIENO JUMA ODHIAMBO,
|
|
17
|
+
outcome: Transposed
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# TrinsicApi::KenyaNidMatch2NationalIdNumberField
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **input_value** | **String** | The Kenya National ID Number (Nambari ya Kitambulisho) or Unique Personal Identifier (Maisha Namba). This is the primary unique identifier for Kenyan citizens in all government systems, issued by the National Registration Bureau (NRB). The format is up to 8 digits for National ID or 9 digits for Maisha Namba UPI (the new format since 2023). Format: - Up to 8 digits for National ID, unique and sequentially generated - 9 digits for Maisha Namba UPI, unique and randomly generated - Neither number encodes any information about the individual | |
|
|
8
|
+
| **outcome** | **String** | The outcome of verifying the national ID number against the Integrated Population Registration System (IPRS). Possible values: - Verified - Not Verified - Not Done - Issuer Unavailable - Not Returned | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'trinsic_api'
|
|
14
|
+
|
|
15
|
+
instance = TrinsicApi::KenyaNidMatch2NationalIdNumberField.new(
|
|
16
|
+
input_value: 12345678,
|
|
17
|
+
outcome: Verified
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# TrinsicApi::KenyaNidMatch2ProviderOutput
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **national_id_number** | [**KenyaNidMatch2NationalIdNumberField**](KenyaNidMatch2NationalIdNumberField.md) | Outcome of the verification of the national ID number. | |
|
|
8
|
+
| **full_name** | [**KenyaNidMatch2FullNameField**](KenyaNidMatch2FullNameField.md) | Outcome of the verification of the full name. | |
|
|
9
|
+
| **date_of_birth** | [**KenyaNidMatch2DateOfBirthField**](KenyaNidMatch2DateOfBirthField.md) | Outcome of the verification of the date of birth. | [optional] |
|
|
10
|
+
| **sex** | [**KenyaNidMatch2SexField**](KenyaNidMatch2SexField.md) | Outcome of the verification of the sex. | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'trinsic_api'
|
|
16
|
+
|
|
17
|
+
instance = TrinsicApi::KenyaNidMatch2ProviderOutput.new(
|
|
18
|
+
national_id_number: null,
|
|
19
|
+
full_name: null,
|
|
20
|
+
date_of_birth: null,
|
|
21
|
+
sex: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# TrinsicApi::KenyaNidMatch2SexField
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **input_value** | **String** | The sex value submitted for this check. Possible input values: - Male - Female | |
|
|
8
|
+
| **outcome** | **String** | The outcome of comparing the submitted sex against the Integrated Population Registration System (IPRS). Possible values: - Exact Match - No Match - Not Provided - Not Returned | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'trinsic_api'
|
|
14
|
+
|
|
15
|
+
instance = TrinsicApi::KenyaNidMatch2SexField.new(
|
|
16
|
+
input_value: Female,
|
|
17
|
+
outcome: No Match
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **
|
|
7
|
+
| **yoti_remember_me_id** | **String** | A Yoti-generated unique ID for this individual, consistent across repeat shares and different for each Relying Party. | [optional] |
|
|
8
8
|
| **email** | **String** | The email address of the individual | [optional] |
|
|
9
9
|
| **given_name** | **String** | The given name of the individual. This can correspond to first and middle names in English. | [optional] |
|
|
10
10
|
| **family_name** | **String** | The family name of the individual | [optional] |
|
|
@@ -23,7 +23,7 @@
|
|
|
23
23
|
require 'trinsic_api'
|
|
24
24
|
|
|
25
25
|
instance = TrinsicApi::LloydsSmartIdProviderOutput.new(
|
|
26
|
-
|
|
26
|
+
yoti_remember_me_id: Ic3NCB/dWVB1k4QPOD98IpDJ8ut04 lPHPSNV0RWikAc+szH2NrZFK1 nG+cZgaXe8,
|
|
27
27
|
email: johndoe@example.com,
|
|
28
28
|
given_name: John Alvin,
|
|
29
29
|
family_name: Doe,
|
|
@@ -4,7 +4,18 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **first_name** | **String** | First name of the individual. | [optional] |
|
|
8
|
+
| **father_last_name** | **String** | The last name of the father of the individual. | [optional] |
|
|
9
|
+
| **mother_last_name** | **String** | The last name of the mother of the individual. | [optional] |
|
|
10
|
+
| **gender** | **String** | The gender of the individual. List of possible values: - Male - Female | [optional] |
|
|
11
|
+
| **date_of_birth** | **Date** | The date of birth of the individual. | [optional] |
|
|
12
|
+
| **country_of_birth** | **String** | The country of birth of the individual. | [optional] |
|
|
13
|
+
| **state_of_birth** | **String** | The state of birth of the individual. | [optional] |
|
|
14
|
+
| **curp** | **String** | The CURP (Clave Única de Registro de Población) that was verified. A CURP code is a unique identifier assigned to individuals in Mexico. It is 18 alphanumeric characters, with a structured meaning: ABCD YYMMDD G SS XYZ M C The first 4 letters (ABCD): A: The first letter of the paternal last name. B: First internal vowel of paternal last name. C: First letter of maternal last name. D: First letter of first name. YYMMDD: 2-digit year, month, day. G: Gender, H for Hombre (male) and M for Mujer (female). SS: State code (2 letters), e.g. NL for Nuevo León. X: First internal consonant of paternal last name. Y: First internal consonant of maternal last name. Z: First internal consonant of given name. M: Millennium indicator (0-9 for pre-2000 birth date, A-Z for post-2000's birth dates. C: Checksum character | [optional] |
|
|
7
15
|
| **curp_status** | **String** | Curp status for the subject. Possible values: - AN: Alta Normal (Normal registration) - Active - AH: Alta con Homonimia (Registration with homonymy) - Active - RCC: Registro de cambio afectando a CURP (Change affecting CURP) - Active - RCN: Registro de cambio no afectando a CURP (Change not affecting CURP) - Active - BAP: Baja por documento apócrifo (Low due to apocryphal document) - Inactive - BSU: Baja sin uso (Low curp without use) - Inactive - BD: Baja por defunción (Low curp due to death) - Inactive - BDM: Baja administrativa (Low, due to administrative process) - Inactive - BDP: Baja por adopción (Low, due to adoption) - Inactive - BJD: Baja Judicial (Low for judicial reasons) - Inactive | [optional] |
|
|
16
|
+
| **registration_year** | **Integer** | The year the CURP number was registered in. | [optional] |
|
|
17
|
+
| **registration_state** | **String** | The state the CURP number was registered in. | [optional] |
|
|
18
|
+
| **act_number** | **String** | The ACT (Número de Acta) number of the individual. The Act number is a civil registry index number. Various state have various formats of specifying these. | [optional] |
|
|
8
19
|
|
|
9
20
|
## Example
|
|
10
21
|
|
|
@@ -12,7 +23,18 @@
|
|
|
12
23
|
require 'trinsic_api'
|
|
13
24
|
|
|
14
25
|
instance = TrinsicApi::MexicoCurpProviderOutput.new(
|
|
15
|
-
|
|
26
|
+
first_name: Juan,
|
|
27
|
+
father_last_name: Pérez,
|
|
28
|
+
mother_last_name: García,
|
|
29
|
+
gender: Male,
|
|
30
|
+
date_of_birth: Sun Aug 15 00:00:00 UTC 1943,
|
|
31
|
+
country_of_birth: MEXICO,
|
|
32
|
+
state_of_birth: Veracruz,
|
|
33
|
+
curp: PEGJ430815HVZRRN08,
|
|
34
|
+
curp_status: AN,
|
|
35
|
+
registration_year: 1976,
|
|
36
|
+
registration_state: DISTRITO FEDERAL,
|
|
37
|
+
act_number: 00016
|
|
16
38
|
)
|
|
17
39
|
```
|
|
18
40
|
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **id_number** | **String** |
|
|
7
|
+
| **id_number** | **String** | National Identification Number (NIN). This is a unique, permanent identifier assigned by the National Identity Management Commission (NIMC) upon enrollment. Format: - 11 numeric digits - No publicly known encoding scheme is used to encode personal information in the NIN - Last digit is a checksum using the Verhoeff algorithm | [optional] |
|
|
8
8
|
|
|
9
9
|
## Example
|
|
10
10
|
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
| **sex** | **String** | The sex of the ID holder. Possible values: - Male - Female | [optional] |
|
|
11
11
|
| **date_of_birth** | **Date** | The date of birth of the ID holder. | [optional] |
|
|
12
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
|
|
13
|
+
| **national_identity_number** | **String** | National Identification Number (NIN). This is a unique, permanent identifier assigned by the National Identity Management Commission (NIMC) upon enrollment. Format: - 11 numeric digits - No publicly known encoding scheme is used to encode personal information in the NIN - Last digit is a checksum using the Verhoeff algorithm | |
|
|
14
14
|
| **phone_number** | **String** | Phone number registered with the National Identity Management Commission. | [optional] |
|
|
15
15
|
| **email** | **String** | Email address registered with the National Identity Management Commission. | [optional] |
|
|
16
16
|
| **address** | **String** | Full residential address as a single string, normalized to lowercase without delimiters. | [optional] |
|
|
@@ -29,7 +29,7 @@ instance = TrinsicApi::NigeriaNinLookup2ProviderOutput.new(
|
|
|
29
29
|
sex: Male,
|
|
30
30
|
date_of_birth: Wed Jan 31 00:00:00 UTC 1990,
|
|
31
31
|
birth_country: NG,
|
|
32
|
-
national_identity_number:
|
|
32
|
+
national_identity_number: 12345678902,
|
|
33
33
|
phone_number: +2340123456789,
|
|
34
34
|
email: user@example.com,
|
|
35
35
|
address: 816 ahmadu bello way central business district abuja,
|