UAE_ID (UAE Emirates ID)

Front

fullName

As shown in the front of the document

fullNameArabic

As shown in the front of the document

identityNumber

Emirates id number as shown in the front of the document

identityNumberVerified

Identity number checksum verification (true or false)

nationality

As shown in the front of the document

nationalityArabic

As shown in the front of the document

faceImage

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

issueDate

As shown in the front of the document (Available only in the latest version of the Emirates ID)

issueDateFormatted

ISO-8601 format yyyy-MM-dd (Available only in the latest version of the Emirates ID)

dateOfBirth

As shown in the front of the document (Available only in the latest version of the Emirates ID)

dateOfBirthFormatted

ISO-8601 format yyyy-MM-dd (Available only in the latest version of the Emirates ID)

dateOfExpiry

As shown in the front of the document (Available only in the latest version of the Emirates ID)

dateOfExpiryFormatted

ISO-8601 format yyyy-MM-dd (Available only in the latest version of the Emirates ID)

gender

As shown in the front of the document (Available only in the latest version of the Emirates ID)

genderArabic

As shown in the front of the document (Available only in the latest version of the Emirates ID)

Back

cardNumber

As shown in the front of the document

employer

Employer (Available only in the latest version of the Emirates ID)

employerArabic

Employer in Arabic (Available only in the latest version of the Emirates ID)

occupation

Occupation (Available only in the latest version of the Emirates ID)

occupationArabic

Occupation in Arabic (Available only in the latest version of the Emirates ID)

placeOfIssue

Place of issue (Available only in the latest version of the Emirates ID)

placeOfIssueArabic

Place of issue in Arabic (Available only in the latest version of the Emirates ID)

sponsorName

Sponsor name (Available only in the latest version of the Emirates ID)

sponsorNameArabic

Sponsor name in Arabic (Available only in the latest version of the Emirates ID)

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