Generic National IDs

documentType: GENERIC_ID

A generic ID refers to a document featuring a photograph on the front page and a Machine Readable Zone (MRZ) of the TD1 format on the back page.

Front

faceImage

Base64 encoded face image of the user. The format is the same as per the image uploaded, e.g. png or jpg

Back

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

issuer

Document issuer as per the MRZ

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#Official_travel_documents)

In case of emirates id it contains the identity number

opt2

Last updated