Emirates ID
Introduction
This API is used to extract important details from the Emirates ID card using OCR technology.
The API extracts personal information including DOB, name, gender, first name and last name. It also extracts information related to nationality, national ID-number and card number of the Emirates ID holder.
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.
You will need to pass your patronID as well received from the login call while calling the API.
API Input Guidelines
Emirates ID reading system accepts direct URL of the front and back image of Emirates ID. It detects and extracts the content of the Emirates ID Card from the MRZ region of the back side of the Emirates ID and gives out response for fields mentioned in the "result" section in "Responses".
The file size limit for the API is 10MB for each input URL given to the API endpoint. The endpoint also supports all sorts of image data types including jpg, jpeg, png, jfif, jif, pdf and tiff URL files.
Sample Request
curl --location --request POST 'https://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": [
"<image file Url> "
],
"subMessageCheck": <Boolean>
}
}'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 |
essentials.subMessageCheck | Toggle to Include Sub-Message Indicating Emirates ID Type in Response |
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 |
Error Codes
Status Code | DESCRIPTION |
|---|---|
200 | Successful Processing of the Request |
400 | Bad Request / Could not extract data |
403 | Forbidden / No permission |
422 | Unprocessable Entity |
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].