trinsic_api 3.2.0 → 3.2.1
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/README.md +13 -0
- data/docs/AadhaarLanguage.md +1 -1
- data/docs/AgeOverOutput.md +2 -2
- data/docs/AlaskaMobileIdProviderOutput.md +20 -0
- data/docs/AppleWalletDigitalIdBirthDate.md +1 -1
- data/docs/AppleWalletProviderOutput.md +1 -1
- data/docs/AttachmentInfo.md +3 -1
- data/docs/AudkenniProviderOutput.md +3 -3
- data/docs/AustriaHandySignaturProviderOutput.md +2 -2
- data/docs/AustriaValeraEudiSandboxInput.md +18 -0
- data/docs/AustriaValeraEudiSandboxProviderOutput.md +22 -0
- data/docs/BelgiumIdCardProviderOutput.md +4 -4
- data/docs/BoliviaCiProviderOutput.md +4 -4
- data/docs/BrazilBiometricVerificationOutput.md +24 -0
- data/docs/BrazilCnhFacialBiometryOutput.md +1 -1
- data/docs/BrazilCpfCheckInput.md +2 -0
- data/docs/BrazilCpfProviderOutput.md +38 -0
- data/docs/ClearProviderOutput.md +56 -0
- data/docs/ClearProviderOutputAddress.md +28 -0
- data/docs/ClearProviderOutputCheck.md +28 -0
- data/docs/ClearProviderOutputCheckAdditionalDetails.md +18 -0
- data/docs/ClearProviderOutputDocument.md +42 -0
- data/docs/ClearProviderOutputHealthInsurance.md +32 -0
- data/docs/ClearProviderOutputHistoricalAddress.md +36 -0
- data/docs/ClearProviderOutputHistoricalData.md +20 -0
- data/docs/ClearProviderOutputHistoricalName.md +28 -0
- data/docs/ClearProviderOutputLocationInfo.md +30 -0
- data/docs/ClearProviderOutputPartialDate.md +22 -0
- data/docs/ClearProviderOutputSessionInfo.md +28 -0
- data/docs/ClearProviderOutputTraits.md +50 -0
- data/docs/ClearProviderOutputVerifiedEmail.md +22 -0
- data/docs/ClearProviderOutputWatchlistHit.md +24 -0
- data/docs/ClearProviderOutputWatchlistHitDetails.md +48 -0
- data/docs/ClearProviderOutputWatchlistHits.md +20 -0
- data/docs/ClearProviderOutputWatchlistSource.md +22 -0
- data/docs/ColombiaCcProviderOutput.md +10 -10
- data/docs/CoteDIvoireNidLookup2ProviderOutput.md +6 -6
- data/docs/CreateHostedProviderSessionResponse.md +1 -1
- data/docs/CzechBankIdAddress.md +3 -3
- data/docs/CzechBankIdCard.md +4 -4
- data/docs/CzechBankIdProviderOutput.md +1 -1
- data/docs/CzechBankIdVerification.md +2 -2
- data/docs/CzechiaMojeIdProviderOutput.md +4 -4
- data/docs/DenmarkAltIdInput.md +18 -0
- data/docs/DenmarkAltIdProviderOutput.md +22 -0
- data/docs/DigilockerAadhaarProviderOutput.md +1 -1
- data/docs/DiiaProviderOutput.md +2 -2
- data/docs/ElSalvadorDuiProviderOutput.md +3 -3
- data/docs/EstoniaIdCardProviderOutput.md +4 -4
- data/docs/EudiAgeVerificationCredential.md +1 -5
- data/docs/EudiReferenceWalletProviderOutput.md +20 -0
- data/docs/EvrotrustAddressComponents.md +48 -0
- data/docs/EvrotrustInput.md +20 -0
- data/docs/EvrotrustProviderOutput.md +78 -0
- data/docs/FinlandIdCardProviderOutput.md +4 -4
- data/docs/FranceIdentiteProviderOutput.md +1 -1
- data/docs/FrejaIndirectProviderOutput.md +4 -4
- data/docs/FrenchNumeriqueProviderOutput.md +10 -4
- data/docs/{FrenchNumeriqueGivenName.md → FrenchNumeriqueSplittedGivenName.md} +2 -4
- data/docs/{FrenchNumeriquePhone.md → FrenchNumeriqueSplittedPhone.md} +2 -4
- data/docs/GermanyEudiSandboxInput.md +18 -0
- data/docs/GermanyEudiSandboxProviderOutput.md +20 -0
- data/docs/GetAttachmentResponse.md +1 -1
- data/docs/GetSessionResultResponse.md +2 -2
- data/docs/GoogleWalletProviderOutput.md +1 -1
- data/docs/GuatemalaCuiLookupInput.md +3 -1
- data/docs/GuatemalaCuiProviderOutput.md +9 -9
- data/docs/IdemiaMobileIdProviderOutput.md +64 -0
- data/docs/IdentityData.md +1 -1
- data/docs/IndiaDigilockerAadhaarMatchDateOfBirthField.md +2 -2
- data/docs/IndiaDigilockerAadhaarMatchFullNameField.md +2 -2
- data/docs/IndiaPanStructuredNumber.md +5 -5
- data/docs/IndonesiaDukcapilMatchDateOfBirthField.md +2 -2
- data/docs/IndonesiaDukcapilMatchFullNameField.md +2 -2
- data/docs/IndonesiaDukcapilMatchNationalIdNumberField.md +2 -2
- data/docs/IndonesiaDukcapilMatchProviderOutput.md +9 -9
- data/docs/IndonesiaNikMatchField.md +2 -2
- data/docs/Iso180132BiometricDataBlockProduct.md +2 -2
- data/docs/Iso180132BiometricGroupTemplate.md +1 -1
- data/docs/Iso180132BiometricTemplate.md +3 -3
- data/docs/Iso180132BiometricTemplateHeader.md +3 -3
- data/docs/Iso180132BiometricValidityPeriod.md +2 -2
- data/docs/Iso180135AamvaDomesticVehicleClass.md +2 -2
- data/docs/Iso180135AamvaDomesticVehicleEndorsement.md +1 -1
- data/docs/Iso180135AamvaDomesticVehicleRestriction.md +1 -1
- data/docs/Iso180135AamvaWeightRange.md +1 -1
- data/docs/Iso180135DrivingPrivilege.md +1 -1
- data/docs/Iso180135DrivingPrivilegeCode.md +1 -1
- data/docs/ItsmeAddressBase.md +22 -0
- data/docs/ItsmeBelgianIdentityCard.md +26 -0
- data/docs/ItsmeBelgianNationalNumber.md +22 -0
- data/docs/ItsmeDirectDevice.md +40 -0
- data/docs/ItsmeIdentityDocument.md +26 -0
- data/docs/ItsmeLoginProviderOutput.md +44 -0
- data/docs/ItsmePlaceOfBirth.md +20 -0
- data/docs/ItsmeProviderAddress.md +26 -0
- data/docs/ItsmeProviderOutput.md +40 -28
- data/docs/KenyaNidLookup2ProviderOutput.md +6 -6
- data/docs/KenyaNidLookup3Input.md +18 -0
- data/docs/KenyaNidLookup3ProviderOutput.md +32 -0
- data/docs/KenyaNidMatch2DateOfBirthField.md +2 -2
- data/docs/KenyaNidMatch2FullNameField.md +2 -2
- data/docs/KenyaNidMatch2NationalIdNumberField.md +2 -2
- data/docs/KenyaNidMatch2ProviderOutput.md +2 -2
- data/docs/KenyaNidMatch2SexField.md +2 -2
- data/docs/KoreaTelcoMatchProviderOutput.md +3 -3
- data/docs/LaWalletProviderOutput.md +17 -17
- data/docs/LatviaEparakstsMobileProviderOutput.md +3 -3
- data/docs/LatviaEparakstsProviderOutput.md +3 -3
- data/docs/LithuaniaIdCardProviderOutput.md +4 -4
- data/docs/MdlOutput.md +4 -4
- data/docs/MdlOutputCertificateData.md +7 -5
- data/docs/MdlOutputFieldData.md +2 -2
- data/docs/MockOutputProviderInput.md +18 -0
- data/docs/MoldovaDriverLicenseCredential.md +42 -0
- data/docs/MoldovaEvoWalletInput.md +18 -0
- data/docs/MoldovaEvoWalletProviderOutput.md +26 -0
- data/docs/MoldovaIdentityCardCredential.md +60 -0
- data/docs/MoldovaVehicleRegistrationCertificateCredential.md +70 -0
- data/docs/NetherlandsEudiSandboxInput.md +18 -0
- data/docs/NetherlandsEudiSandboxProviderOutput.md +20 -0
- data/docs/NetherlandsIdinAddress.md +16 -6
- data/docs/NetherlandsIdinProviderOutput.md +8 -8
- data/docs/NigeriaNinLookup2ProviderOutput.md +5 -5
- data/docs/NigeriaNinLookup3Input.md +18 -0
- data/docs/NigeriaNinLookup3ProviderOutput.md +50 -0
- data/docs/NigeriaNinMatch2DateOfBirthField.md +2 -2
- data/docs/NigeriaNinMatch2FullNameField.md +2 -2
- data/docs/NigeriaNinMatch2NationalIdNumberField.md +2 -2
- data/docs/NigeriaNinMatch2PhoneNumberField.md +2 -2
- data/docs/NigeriaNinMatch2ProviderOutput.md +2 -2
- data/docs/NigeriaNinMatch2SexField.md +2 -2
- data/docs/PanamaCedulaLookupInput.md +1 -3
- data/docs/PanamaCedulaProviderOutput.md +5 -7
- data/docs/PeruDniAddress.md +3 -3
- data/docs/PeruDniProviderOutput.md +8 -8
- data/docs/PhilippinesDigitalNidProviderOutput.md +1 -1
- data/docs/PhilippinesPhilsysMatchProviderOutput.md +2 -2
- data/docs/PhilippinesPhysicalNidProviderOutput.md +1 -1
- data/docs/PolandEdoAppProviderOutput.md +4 -4
- data/docs/PolandMobywatelMatchInput.md +3 -3
- data/docs/PolandMobywatelMatchProviderOutput.md +2 -2
- data/docs/PolandMojeIdProviderOutput.md +3 -3
- data/docs/PortugalIdCardProviderOutput.md +4 -4
- data/docs/Provider.md +0 -4
- data/docs/ProviderInput.md +18 -0
- data/docs/ProviderOutput.md +29 -5
- data/docs/SamsungIdWithClearCredential.md +44 -0
- data/docs/SamsungWalletInput.md +1 -1
- data/docs/SamsungWalletProviderOutput.md +3 -1
- data/docs/SerbiaIdCardProviderOutput.md +4 -4
- data/docs/SignzyIndiaAadhaarFetchProviderOutput.md +2 -2
- data/docs/SouthAfricaNidLookup2ProviderOutput.md +8 -8
- data/docs/SouthAfricaNidMatch2DateOfBirthField.md +2 -2
- data/docs/SouthAfricaNidMatch2FullNameField.md +2 -2
- data/docs/SouthAfricaNidMatch2NationalIdNumberField.md +2 -2
- data/docs/SouthAfricaNidMatch2ProviderOutput.md +2 -2
- data/docs/SouthAfricaNidMatch2SexField.md +2 -2
- data/docs/SpidBillingInformation.md +3 -3
- data/docs/SpidProviderOutput.md +2 -2
- data/docs/SubProviderMetadata.md +4 -2
- data/docs/UgandaNidMatch2DateOfBirthField.md +2 -2
- data/docs/UgandaNidMatch2NationalIdNumberField.md +2 -2
- data/docs/UgandaNidMatch2ProviderOutput.md +3 -3
- data/docs/UgandaNidMatch2SecondaryIdNumberField.md +2 -2
- data/docs/ZimbabweNidLookup2ProviderOutput.md +6 -6
- data/lib/trinsic_api/configuration.rb +4 -0
- data/lib/trinsic_api/models/aadhaar_language.rb +1 -17
- data/lib/trinsic_api/models/age_over_output.rb +2 -34
- data/lib/trinsic_api/models/alaska_mobile_id_provider_output.rb +161 -0
- data/lib/trinsic_api/models/apple_wallet_digital_id_birth_date.rb +1 -17
- data/lib/trinsic_api/models/apple_wallet_provider_output.rb +1 -17
- data/lib/trinsic_api/models/attachment_info.rb +15 -4
- data/lib/trinsic_api/models/audkenni_provider_output.rb +3 -51
- data/lib/trinsic_api/models/austria_handy_signatur_provider_output.rb +2 -34
- data/lib/trinsic_api/models/austria_valera_eudi_sandbox_input.rb +149 -0
- data/lib/trinsic_api/models/austria_valera_eudi_sandbox_provider_output.rb +172 -0
- data/lib/trinsic_api/models/belgium_id_card_provider_output.rb +4 -68
- data/lib/trinsic_api/models/bolivia_ci_provider_output.rb +4 -68
- data/lib/trinsic_api/models/brazil_biometric_verification_output.rb +182 -0
- data/lib/trinsic_api/models/brazil_cnh_facial_biometry_output.rb +1 -17
- data/lib/trinsic_api/models/brazil_cpf_check_input.rb +12 -1
- data/lib/trinsic_api/models/brazil_cpf_provider_output.rb +262 -0
- data/lib/trinsic_api/models/clear_provider_output.rb +375 -0
- data/lib/trinsic_api/models/{verimi_address_output.rb → clear_provider_output_address.rb} +48 -48
- data/lib/trinsic_api/models/clear_provider_output_check.rb +206 -0
- data/lib/trinsic_api/models/clear_provider_output_check_additional_details.rb +149 -0
- data/lib/trinsic_api/models/clear_provider_output_document.rb +281 -0
- data/lib/trinsic_api/models/clear_provider_output_health_insurance.rb +226 -0
- data/lib/trinsic_api/models/clear_provider_output_historical_address.rb +255 -0
- data/lib/trinsic_api/models/clear_provider_output_historical_data.rb +164 -0
- data/lib/trinsic_api/models/clear_provider_output_historical_name.rb +204 -0
- data/lib/trinsic_api/models/clear_provider_output_location_info.rb +215 -0
- data/lib/trinsic_api/models/clear_provider_output_partial_date.rb +171 -0
- data/lib/trinsic_api/models/clear_provider_output_session_info.rb +204 -0
- data/lib/trinsic_api/models/clear_provider_output_traits.rb +325 -0
- data/lib/trinsic_api/models/clear_provider_output_verified_email.rb +171 -0
- data/lib/trinsic_api/models/clear_provider_output_watchlist_hit.rb +186 -0
- data/lib/trinsic_api/models/clear_provider_output_watchlist_hit_details.rb +346 -0
- data/lib/trinsic_api/models/clear_provider_output_watchlist_hits.rb +162 -0
- data/lib/trinsic_api/models/clear_provider_output_watchlist_source.rb +171 -0
- data/lib/trinsic_api/models/colombia_cc_provider_output.rb +10 -170
- data/lib/trinsic_api/models/cote_d_ivoire_nid_lookup2_provider_output.rb +6 -102
- data/lib/trinsic_api/models/create_hosted_provider_session_response.rb +1 -1
- data/lib/trinsic_api/models/czech_bank_id_address.rb +3 -51
- data/lib/trinsic_api/models/czech_bank_id_card.rb +4 -68
- data/lib/trinsic_api/models/czech_bank_id_provider_output.rb +1 -17
- data/lib/trinsic_api/models/czech_bank_id_verification.rb +2 -34
- data/lib/trinsic_api/models/czechia_moje_id_provider_output.rb +4 -68
- data/lib/trinsic_api/models/denmark_alt_id_input.rb +149 -0
- data/lib/trinsic_api/models/denmark_alt_id_provider_output.rb +172 -0
- data/lib/trinsic_api/models/digilocker_aadhaar_provider_output.rb +1 -17
- data/lib/trinsic_api/models/diia_provider_output.rb +2 -34
- data/lib/trinsic_api/models/el_salvador_dui_provider_output.rb +3 -51
- data/lib/trinsic_api/models/estonia_id_card_provider_output.rb +4 -68
- data/lib/trinsic_api/models/eudi_age_verification_credential.rb +6 -28
- data/lib/trinsic_api/models/eudi_reference_wallet_provider_output.rb +161 -0
- data/lib/trinsic_api/models/evrotrust_address_components.rb +314 -0
- data/lib/trinsic_api/models/evrotrust_input.rb +160 -0
- data/lib/trinsic_api/models/evrotrust_provider_output.rb +484 -0
- data/lib/trinsic_api/models/finland_id_card_provider_output.rb +4 -68
- data/lib/trinsic_api/models/france_identite_provider_output.rb +1 -17
- data/lib/trinsic_api/models/freja_indirect_provider_output.rb +4 -68
- data/lib/trinsic_api/models/french_numerique_provider_output.rb +38 -5
- data/lib/trinsic_api/models/{french_numerique_given_name.rb → french_numerique_splitted_given_name.rb} +5 -16
- data/lib/trinsic_api/models/{french_numerique_phone.rb → french_numerique_splitted_phone.rb} +5 -16
- data/lib/trinsic_api/models/germany_eudi_sandbox_input.rb +149 -0
- data/lib/trinsic_api/models/germany_eudi_sandbox_provider_output.rb +161 -0
- data/lib/trinsic_api/models/get_attachment_response.rb +1 -1
- data/lib/trinsic_api/models/get_session_result_response.rb +2 -0
- data/lib/trinsic_api/models/google_wallet_id_pass_credential.rb +1 -1
- data/lib/trinsic_api/models/google_wallet_provider_output.rb +1 -17
- data/lib/trinsic_api/models/guatemala_cui_lookup_input.rb +16 -5
- data/lib/trinsic_api/models/guatemala_cui_provider_output.rb +9 -153
- data/lib/trinsic_api/models/idemia_mobile_id_provider_output.rb +403 -0
- data/lib/trinsic_api/models/identity_data.rb +17 -1
- data/lib/trinsic_api/models/india_digilocker_aadhaar_match_date_of_birth_field.rb +2 -34
- data/lib/trinsic_api/models/india_digilocker_aadhaar_match_full_name_field.rb +2 -34
- data/lib/trinsic_api/models/india_pan_structured_number.rb +5 -85
- data/lib/trinsic_api/models/indonesia_dukcapil_match_date_of_birth_field.rb +2 -34
- data/lib/trinsic_api/models/indonesia_dukcapil_match_full_name_field.rb +2 -34
- data/lib/trinsic_api/models/indonesia_dukcapil_match_national_id_number_field.rb +2 -34
- data/lib/trinsic_api/models/indonesia_dukcapil_match_provider_output.rb +9 -153
- data/lib/trinsic_api/models/indonesia_nik_match_field.rb +2 -34
- data/lib/trinsic_api/models/iso180132_biometric_data_block_product.rb +2 -34
- data/lib/trinsic_api/models/iso180132_biometric_group_template.rb +1 -17
- data/lib/trinsic_api/models/iso180132_biometric_template.rb +3 -51
- data/lib/trinsic_api/models/iso180132_biometric_template_header.rb +3 -51
- data/lib/trinsic_api/models/iso180132_biometric_validity_period.rb +2 -34
- data/lib/trinsic_api/models/iso180135_aamva_domestic_vehicle_class.rb +2 -34
- data/lib/trinsic_api/models/iso180135_aamva_domestic_vehicle_endorsement.rb +1 -17
- data/lib/trinsic_api/models/iso180135_aamva_domestic_vehicle_restriction.rb +1 -17
- data/lib/trinsic_api/models/iso180135_aamva_weight_range.rb +1 -17
- data/lib/trinsic_api/models/iso180135_driving_privilege.rb +2 -18
- data/lib/trinsic_api/models/iso180135_driving_privilege_code.rb +1 -17
- data/lib/trinsic_api/models/itsme_address_base.rb +171 -0
- data/lib/trinsic_api/models/itsme_belgian_identity_card.rb +193 -0
- data/lib/trinsic_api/models/itsme_belgian_national_number.rb +171 -0
- data/lib/trinsic_api/models/itsme_direct_device.rb +270 -0
- data/lib/trinsic_api/models/itsme_identity_document.rb +193 -0
- data/lib/trinsic_api/models/itsme_login_provider_output.rb +293 -0
- data/lib/trinsic_api/models/itsme_place_of_birth.rb +160 -0
- data/lib/trinsic_api/models/{idemia_preview_provider_address.rb → itsme_provider_address.rb} +30 -56
- data/lib/trinsic_api/models/itsme_provider_output.rb +162 -144
- data/lib/trinsic_api/models/kenya_nid_lookup2_provider_output.rb +6 -102
- data/lib/trinsic_api/models/kenya_nid_lookup3_input.rb +194 -0
- data/lib/trinsic_api/models/kenya_nid_lookup3_provider_output.rb +227 -0
- data/lib/trinsic_api/models/kenya_nid_match2_date_of_birth_field.rb +2 -34
- data/lib/trinsic_api/models/kenya_nid_match2_full_name_field.rb +2 -34
- data/lib/trinsic_api/models/kenya_nid_match2_national_id_number_field.rb +2 -34
- data/lib/trinsic_api/models/kenya_nid_match2_provider_output.rb +2 -34
- data/lib/trinsic_api/models/kenya_nid_match2_sex_field.rb +2 -34
- data/lib/trinsic_api/models/korea_telco_match_provider_output.rb +6 -54
- data/lib/trinsic_api/models/la_wallet_provider_output.rb +17 -289
- data/lib/trinsic_api/models/latvia_eparaksts_mobile_provider_output.rb +3 -51
- data/lib/trinsic_api/models/latvia_eparaksts_provider_output.rb +3 -51
- data/lib/trinsic_api/models/lithuania_id_card_provider_output.rb +4 -68
- data/lib/trinsic_api/models/mdl_output.rb +7 -71
- data/lib/trinsic_api/models/mdl_output_certificate_data.rb +18 -87
- data/lib/trinsic_api/models/mdl_output_field_data.rb +2 -34
- data/lib/trinsic_api/models/mock_output_provider_input.rb +150 -0
- data/lib/trinsic_api/models/moldova_driver_license_credential.rb +284 -0
- data/lib/trinsic_api/models/moldova_evo_wallet_input.rb +149 -0
- data/lib/trinsic_api/models/moldova_evo_wallet_provider_output.rb +194 -0
- data/lib/trinsic_api/models/moldova_identity_card_credential.rb +381 -0
- data/lib/trinsic_api/models/moldova_vehicle_registration_certificate_credential.rb +438 -0
- data/lib/trinsic_api/models/netherlands_eudi_sandbox_input.rb +149 -0
- data/lib/trinsic_api/models/netherlands_eudi_sandbox_provider_output.rb +161 -0
- data/lib/trinsic_api/models/netherlands_idin_address.rb +68 -93
- data/lib/trinsic_api/models/netherlands_idin_provider_output.rb +9 -137
- data/lib/trinsic_api/models/nigeria_nin_lookup2_provider_output.rb +4 -52
- data/lib/trinsic_api/models/nigeria_nin_lookup3_input.rb +149 -0
- data/lib/trinsic_api/models/nigeria_nin_lookup3_provider_output.rb +326 -0
- data/lib/trinsic_api/models/nigeria_nin_match2_date_of_birth_field.rb +2 -34
- data/lib/trinsic_api/models/nigeria_nin_match2_full_name_field.rb +2 -34
- data/lib/trinsic_api/models/nigeria_nin_match2_national_id_number_field.rb +2 -34
- data/lib/trinsic_api/models/nigeria_nin_match2_phone_number_field.rb +2 -34
- data/lib/trinsic_api/models/nigeria_nin_match2_provider_output.rb +2 -34
- data/lib/trinsic_api/models/nigeria_nin_match2_sex_field.rb +2 -34
- data/lib/trinsic_api/models/panama_cedula_lookup_input.rb +5 -16
- data/lib/trinsic_api/models/panama_cedula_provider_output.rb +6 -97
- data/lib/trinsic_api/models/peru_dni_address.rb +3 -51
- data/lib/trinsic_api/models/peru_dni_provider_output.rb +8 -136
- data/lib/trinsic_api/models/philippines_digital_nid_provider_output.rb +1 -17
- data/lib/trinsic_api/models/philippines_philsys_match_provider_output.rb +2 -34
- data/lib/trinsic_api/models/philippines_physical_nid_provider_output.rb +1 -17
- data/lib/trinsic_api/models/poland_edo_app_provider_output.rb +4 -68
- data/lib/trinsic_api/models/poland_mobywatel_match_input.rb +3 -3
- data/lib/trinsic_api/models/poland_mobywatel_match_provider_output.rb +1 -1
- data/lib/trinsic_api/models/poland_moje_id_provider_output.rb +3 -51
- data/lib/trinsic_api/models/portugal_id_card_provider_output.rb +4 -68
- data/lib/trinsic_api/models/provider.rb +1 -57
- data/lib/trinsic_api/models/provider_input.rb +97 -1
- data/lib/trinsic_api/models/provider_output.rb +156 -24
- data/lib/trinsic_api/models/raw18013_document_request.rb +9 -0
- data/lib/trinsic_api/models/samsung_id_with_clear_credential.rb +295 -0
- data/lib/trinsic_api/models/samsung_wallet_input.rb +1 -1
- data/lib/trinsic_api/models/samsung_wallet_provider_output.rb +13 -18
- data/lib/trinsic_api/models/serbia_id_card_provider_output.rb +4 -68
- data/lib/trinsic_api/models/signzy_india_aadhaar_fetch_provider_output.rb +2 -34
- data/lib/trinsic_api/models/south_africa_nid_lookup2_provider_output.rb +10 -138
- data/lib/trinsic_api/models/south_africa_nid_match2_date_of_birth_field.rb +2 -34
- data/lib/trinsic_api/models/south_africa_nid_match2_full_name_field.rb +2 -34
- data/lib/trinsic_api/models/south_africa_nid_match2_national_id_number_field.rb +2 -34
- data/lib/trinsic_api/models/south_africa_nid_match2_provider_output.rb +2 -34
- data/lib/trinsic_api/models/south_africa_nid_match2_sex_field.rb +2 -34
- data/lib/trinsic_api/models/spid_billing_information.rb +3 -51
- data/lib/trinsic_api/models/spid_provider_output.rb +2 -34
- data/lib/trinsic_api/models/sub_provider_metadata.rb +16 -5
- data/lib/trinsic_api/models/uganda_nid_match2_date_of_birth_field.rb +2 -34
- data/lib/trinsic_api/models/uganda_nid_match2_national_id_number_field.rb +2 -34
- data/lib/trinsic_api/models/uganda_nid_match2_provider_output.rb +3 -51
- data/lib/trinsic_api/models/uganda_nid_match2_secondary_id_number_field.rb +2 -34
- data/lib/trinsic_api/models/zimbabwe_nid_lookup2_provider_output.rb +6 -102
- data/lib/trinsic_api/version.rb +1 -1
- data/lib/trinsic_api.rb +55 -6
- data/spec/models/alaska_mobile_id_provider_output_spec.rb +42 -0
- data/spec/models/attachment_info_spec.rb +6 -0
- data/spec/models/austria_valera_eudi_sandbox_input_spec.rb +36 -0
- data/spec/models/austria_valera_eudi_sandbox_provider_output_spec.rb +48 -0
- data/spec/models/brazil_biometric_verification_output_spec.rb +54 -0
- data/spec/models/brazil_cpf_check_input_spec.rb +6 -0
- data/spec/models/brazil_cpf_provider_output_spec.rb +96 -0
- data/spec/models/{verimi_address_output_spec.rb → clear_provider_output_address_spec.rb} +12 -12
- data/spec/models/clear_provider_output_check_additional_details_spec.rb +36 -0
- data/spec/models/clear_provider_output_check_spec.rb +66 -0
- data/spec/models/clear_provider_output_document_spec.rb +108 -0
- data/spec/models/clear_provider_output_health_insurance_spec.rb +78 -0
- data/spec/models/clear_provider_output_historical_address_spec.rb +90 -0
- data/spec/models/clear_provider_output_historical_data_spec.rb +42 -0
- data/spec/models/clear_provider_output_historical_name_spec.rb +66 -0
- data/spec/models/clear_provider_output_location_info_spec.rb +72 -0
- data/spec/models/clear_provider_output_partial_date_spec.rb +48 -0
- data/spec/models/clear_provider_output_session_info_spec.rb +66 -0
- data/spec/models/clear_provider_output_spec.rb +150 -0
- data/spec/models/clear_provider_output_traits_spec.rb +132 -0
- data/spec/models/clear_provider_output_verified_email_spec.rb +48 -0
- data/spec/models/clear_provider_output_watchlist_hit_details_spec.rb +126 -0
- data/spec/models/clear_provider_output_watchlist_hit_spec.rb +54 -0
- data/spec/models/clear_provider_output_watchlist_hits_spec.rb +42 -0
- data/spec/models/clear_provider_output_watchlist_source_spec.rb +48 -0
- data/spec/models/denmark_alt_id_input_spec.rb +36 -0
- data/spec/models/denmark_alt_id_provider_output_spec.rb +48 -0
- data/spec/models/eudi_age_verification_credential_spec.rb +0 -12
- data/spec/models/eudi_reference_wallet_provider_output_spec.rb +42 -0
- data/spec/models/evrotrust_address_components_spec.rb +126 -0
- data/spec/models/evrotrust_input_spec.rb +42 -0
- data/spec/models/{idemia_preview_provider_output_spec.rb → evrotrust_provider_output_spec.rb} +41 -35
- data/spec/models/french_numerique_provider_output_spec.rb +18 -0
- data/spec/models/{french_numerique_given_name_spec.rb → french_numerique_splitted_given_name_spec.rb} +6 -12
- data/spec/models/{french_numerique_phone_spec.rb → french_numerique_splitted_phone_spec.rb} +6 -12
- data/spec/models/germany_eudi_sandbox_input_spec.rb +36 -0
- data/spec/models/germany_eudi_sandbox_provider_output_spec.rb +42 -0
- data/spec/models/guatemala_cui_lookup_input_spec.rb +6 -0
- data/spec/models/{verimi_provider_output_spec.rb → idemia_mobile_id_provider_output_spec.rb} +29 -41
- data/spec/models/itsme_address_base_spec.rb +48 -0
- data/spec/models/itsme_belgian_identity_card_spec.rb +60 -0
- data/spec/models/itsme_belgian_national_number_spec.rb +48 -0
- data/spec/models/itsme_direct_device_spec.rb +102 -0
- data/spec/models/itsme_identity_document_spec.rb +60 -0
- data/spec/models/itsme_login_provider_output_spec.rb +114 -0
- data/spec/models/itsme_place_of_birth_spec.rb +42 -0
- data/spec/models/itsme_provider_address_spec.rb +60 -0
- data/spec/models/itsme_provider_output_spec.rb +49 -13
- data/spec/models/kenya_nid_lookup3_input_spec.rb +36 -0
- data/spec/models/{idemia_preview_provider_address_spec.rb → kenya_nid_lookup3_provider_output_spec.rb} +14 -14
- data/spec/models/mdl_output_certificate_data_spec.rb +6 -0
- data/spec/models/mock_output_provider_input_spec.rb +36 -0
- data/spec/models/moldova_driver_license_credential_spec.rb +108 -0
- data/spec/models/moldova_evo_wallet_input_spec.rb +36 -0
- data/spec/models/moldova_evo_wallet_provider_output_spec.rb +60 -0
- data/spec/models/moldova_identity_card_credential_spec.rb +162 -0
- data/spec/models/moldova_vehicle_registration_certificate_credential_spec.rb +192 -0
- data/spec/models/netherlands_eudi_sandbox_input_spec.rb +36 -0
- data/spec/models/netherlands_eudi_sandbox_provider_output_spec.rb +42 -0
- data/spec/models/netherlands_idin_address_spec.rb +30 -0
- data/spec/models/nigeria_nin_lookup3_input_spec.rb +36 -0
- data/spec/models/nigeria_nin_lookup3_provider_output_spec.rb +132 -0
- data/spec/models/panama_cedula_lookup_input_spec.rb +0 -6
- data/spec/models/panama_cedula_provider_output_spec.rb +0 -6
- data/spec/models/provider_input_spec.rb +54 -0
- data/spec/models/provider_output_spec.rb +78 -6
- data/spec/models/provider_spec.rb +0 -12
- data/spec/models/samsung_id_with_clear_credential_spec.rb +114 -0
- data/spec/models/samsung_wallet_provider_output_spec.rb +6 -0
- data/spec/models/sub_provider_metadata_spec.rb +6 -0
- metadata +462 -266
- data/docs/IdemiaPreviewProviderAddress.md +0 -32
- data/docs/IdemiaPreviewProviderOutput.md +0 -76
- data/docs/VerimiAddressOutput.md +0 -28
- data/docs/VerimiProviderOutput.md +0 -68
- data/lib/trinsic_api/models/idemia_preview_provider_output.rb +0 -469
- data/lib/trinsic_api/models/verimi_provider_output.rb +0 -425
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **not_before** | **Date** | Date the biometric data block becomes valid. |
|
|
8
|
-
| **not_after** | **Date** | Date the biometric data block expires. |
|
|
7
|
+
| **not_before** | **Date** | Date the biometric data block becomes valid. | [optional] |
|
|
8
|
+
| **not_after** | **Date** | Date the biometric data block expires. | [optional] |
|
|
9
9
|
|
|
10
10
|
## Example
|
|
11
11
|
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **code** | **String** | Vehicle class code. |
|
|
8
|
-
| **description** | **String** | Human-readable description of the vehicle class. |
|
|
7
|
+
| **code** | **String** | Vehicle class code. | [optional] |
|
|
8
|
+
| **description** | **String** | Human-readable description of the vehicle class. | [optional] |
|
|
9
9
|
| **issue_date** | **Date** | Date when this vehicle class privilege was issued. | [optional] |
|
|
10
10
|
| **expiry_date** | **Date** | Date when this vehicle class privilege expires. | [optional] |
|
|
11
11
|
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **code** | **String** | Endorsement code, when present. | [optional] |
|
|
8
|
-
| **description** | **String** | Human-readable description of the endorsement. |
|
|
8
|
+
| **description** | **String** | Human-readable description of the endorsement. | [optional] |
|
|
9
9
|
|
|
10
10
|
## Example
|
|
11
11
|
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **code** | **String** | Restriction code, when present. | [optional] |
|
|
8
|
-
| **description** | **String** | Human-readable description of the restriction. |
|
|
8
|
+
| **description** | **String** | Human-readable description of the restriction. | [optional] |
|
|
9
9
|
|
|
10
10
|
## Example
|
|
11
11
|
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **min_kilograms** | **Integer** | Minimum weight in the range, in kilograms. |
|
|
7
|
+
| **min_kilograms** | **Integer** | Minimum weight in the range, in kilograms. | [optional] |
|
|
8
8
|
| **max_kilograms** | **Integer** | Maximum weight in the range, in kilograms. If null, the maximum weight has no limit. | [optional] |
|
|
9
9
|
|
|
10
10
|
## Example
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **vehicle_category_code** | **String** | Vehicle category code that the holder is authorized to operate. |
|
|
7
|
+
| **vehicle_category_code** | **String** | Vehicle category code that the holder is authorized to operate. | [optional] |
|
|
8
8
|
| **issue_date** | **Date** | Date when this driving privilege was issued. | [optional] |
|
|
9
9
|
| **expiry_date** | **Date** | Date when this driving privilege expires. | [optional] |
|
|
10
10
|
| **codes** | [**Array<Iso180135DrivingPrivilegeCode>**](Iso180135DrivingPrivilegeCode.md) | Restriction, condition, or special privilege codes attached to this entry. | [optional] |
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **code** | **String** | The code identifier. |
|
|
7
|
+
| **code** | **String** | The code identifier. | [optional] |
|
|
8
8
|
| **sign** | **String** | Optional comparison sign applied to the code's value. | [optional] |
|
|
9
9
|
| **value** | **String** | Optional value applied to the code. | [optional] |
|
|
10
10
|
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# TrinsicApi::ItsmeAddressBase
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **street_address** | **String** | The street address. itsme documents this as an address member when the address claim is returned. | [optional] |
|
|
8
|
+
| **postal_code** | **String** | The postal code of the address. itsme documents this as an address member when the address claim is returned. | [optional] |
|
|
9
|
+
| **country** | **String** | The country of the address as an ISO 3166-1 alpha-2 code, when returned. This field is not part of itsme's documented address claim members; it is present only when itsme returns `address.country`. | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'trinsic_api'
|
|
15
|
+
|
|
16
|
+
instance = TrinsicApi::ItsmeAddressBase.new(
|
|
17
|
+
street_address: Jekerstraat 39,
|
|
18
|
+
postal_code: 3700,
|
|
19
|
+
country: BE
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# TrinsicApi::ItsmeBelgianIdentityCard
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **number** | **String** | The Belgian eID card number. This identifies the card document, not the person's Belgian National Register Number. Availability by ID document issuing country: returned only for Belgian-issued ID documents. Belgian citizen examples are 12 digits in the form `xxx-xxxxxxx-yy`; EU, EEA, and Swiss resident card examples can start with a letter followed by digits. | [optional] |
|
|
8
|
+
| **issuing_country** | **String** | The issuing country as an ISO 3166-1 alpha-2 country code. Availability by ID document issuing country: always returned for all supported issuing countries. | [optional] |
|
|
9
|
+
| **validity_from** | **Time** | The identity card validity start date time. Availability by ID document issuing country: best effort for Belgian-issued ID documents; not returned for other supported issuing countries. | [optional] |
|
|
10
|
+
| **validity_to** | **Time** | The identity card validity end date time. Availability by ID document issuing country: always returned for supported issuing countries except Belgium, where it is best effort. | [optional] |
|
|
11
|
+
| **issuance_locality** | **String** | The locality that issued the identity card. Availability by ID document issuing country: best effort for Belgian-issued ID documents; not returned for other supported issuing countries. | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'trinsic_api'
|
|
17
|
+
|
|
18
|
+
instance = TrinsicApi::ItsmeBelgianIdentityCard.new(
|
|
19
|
+
number: 431522485012,
|
|
20
|
+
issuing_country: BE,
|
|
21
|
+
validity_from: 2018-11-08T00:00Z,
|
|
22
|
+
validity_to: 2028-11-10T00:00Z,
|
|
23
|
+
issuance_locality: BRUXELLES
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# TrinsicApi::ItsmeBelgianNationalNumber
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **number** | **String** | The raw Belgian National Register Number of the verified individual. Availability by ID document issuing country: returned only for Belgian-issued ID documents. This is an 11-digit number in the format YYMMDDXXXCC: - YYMMDD is the date of birth. - XXX is a sequential birth number, odd for males and even for females. - CC is the checksum. | [optional] |
|
|
8
|
+
| **issuing_country** | **String** | The issuing country as an ISO 3166-1 alpha-2 country code. Availability by ID document issuing country: always returned for all supported issuing countries. | [optional] |
|
|
9
|
+
| **verification_date** | **Time** | The date time when the document was last read. Availability by ID document issuing country: always returned for supported issuing countries except Belgium, where it is best effort. | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'trinsic_api'
|
|
15
|
+
|
|
16
|
+
instance = TrinsicApi::ItsmeBelgianNationalNumber.new(
|
|
17
|
+
number: 99060427181,
|
|
18
|
+
issuing_country: BE,
|
|
19
|
+
verification_date: 2023-04-12T15:02:23Z
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# TrinsicApi::ItsmeDirectDevice
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **operating_system** | **String** | The operating system reported for the itsme device. Availability by ID document issuing country: best effort for all supported issuing countries. | [optional] |
|
|
8
|
+
| **operating_system_release** | **String** | The operating system release reported for the itsme device. Availability by ID document issuing country: best effort for all supported issuing countries. | [optional] |
|
|
9
|
+
| **app_name** | **String** | The itsme app name reported for the verification. Availability by ID document issuing country: best effort for all supported issuing countries. | [optional] |
|
|
10
|
+
| **app_release** | **String** | The itsme app release reported for the verification. Availability by ID document issuing country: best effort for all supported issuing countries. | [optional] |
|
|
11
|
+
| **manufacturer** | **String** | The device manufacturer reported for the itsme device. Availability by ID document issuing country: best effort for all supported issuing countries. | [optional] |
|
|
12
|
+
| **device_model** | **String** | The device model reported for the itsme device. Availability by ID document issuing country: best effort for all supported issuing countries. | [optional] |
|
|
13
|
+
| **device_label** | **String** | The device label. Availability by ID document issuing country: best effort for all supported issuing countries. | [optional] |
|
|
14
|
+
| **device_id** | **String** | The device identifier. Availability by ID document issuing country: best effort for all supported issuing countries. | [optional] |
|
|
15
|
+
| **debug_enabled** | **Boolean** | Whether the itsme device had debugging enabled. Availability by ID document issuing country: best effort for all supported issuing countries. | [optional] |
|
|
16
|
+
| **rooted** | **Boolean** | Whether the itsme device was reported as rooted. Availability by ID document issuing country: best effort for all supported issuing countries. | [optional] |
|
|
17
|
+
| **device_lock_level** | **String** | The device lock level value. Availability by ID document issuing country: best effort for all supported issuing countries. | [optional] |
|
|
18
|
+
| **msisdn** | **String** | The Mobile Station International Subscriber Directory Number (MSISDN) value for the device. Availability by ID document issuing country: best effort for all supported issuing countries. | [optional] |
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
```ruby
|
|
23
|
+
require 'trinsic_api'
|
|
24
|
+
|
|
25
|
+
instance = TrinsicApi::ItsmeDirectDevice.new(
|
|
26
|
+
operating_system: ANDROID,
|
|
27
|
+
operating_system_release: 9,
|
|
28
|
+
app_name: be.bmid.itsme.uat,
|
|
29
|
+
app_release: 4.0.0,
|
|
30
|
+
manufacturer: LGE,
|
|
31
|
+
device_model: LG-H870,
|
|
32
|
+
device_label: lucye,
|
|
33
|
+
device_id: c22de2331dd249bba063afd3507fe3a4f,
|
|
34
|
+
debug_enabled: false,
|
|
35
|
+
rooted: false,
|
|
36
|
+
device_lock_level: true,
|
|
37
|
+
msisdn: 0032485694175
|
|
38
|
+
)
|
|
39
|
+
```
|
|
40
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# TrinsicApi::ItsmeIdentityDocument
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **serial_number** | **String** | The identity document serial number. Availability by ID document issuing country: always returned for all supported issuing countries. | [optional] |
|
|
8
|
+
| **type_code** | **String** | The identity document type code. Availability by ID document issuing country: always returned for all supported issuing countries. itsme documents this as a 1 or 2 character ICAO code. - Identity cards start with `I` - passports start with `P` | [optional] |
|
|
9
|
+
| **issuing_country** | **String** | The issuing country as an ISO 3166-1 alpha-2 country code. Availability by ID document issuing country: always returned for all supported issuing countries. | [optional] |
|
|
10
|
+
| **validity_from** | **Time** | The identity document validity start date time. Availability by ID document issuing country: best effort for Belgian-issued ID documents; not returned for other supported issuing countries. | [optional] |
|
|
11
|
+
| **validity_to** | **Time** | The identity document validity end date time. Availability by ID document issuing country: always returned for supported issuing countries except Belgium, where it is best effort. | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'trinsic_api'
|
|
17
|
+
|
|
18
|
+
instance = TrinsicApi::ItsmeIdentityDocument.new(
|
|
19
|
+
serial_number: 431522485012,
|
|
20
|
+
type_code: I,
|
|
21
|
+
issuing_country: BE,
|
|
22
|
+
validity_from: 2018-11-08T00:00Z,
|
|
23
|
+
validity_to: 2028-11-10T00:00Z
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# TrinsicApi::ItsmeLoginProviderOutput
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **first_name** | **String** | The first name of the verified individual | [optional] |
|
|
8
|
+
| **last_name** | **String** | The last name of the verified individual | [optional] |
|
|
9
|
+
| **date_of_birth** | **Date** | The date of birth of the verified individual | [optional] |
|
|
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
|
+
| **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] |
|
|
21
|
+
|
|
22
|
+
## Example
|
|
23
|
+
|
|
24
|
+
```ruby
|
|
25
|
+
require 'trinsic_api'
|
|
26
|
+
|
|
27
|
+
instance = TrinsicApi::ItsmeLoginProviderOutput.new(
|
|
28
|
+
first_name: John,
|
|
29
|
+
last_name: Doe,
|
|
30
|
+
date_of_birth: Tue Dec 10 00:00:00 UTC 1985,
|
|
31
|
+
hashed_national_register_number: 5d17e158243dff0bd79fbfd06b27b80d04a40a6a0425e1bbb474c7634a2918f7,
|
|
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
|
|
42
|
+
)
|
|
43
|
+
```
|
|
44
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# TrinsicApi::ItsmePlaceOfBirth
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **city** | **String** | The city component of the place of birth. Availability by ID document issuing country: best effort for Belgian-issued ID documents; not returned for other supported issuing countries. | [optional] |
|
|
8
|
+
| **formatted** | **String** | The formatted place of birth. Availability by ID document issuing country: best effort for Belgian-issued ID documents; not returned for other supported issuing countries. | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'trinsic_api'
|
|
14
|
+
|
|
15
|
+
instance = TrinsicApi::ItsmePlaceOfBirth.new(
|
|
16
|
+
city: Brussels,
|
|
17
|
+
formatted: Brussels
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# TrinsicApi::ItsmeProviderAddress
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **street_address** | **String** | The street address. itsme documents this as an address member when the address claim is returned. | [optional] |
|
|
8
|
+
| **postal_code** | **String** | The postal code of the address. itsme documents this as an address member when the address claim is returned. | [optional] |
|
|
9
|
+
| **country** | **String** | The country of the address as an ISO 3166-1 alpha-2 code, when returned. This field is not part of itsme's documented address claim members; it is present only when itsme returns `address.country`. | [optional] |
|
|
10
|
+
| **locality** | **String** | The locality or city of the address. itsme documents this as an address member when the address claim is returned. | [optional] |
|
|
11
|
+
| **formatted** | **String** | The full address formatted by itsme. itsme documents this as an address member when the address claim is returned. | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'trinsic_api'
|
|
17
|
+
|
|
18
|
+
instance = TrinsicApi::ItsmeProviderAddress.new(
|
|
19
|
+
street_address: Jekerstraat 39,
|
|
20
|
+
postal_code: 3700,
|
|
21
|
+
country: BE,
|
|
22
|
+
locality: TONGEREN,
|
|
23
|
+
formatted: Jekerstraat 39 3700 TONGEREN
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
data/docs/ItsmeProviderOutput.md
CHANGED
|
@@ -4,20 +4,26 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **
|
|
8
|
-
| **
|
|
9
|
-
| **
|
|
10
|
-
| **
|
|
11
|
-
| **
|
|
12
|
-
| **
|
|
13
|
-
| **
|
|
14
|
-
| **
|
|
15
|
-
| **
|
|
16
|
-
| **
|
|
17
|
-
| **
|
|
18
|
-
| **
|
|
19
|
-
| **
|
|
20
|
-
| **address** | [**
|
|
7
|
+
| **date_of_birth** | **Date** | The date of birth of the verified individual. Availability by ID document issuing country: always returned for supported issuing countries except Belgium, where it is best effort. | [optional] |
|
|
8
|
+
| **email** | **String** | The email address of the verified individual. Availability by ID document issuing country: best effort for all supported issuing countries. | [optional] |
|
|
9
|
+
| **phone_number** | **String** | The phone number of the verified individual, with a leading + country calling code. Availability by ID document issuing country: always returned for all supported issuing countries. | [optional] |
|
|
10
|
+
| **sub** | **String** | The stable OpenID Connect (OIDC) subject (sub) identifier. This should be a stable identifier, however, if a user deletes and recreates an account, this identifier will change. | [optional] |
|
|
11
|
+
| **full_name** | **String** | The full name of the verified individual. Availability by ID document issuing country: always returned for all supported issuing countries. | [optional] |
|
|
12
|
+
| **given_name** | **String** | The given name of the verified individual. Availability by ID document issuing country: best effort for all supported issuing countries. | [optional] |
|
|
13
|
+
| **family_name** | **String** | The family name of the verified individual. Availability by ID document issuing country: always returned for all supported issuing countries. | [optional] |
|
|
14
|
+
| **date_of_birth_as_string** | **String** | The date of birth of the verified individual in itsme's document-facing string format. Availability by ID document issuing country: best effort for Belgian-issued ID documents; not returned for other supported issuing countries. | [optional] |
|
|
15
|
+
| **gender** | **String** | The gender claim for the verified individual. Availability by ID document issuing country: always returned for supported issuing countries except Netherlands, where it is best effort. Known values: - Female - Male - Unknown | [optional] |
|
|
16
|
+
| **locale** | **String** | The itsme app language as an uppercase language code. Availability by ID document issuing country: best effort for all supported issuing countries. Known values: - NL - FR - DE - EN | [optional] |
|
|
17
|
+
| **picture_url** | **String** | The URL of the profile picture resource. Availability by ID document issuing country: always returned for supported issuing countries except Belgium, where it is best effort. | [optional] |
|
|
18
|
+
| **email_verified** | **Boolean** | Whether itsme reports the email address as verified. Availability by ID document issuing country: returned only if `email` is available. Note: itsme currently documents that this value is usually false because email verification is not implemented in its systems. | [optional] |
|
|
19
|
+
| **phone_number_verified** | **Boolean** | Whether itsme reports the phone number as verified. Availability by ID document issuing country: always returned for all supported issuing countries. | [optional] |
|
|
20
|
+
| **address** | [**ItsmeProviderAddress**](ItsmeProviderAddress.md) | The address of the verified individual. Availability by ID document issuing country: always returned for Belgian-issued ID documents, best effort for Netherlands-issued ID documents, and not returned for other supported issuing countries. | [optional] |
|
|
21
|
+
| **citizenship** | **String** | The citizenship of the verified individual as an ISO 3166-1 alpha-2 country code. Availability by ID document issuing country: always returned for supported issuing countries except Belgium, where it is best effort. | [optional] |
|
|
22
|
+
| **belgian_national_number** | [**ItsmeBelgianNationalNumber**](ItsmeBelgianNationalNumber.md) | The Belgian National Register Number and related metadata. Availability by ID document issuing country: returned only for Belgian-issued ID documents. | [optional] |
|
|
23
|
+
| **belgian_identity_card** | [**ItsmeBelgianIdentityCard**](ItsmeBelgianIdentityCard.md) | The Belgian eID card document number and related metadata. Availability by ID document issuing country: returned only for Belgian-issued ID documents. | [optional] |
|
|
24
|
+
| **identity_document** | [**ItsmeIdentityDocument**](ItsmeIdentityDocument.md) | The identity document and related metadata. Availability by ID document issuing country: always returned for all supported issuing countries. | [optional] |
|
|
25
|
+
| **place_of_birth** | [**ItsmePlaceOfBirth**](ItsmePlaceOfBirth.md) | The place of birth. Availability by ID document issuing country: best effort for Belgian-issued ID documents; not returned for other supported issuing countries. | [optional] |
|
|
26
|
+
| **device** | [**ItsmeDirectDevice**](ItsmeDirectDevice.md) | The device metadata for the verification. Availability by ID document issuing country: best effort for all supported issuing countries. | [optional] |
|
|
21
27
|
|
|
22
28
|
## Example
|
|
23
29
|
|
|
@@ -25,20 +31,26 @@
|
|
|
25
31
|
require 'trinsic_api'
|
|
26
32
|
|
|
27
33
|
instance = TrinsicApi::ItsmeProviderOutput.new(
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
address: null
|
|
34
|
+
date_of_birth: Wed Nov 01 00:00:00 UTC 1978,
|
|
35
|
+
email: george.tanka@example.be,
|
|
36
|
+
phone_number: +32 485694175,
|
|
37
|
+
sub: e3xad7upx64grm14ttpnx4c586ve8gy0gp38,
|
|
38
|
+
full_name: George Tanka,
|
|
39
|
+
given_name: George,
|
|
40
|
+
family_name: Tanka,
|
|
41
|
+
date_of_birth_as_string: 01.11.1978,
|
|
42
|
+
gender: male,
|
|
43
|
+
locale: FR,
|
|
44
|
+
picture_url: https://idp.prd.itsme.services/v2/picture,
|
|
45
|
+
email_verified: false,
|
|
46
|
+
phone_number_verified: true,
|
|
47
|
+
address: null,
|
|
48
|
+
citizenship: BE,
|
|
49
|
+
belgian_national_number: null,
|
|
50
|
+
belgian_identity_card: null,
|
|
51
|
+
identity_document: null,
|
|
52
|
+
place_of_birth: null,
|
|
53
|
+
device: null
|
|
42
54
|
)
|
|
43
55
|
```
|
|
44
56
|
|
|
@@ -4,14 +4,14 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **first_name** | **String** | The first name (given name) of the ID holder as recorded in IPRS. |
|
|
8
|
-
| **surname** | **String** | The surname (family name) of the ID holder as recorded in IPRS. |
|
|
7
|
+
| **first_name** | **String** | The first name (given name) of the ID holder as recorded in IPRS. | [optional] |
|
|
8
|
+
| **surname** | **String** | The surname (family name) of the ID holder as recorded in IPRS. | [optional] |
|
|
9
9
|
| **other_name** | **String** | The other name (middle name) of the ID holder as recorded in IPRS. | [optional] |
|
|
10
|
-
| **sex** | **String** | The sex of the ID holder as recorded on the National ID. Possible values: - Male - Female |
|
|
10
|
+
| **sex** | **String** | The sex of the ID holder as recorded on the National ID. Possible values: - Male - Female | [optional] |
|
|
11
11
|
| **date_of_birth** | **Date** | The date of birth of the ID holder as recorded in IPRS. | [optional] |
|
|
12
|
-
| **citizenship** | **String** | Citizenship status as recorded in the IPRS civil registry database. For the Kenya National ID lookup, this value will always be \"Kenyan\" as the National ID is only issued to Kenyan citizens. Non-citizens residing in Kenya are issued different identification documents (Alien ID cards, refugee documentation, etc.) which are not supported by this provider. |
|
|
13
|
-
| **id_number** | **String** | The Kenya National ID Number (Nambari ya Kitambulisho) 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 either 8 digits for National ID or 9 digits for Maisha Namba UPI (the new format since 2023). |
|
|
14
|
-
| **serial_number** | **String** | The physical card serial number printed on the Kenya National ID card. This is distinct from the ID Number and serves as a card issuance tracking identifier maintained by IPRS. This value changes each time a new physical card is issued (loss, damage, renewal). |
|
|
12
|
+
| **citizenship** | **String** | Citizenship status as recorded in the IPRS civil registry database. For the Kenya National ID lookup, this value will always be \"Kenyan\" as the National ID is only issued to Kenyan citizens. Non-citizens residing in Kenya are issued different identification documents (Alien ID cards, refugee documentation, etc.) which are not supported by this provider. | [optional] |
|
|
13
|
+
| **id_number** | **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 either 8 digits for National ID or 9 digits for Maisha Namba UPI (the new format since 2023). | [optional] |
|
|
14
|
+
| **serial_number** | **String** | The physical card serial number printed on the Kenya National ID card. This is distinct from the ID Number and serves as a card issuance tracking identifier maintained by IPRS. This value changes each time a new physical card is issued (loss, damage, renewal). | [optional] |
|
|
15
15
|
| **date_of_issue** | **Date** | The date the National ID was issued by the National Registration Bureau (NRB). | [optional] |
|
|
16
16
|
| **place_of_birth** | [**KenyaNidLookup2Address**](KenyaNidLookup2Address.md) | Place of birth as recorded in Kenya's civil registry (IPRS). This is structured according to Kenya's pre-2010 administrative hierarchy (District > Division > Location). | [optional] |
|
|
17
17
|
| **place_of_residence** | [**KenyaNidLookup2Address**](KenyaNidLookup2Address.md) | Current residence address as registered in IPRS. This represents the address on file at the time of ID registration or last update, structured according to Kenya's pre-2010 administrative hierarchy (District > Division > Location). | [optional] |
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# TrinsicApi::KenyaNidLookup3Input
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id_number** | **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 either 8 digits for National ID or 9 digits for Maisha Namba UPI (the new format since 2023). | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'trinsic_api'
|
|
13
|
+
|
|
14
|
+
instance = TrinsicApi::KenyaNidLookup3Input.new(
|
|
15
|
+
id_number: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# TrinsicApi::KenyaNidLookup3ProviderOutput
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id_number** | **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 either 8 digits for National ID or 9 digits for Maisha Namba UPI (the new format since 2023). | [optional] |
|
|
8
|
+
| **first_name** | **String** | The first name of the individual. | [optional] |
|
|
9
|
+
| **surname** | **String** | The surname of the individual. | [optional] |
|
|
10
|
+
| **other_name** | **String** | Other name (middle name) of the individual. | [optional] |
|
|
11
|
+
| **sex** | **String** | The sex of the individual. Possible values: - Male - Female | [optional] |
|
|
12
|
+
| **date_of_birth** | **Date** | The date of birth of the individual. Format - YYYY-MM-DD | [optional] |
|
|
13
|
+
| **citizenship** | **String** | Citizenship of the individual. Format - ISO 3166-1 alpha-2 country code | [optional] |
|
|
14
|
+
| **serial_number** | **String** | The physical card serial number printed on the Kenya National ID card. This is distinct from the ID Number and serves as a card issuance tracking identifier maintained by IPRS. This value changes each time a new physical card is issued (loss, damage, renewal). | [optional] |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'trinsic_api'
|
|
20
|
+
|
|
21
|
+
instance = TrinsicApi::KenyaNidLookup3ProviderOutput.new(
|
|
22
|
+
id_number: 10101010,
|
|
23
|
+
first_name: JUMA,
|
|
24
|
+
surname: ODHIAMBO,
|
|
25
|
+
other_name: OTIENO,
|
|
26
|
+
sex: Male,
|
|
27
|
+
date_of_birth: Tue Jan 01 00:00:00 UTC 1985,
|
|
28
|
+
citizenship: KE,
|
|
29
|
+
serial_number: 98765432
|
|
30
|
+
)
|
|
31
|
+
```
|
|
32
|
+
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
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 |
|
|
7
|
+
| **input_value** | **Date** | The date of birth submitted for this check. | [optional] |
|
|
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 | [optional] |
|
|
9
9
|
|
|
10
10
|
## Example
|
|
11
11
|
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
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 |
|
|
7
|
+
| **input_value** | **String** | The full name string submitted for this check (as provided in the match input). | [optional] |
|
|
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 | [optional] |
|
|
9
9
|
|
|
10
10
|
## Example
|
|
11
11
|
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
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 |
|
|
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 | [optional] |
|
|
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 | [optional] |
|
|
9
9
|
|
|
10
10
|
## Example
|
|
11
11
|
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
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. |
|
|
7
|
+
| **national_id_number** | [**KenyaNidMatch2NationalIdNumberField**](KenyaNidMatch2NationalIdNumberField.md) | Outcome of the verification of the national ID number. | [optional] |
|
|
8
|
+
| **full_name** | [**KenyaNidMatch2FullNameField**](KenyaNidMatch2FullNameField.md) | Outcome of the verification of the full name. | [optional] |
|
|
9
9
|
| **date_of_birth** | [**KenyaNidMatch2DateOfBirthField**](KenyaNidMatch2DateOfBirthField.md) | Outcome of the verification of the date of birth. | [optional] |
|
|
10
10
|
| **sex** | [**KenyaNidMatch2SexField**](KenyaNidMatch2SexField.md) | Outcome of the verification of the sex. | [optional] |
|
|
11
11
|
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
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 |
|
|
7
|
+
| **input_value** | **String** | The sex value submitted for this check. Possible input values: - Male - Female | [optional] |
|
|
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 | [optional] |
|
|
9
9
|
|
|
10
10
|
## Example
|
|
11
11
|
|
|
@@ -4,9 +4,9 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **phone_number** | **String** | The
|
|
8
|
-
| **tele_type** | **String** | The mobile carrier used for
|
|
9
|
-
| **result_code** | **String** | The
|
|
7
|
+
| **phone_number** | **String** | The phone number submitted for the carrier match. | [optional] |
|
|
8
|
+
| **tele_type** | **String** | The mobile carrier used for the match. Supported values: Lgu, Skt, Kt. | [optional] |
|
|
9
|
+
| **result_code** | **String** | The carrier match result code. Common result codes: - \"0000\": Successful match - \"0001\": Failed - Verification Information Mismatch (General) - \"0002\": Failed - Unable to Verify Phone Number - \"0004\": Failed - Date of Birth Verification Error - \"0005\": Failed - Gender Verification Error - \"0006\": Failed - Name Verification Error - \"0009\": Failed - Device OS Mismatch | [optional] |
|
|
10
10
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
@@ -4,24 +4,24 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **drivers_license_number** | **String** | The number of the driver's license used to create the LA Wallet credential |
|
|
8
|
-
| **issue_date** | **Date** | The issue date of the driver's license used to create the LA Wallet credential |
|
|
9
|
-
| **expiration_date** | **Date** | The expiration date of the driver's license used to create the LA Wallet credential |
|
|
10
|
-
| **audit_number** | **String** | The 4-digit audit number of the driver's license used to create the LA Wallet credential |
|
|
11
|
-
| **license_status** | **String** | The license status from the LA Wallet credential |
|
|
12
|
-
| **license_class** | **String** | The license class from the LA Wallet credential Possible values: - \"A\": Commercial Driver's License, Combination Vehicles - \"B\": Commercial Driver's License, Heavy Straight Vehicle - \"C\": Commercial Driver's License, Light Straight Vehicle - \"D\": Chauffeur's Driver's License - \"E\": Driver's License for Personal Vehicle |
|
|
13
|
-
| **first_name** | **String** | The first name from the LA Wallet credential |
|
|
14
|
-
| **middle_name** | **String** | The middle name from the LA Wallet credential |
|
|
15
|
-
| **last_name** | **String** | The last name from the LA Wallet credential |
|
|
16
|
-
| **date_of_birth** | **Date** | The date of birth from the LA Wallet credential |
|
|
17
|
-
| **sex** | **String** | The sex from the LA Wallet credential |
|
|
18
|
-
| **address_line1** | **String** | The address' line 1 from the LA Wallet credential |
|
|
7
|
+
| **drivers_license_number** | **String** | The number of the driver's license used to create the LA Wallet credential | [optional] |
|
|
8
|
+
| **issue_date** | **Date** | The issue date of the driver's license used to create the LA Wallet credential | [optional] |
|
|
9
|
+
| **expiration_date** | **Date** | The expiration date of the driver's license used to create the LA Wallet credential | [optional] |
|
|
10
|
+
| **audit_number** | **String** | The 4-digit audit number of the driver's license used to create the LA Wallet credential | [optional] |
|
|
11
|
+
| **license_status** | **String** | The license status from the LA Wallet credential | [optional] |
|
|
12
|
+
| **license_class** | **String** | The license class from the LA Wallet credential Possible values: - \"A\": Commercial Driver's License, Combination Vehicles - \"B\": Commercial Driver's License, Heavy Straight Vehicle - \"C\": Commercial Driver's License, Light Straight Vehicle - \"D\": Chauffeur's Driver's License - \"E\": Driver's License for Personal Vehicle | [optional] |
|
|
13
|
+
| **first_name** | **String** | The first name from the LA Wallet credential | [optional] |
|
|
14
|
+
| **middle_name** | **String** | The middle name from the LA Wallet credential | [optional] |
|
|
15
|
+
| **last_name** | **String** | The last name from the LA Wallet credential | [optional] |
|
|
16
|
+
| **date_of_birth** | **Date** | The date of birth from the LA Wallet credential | [optional] |
|
|
17
|
+
| **sex** | **String** | The sex from the LA Wallet credential | [optional] |
|
|
18
|
+
| **address_line1** | **String** | The address' line 1 from the LA Wallet credential | [optional] |
|
|
19
19
|
| **address_line2** | **String** | The address' line 2 from the LA Wallet credential | [optional] |
|
|
20
|
-
| **address_city** | **String** | The address' city from the LA Wallet credential |
|
|
21
|
-
| **address_state** | **String** | The address' state from the LA Wallet credential |
|
|
22
|
-
| **address_zip** | **String** | The address' ZIP from the LA Wallet credential |
|
|
23
|
-
| **county** | **String** | The county (\"parish\") code from the LA Wallet credential. This is a number from 1 to 64, representing one of Louisiana's 64 parishes. |
|
|
24
|
-
| **coarse_age** | **String** | The coarse age returned by LA Wallet for this credential Possible values: - \"Under 18\" - \"Under 21\" - \"Over 21\" |
|
|
20
|
+
| **address_city** | **String** | The address' city from the LA Wallet credential | [optional] |
|
|
21
|
+
| **address_state** | **String** | The address' state from the LA Wallet credential | [optional] |
|
|
22
|
+
| **address_zip** | **String** | The address' ZIP from the LA Wallet credential | [optional] |
|
|
23
|
+
| **county** | **String** | The county (\"parish\") code from the LA Wallet credential. This is a number from 1 to 64, representing one of Louisiana's 64 parishes. | [optional] |
|
|
24
|
+
| **coarse_age** | **String** | The coarse age returned by LA Wallet for this credential Possible values: - \"Under 18\" - \"Under 21\" - \"Over 21\" | [optional] |
|
|
25
25
|
|
|
26
26
|
## Example
|
|
27
27
|
|