Emirates ID API
Introduction
This API is used to extract important details from the Emirates ID card using OCR technology.
How to call the API
You will need to login before sending request. You are required to pass the access token received from the login call, as authorization header in the Emirates ID request.
API Input Guidelines
Emirates ID reading system accepts direct URL of the front image of Emirates ID.
Sample Request
curl --location --request POST 'https://preproduction.signzy.tech/api/v2/patrons/..patronID../foreignidentitiesextractions' \
--header 'Accept: */*' \
--header 'Accept-Language: en-US,en;q=0.8' \
--header 'Authorization: <token>' \
--header 'content-type: application/json' \
--data-raw '{
"task": "emiratesId",
"essentials": {
"files": [
"<Front Image Url>",
"<Back Image Url>"
]
}
}'Response Parameter
PARAMETERS | DESCRIPTION |
|---|---|
id | Unique id of the response |
patronId | Unique id of the user generated from login call |
task | emiratesId |
essentials.files | URLs containing emirates ID front and back side |
result.dob | Date of Birth of the Id holder |
result.expiryDate | Date of Expiry of the Emirates ID |
result.nationality | Nationality of the individual |
result.nationalityCode | Country code of the nationality of the individual |
result.firstName | First Name of the individual |
result.lastName | Last Name of the individual |
result.name | Name of the individual |
result.gender | Gender of the individual |
result.idNumber | ID number of the individual's Id |
result.cardNumber | Number on the card of the individual |
Getting help
Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.
You can reach out to us at [email protected].