Skip to main content
POST
cURL
Didit’s UAE PASS verification confirms whether the details you declared for your user match their UAE PASS identity, and returns only that outcome, never the identity itself. It runs inside a verification session created with expected_details, so this standalone endpoint never starts it: every request answers 403 with wallet_unavailable, sandbox applications included.

Coverage and activation

Wallet activation is separate from API deployment and your application’s eligibility. A documented endpoint does not activate a wallet that is marked Coming soon. For current published rates, see digital ID wallet pricing.

How to verify with UAE PASS

  1. Enable UAE PASS for the country in the ID Verification step of your workflow.
  2. Create a verification session with expected_details: identification_number (the Emirates ID number), or a name (first_name, last_name) with date_of_birth. Without them UAE PASS is not offered to the session.
  3. The person signs in with UAE PASS on Didit’s verification screens.

Receive the result

The session decision and its webhooks carry one result per declared detail in id_verifications[].wallet_verification.attributes: name_match, date_of_birth_match and identification_number_match, each match or no_match. The identity fields of the ID verification result stay empty: Didit returns nothing UAE PASS shared about the person and keeps none of it after the comparison. A declared detail that does not match raises the matching expected-details warning and follows your workflow’s expected-details mismatch action.

Authorizations

x-api-key
string
header
required

Your application's API key, from Developers -> API keys in the Business Console. The primary key has full access. A named key can be scoped: none, read or write per resource, limited to some workflows or to approved sessions, to a list of IP addresses, and to an expiry date. 401 means the key is wrong, revoked or expired; 403 means no key was sent, the key has no access to this resource or action, or the request came from an address outside its IP list; 404 on a session route means the session is outside the key's workflows or statuses. A key without media access receives image, video and PDF URLs as null, and a key without sessions write receives session links and tokens as null. See https://docs.didit.me/console/api-keys.

Headers

Idempotency-Key
string

Optional retry-safety key (max 255 characters). Retrying with the same key, wallet and body returns the original verification without starting a second sign-in; the same key with another wallet or body returns 409 idempotency_key_reused.

Body

Start a UAE PASS verification (ARE).

return_url
string<uri>
required

https URL the user's browser returns to after the wallet, with request_id and result appended. Its host must be registered in the application's allowed_return_hosts (or be its white-label domain). Never trust result on its own: read the outcome with GET .../verifications/{request_id}/ or the webhook.

Required string length: 1 - 2048
vendor_data
string | null

Your own reference for this verification (e.g. your user id). Returned in results and webhooks.

metadata
object | null

Optional JSON object stored with the verification and returned in results and webhooks.

sandbox_scenario
string

Sandbox applications only: the simulated outcome - 'wallet_cancelled', 'wallet_timeout' or 'wallet_provider_error'; any other scenario (or none) verifies. Rejected on live applications. The full catalog is available at GET /v1/sandbox/scenarios/.

Minimum string length: 1
country
enum<string>
default:ARE

ISO 3166-1 alpha-3 country of the UAE PASS identity. Defaults to ARE, the only country it serves.

  • ARE - ARE
Available options:
ARE
device
enum<string>
default:same_device

same_device when the user signs in on the device showing your page, cross_device when they use another one (e.g. BankID's QR code).

  • same_device - same_device
  • cross_device - cross_device
Available options:
same_device,
cross_device

Response

Never returned for UAE PASS: this endpoint always answers 403 wallet_unavailable.

One standalone wallet verification, as every wallet endpoint answers it.

request_id
string<uuid>
required
wallet_verification
object
required
vendor_data
string | null
required
metadata
object | null
required

The metadata object sent at start, or null.

created_at
string<date-time>
required
Last modified on November 16, 2026