Passports
All Countries
ldsVersion
LDS (Logical Data Structure) version. Not always available
photo
Base64 encoded picture of the user.
photoMimeType
image/jp2 or image/jpeg
mrz
{} MRZ object
documentCode
Document code as per MRZ standard
dateOfExpiry
Date of expire as per MRZ standard
optionalData2
Optional field 2 as per MRZ standard
gender
Gender as per MRZ standard
nationality
Nationality as per MRZ standard
documentNumber
Document number as per MRZ standard
dateOfBirth
Date of Birth as per MRZ standard
issuingState
Document issuer as per MRZ standard
secondaryIdentifier
First name as per MRZ standard
primaryIdentifier
Surname as per MRZ standard
optionalData1
Optional Data 1 as per MRZ standard
personalDetails
Additional personal details Note: Supported with SDK version 3.x and above. Might be null if not supported by the issuer
nameOfHolder
Type string, null if not available
otherNames
Type array of strings, null or empty if not available
personalNumber
Type string, null if not available
fullDateOfBirth
Type string, null if not available
placeOfBirth
Type array of strings, null or empty if not available
permanentAddress
Type array of strings, null or empty if not available
telephone
Type string, null if not available
profession
Type string, null if not available
title
Type string, null if not available
personalSummary
Type string, null if not available
proofOfCitizenship
Type string, null if not available
otherValidTDNumbers
Type array of strings, null or empty if not available
custodyInformation
Type string, null if not available
documentDetails
Additional document details Note: Supported with SDK version 3.x and above. Might be null if not supported by the issuer
issuingAuthority
Type string, null if not available
dateOfIssue
Type string, null if not available
namesOfOtherPersons
Type array of strings, null or empty if not available
endorsementsAndObservations
Type string, null if not available
taxOrExitRequirements
Type string, null if not available
imageOfFront
Type string, null if not available
imageOfRear
Type string, null if not available
dateAndTimeOfPersonalization
Type string, null if not available
personalizationSystemSerialNumber
Type string, null if not available
countrySigningCertificate
{} Available only if CSCA (Country Signing Certificate Authority) is available for the issuing passport
serialNumber
publicKeyAlgorithm
subject
certificateThumbprint
validFrom
signatureAlgorithm
issuer
validTo
documentSigningCertificate
{}
serialNumber
publicKeyAlgorithm
subject
certificateThumbprint
validFrom
signatureAlgorithm
issuer
validTo
dataGroupHashes
[{}] Array of objects. DG1 and DG2 hashes, stored and computed
computedHash
dataGroupNumber
storedHash
match
If computedHash and storedHash match
validity
{}
dataGroupHashesSucceeded
True if all data group hashes, computed and stored, match
documentSignerSucceeded
True if countrySigningCertificate and documentSigningCertificate are available and validation is successful. If digital signature verification fails the process doesn’t continue and the user is not able to enroll the document.
countrySignerSucceeded
True if countrySigningCertificate and documentSigningCertificate are available and validation is successful. If digital signature verification fails the process doesn’t continue and the user is not able to enroll the document.
sodSignatureSucceeded
True if the signature of the SOD object has been successfully validated against the document signing certificate. If the signature doesn’t pass, the user is not blocked. The reason being is that there are many defective passports out there where the SOD validation doesn’t pass despite being a genuine passport. Therefore, to avoid blocking the user we just set this boolean to inform you that there might be a problem with the passport.
Note: Validation is performed only if the documentSigningCertificate is available
chipAuthenticationPerformed
True if chip authentication was performed. False otherwise. Please note that if chip authentication is supported it must be successful otherwise we reject the reading
Last updated