UAE

Emirates ID

post

Government database lookup API

Header parameters

AuthorizationstringRequired

Bearer token

Body

application/json

identityNumberstring · min: 1Required

dateOfBirthstring · min: 1Required

yyyy-MM-dd

Pattern: \d{4}-\d{2}-\d{2}

nationalityCodestring · enumRequired

ISO 3166-1 alpha-3 format

Possible values:

Responses

200

OK

application/json

identityNumberstringOptional

nationalityCodestring · enumOptional

ISO 3166-1 alpha-3 format

Possible values:

cardNumberstringOptional

dateOfBirthstringOptional

dateOfBirthFormattedstringOptional

ISO-8601 format yyyy-MM-dd

issueDatestringOptional

issueDateFormattedstringOptional

ISO-8601 format yyyy-MM-dd

dateOfExpirystringOptional

dateOfExpiryFormattedstringOptional

ISO-8601 format yyyy-MM-dd

400

Bad Request: Missing required input or invalid format

application/json

401

Unauthorized: No valid access token has been provided

403

Forbidden: Access token doesn't have permission to use the requested feature

429

Too Many Requests

500

Internal Server Error: Unexpected error

503

Service unavailable: Government database not available

post/api/v2/id/lookup/uae/id

HTTPcURLJavaScriptPython

POST /api/v2/id/lookup/uae/id HTTP/1.1
Host: id.uqudo.io
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 70

{
  "identityNumber": "text",
  "dateOfBirth": "text",
  "nationalityCode": "ABW"
}

{
  "identityNumber": "text",
  "nationalityCode": "ABW",
  "cardNumber": "text",
  "dateOfBirth": "text",
  "dateOfBirthFormatted": "text",
  "issueDate": "text",
  "issueDateFormatted": "text",
  "dateOfExpiry": "text",
  "dateOfExpiryFormatted": "text"
}

Note: Our API has a read timeout threshold of 35 seconds. To ensure you receive a proper response, we recommend setting your read timeout to at least 40 seconds, as this adds a small buffer for minor network or processing delays. Additionally, please be aware that if the target government service is unavailable or times out, our system will always return an HTTP 503 status code. It is important to handle this error appropriately in your implementation.

As a general best practice, for any HTTP 5xx status code, you should implement a retry mechanism with a short delay (a few seconds) before retrying. This approach helps mitigate temporary network disruptions and momentary unavailability of the government service. The same applies if your request times out without receiving a response.

Inherent unreliability of goverment services

Unfortunately, some government services are inherently unreliable, leading to unpredictable failures. There are no guaranteed SLAs, and the service may suffer from frequent, unplanned outages that can sometimes last several hours. In view of these challenges, we highly recommend using an asynchronous approach when integrating with this API:

• Queue Requests: Instead of making direct API calls, enqueue requests using a message queue (e.g., AWS SQS, RabbitMQ).

• Asynchronous Processing: Have worker nodes process requests asynchronously to minimize system load.

• Background Retries: Manage retries in the background so that users are not affected.

• User Notifications: Replace real-time validation with a message like, “Your application is being processed. You will receive an update shortly.”

• Result Delivery: Communicate results through push notifications or via Email/SMS updates.