Emirates ID Front Extraction

Extracts ID number, name, sex, nationality, date of birth, issue date, expiry date and the Arabic name from the front of a UAE Emirates ID card.

POSThttps://sandbox/pcs/emiratesId/front

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 front image.

Example

POST/pcs/emiratesId/front

curl --location 'https://sandbox/pcs/emiratesId/front' \
--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": "123-4567-0123446-0",
  "name": "name-string",
  "sex": "F",
  "nationality": "UNITED ARAB EMIRATES",
  "DOB": "10/01/1992",
  "issueDate": "26/01/2022",
  "expiryDate": "25/01/2032",
  "arabic_name_status": "EXTRACTED SUCCESSFULLY",
  "arabic_name": "<arabic-name-string>"
},
"utc_time_stamp": "12/06/2024, 08:28:32"
}

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.name	string	Holder's name (Latin script).
data.sex	string	Holder's sex, M / F.
data.nationality	string	Holder's nationality.
data.DOB	string	Date of birth, DD/MM/YYYY.
data.issueDate	string	Issue date, DD/MM/YYYY.
data.expiryDate	string	Expiry date, DD/MM/YYYY.
data.arabic_name_status	string	EXTRACTED SUCCESSFULLY or a failure reason, e.g. NAME NOT CLEAR IN IMAGE.
data.arabic_name	string	Holder's name in Arabic script. Empty when arabic_name_status reports a failure.
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.