Passports

documentType: PASSPORT

The parameters listed below are applicable to passports from all countries. For individual countries, we offer supplementary parameters, which can be found on the corresponding subpages of this section.

Front
secondaryId	Given names of the user as per MRZ
primaryId	Surname of the user as per MRZ
dateOfBirth	As per the MRZ (YYMMDD)
dateOfBirthFormatted	ISO-8601 format yyyy-MM-dd
dateOfExpiry	As per the MRZ (YYMMDD)
dateOfExpiryFormatted	ISO-8601 format yyyy-MM-dd
documentNumber	As per the MRZ
nationality	As per the MRZ (ISO 3166-1 alpha-3 code) Note: The german passport uses the single letter D
issuer	Document issuer as per the MRZ (ISO 3166-1 alpha-3 code) Note: The german passport uses the single letter D
sex	As per the MRZ
documentCode	As per the MRZ
mrzText	Full MRZ text divided by new line character “\n”
mrzVerified	MRZ checksum verification (true or false)
opt1	Optional field 1 as per MRZ (see https://en.wikipedia.org/wiki/Machine-readable_passport#Passport_booklets)
faceImage	Base64 encoded face image of the user. The format is the same as per the image uploaded, e.g. png or jpg