Emirates ID Back Extraction

Extracts ID number, card number, name, sex, nationality, date of birth, issue date / place, expiry date, occupation, employer and family sponsor from the back of a UAE Emirates ID card.

POSThttps://sandbox/pcs/emiratesId/back

Content-Type: application/json

Headers

Header	Type	Required	Description
key	string	Yes	API key issued for authentication.

Request body

Field	Type	Required	Description
recordId	string	Yes	Unique ID you assign to correlate the request with the response.
image	string	Yes	Base64 string / data URI of the Emirates ID back image.

Example

POST/pcs/emiratesId/back

curl --location 'https://sandbox/pcs/emiratesId/back' \
--header 'key: <your-api-key>' \
--header 'Content-Type: application/json' \
--data '{
  "recordId": "1",
  "image": "data:image/png;base64,<BASE64_STRING>"
}'

200

{
"recordId": "1",
"dataRetrievalStatus": "SUCCESS",
"data": {
  "idNumber": "012345678912345",
  "cardNumber": "123456789",
  "name": "name-string",
  "sex": "F",
  "nationality": "UKR",
  "DOB": "10-06-1990",
  "issueDate": "",
  "issuePlace": "",
  "expiryDate": "22-03-2033",
  "occupation": "",
  "employer": "",
  "familySponsor": ""
},
"utc_time_stamp": "25/07/2024, 10:58:25"
}

Response

Field	Type	Description
recordId	string	Echoes the recordId sent in the request.
dataRetrievalStatus	string	SUCCESS when data was extracted.
data.idNumber	string	Emirates ID number.
data.cardNumber	string	Physical card number.
data.name	string	Holder's name.
data.sex	string	Holder's sex, M / F.
data.nationality	string	Holder's nationality.
data.DOB	string	Date of birth.
data.issueDate	string	Card issue date, where printed.
data.issuePlace	string	Place of issue, where printed.
data.expiryDate	string	Card expiry date.
data.occupation	string	Holder's occupation, where printed.
data.employer	string	Holder's employer, where printed.
data.familySponsor	string	Family sponsor, where printed.
utc_time_stamp	string	UTC timestamp of the response, DD/MM/YYYY, HH:mm:ss.

Error handling

200 on success, 422 on a validation error — see Error handling for the common error shape.