🇦🇪UAE Resident ID OCR

This API provides Data Extraction for the UAE Resident ID

UAE ID OCR

POST https://valifystage.com/api/v1/ocr/

Headers

Name	Type	Description
Content-Type	string	application/json
Authentication	string	Bearer <access-token>

Request

Name	Type	Description
document_type*	string	uae_resident_id
data*	object	Request details { img: <base64 str>, bundle_key: <str>, lang: <str> }

Response:

✅200 Successful

{
  "result": {
    "type": "<string>",
    "country": "<string>",
    "number": "<string>",
    "date_of_birth": "<string>",
    "expiration_date": "<string>",
    "nationality": "<string>",
    "sex": "<string>",
    "name": "<string>",
    "surname": "<string>",
    "optional1": "<string>",
    "personal_number": "<string>",
    "validity": <int>,
    "serial_number": "<string>"
  },
  "transaction_id": "<string>",
  "trials_remaining": <int>
}

400 Missing input data

{
    "message": "Bad Request – invalid request received (e.g. missing Bundle key, required parameters or invalid json) | Make sure all the required parameters are included"
}

401 Invalid bundle key

{
    "message": "Unauthorized – your Bundle key is invalid"
}

403 Access token error

{
    "message": "Forbidden – specified access_token could not be found"
}

404 Check the endpoint

{
    "message": "Not Found"
}

415 The format should be base64

{
    "message": "Unsupported Media Type"
}

422 Check Valify error codes

{
    "message": "<error-description>",
    "error_code": <valify-error-code>
}

500: Internal Server Error

{
    "message": "Internal Server Error"
}

500 Contact us

{
    "message": "Internal Server Error"
}