curl --request POST \
--url https://verification.didit.me/v3/id-verification/wallets/uae-pass/ \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Idempotency-Key: your-unique-attempt-key' \
--header 'Content-Type: application/json' \
--data '{
"country": "ARE",
"vendor_data": "your-customer-reference",
"metadata": {
"reference": "example"
},
"return_url": "https://app.example.com/identity/complete"
}'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.id_wallets.start_uae_pass(
vendor_data="your-customer-reference",
metadata={"reference": "example"},
country="ARE",
return_url="https://app.example.com/identity/complete",
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.idWallets.startUaePass({
vendor_data: "your-customer-reference",
metadata: { reference: "example" },
country: "ARE",
return_url: "https://app.example.com/identity/complete",
});
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.IDWallets.StartUaePass(ctx, didit.IDWalletsStartUaePassParams{
Body: didit.DigitalIDWalletAPIUaePassWalletVerificationStartRequest{
VendorData: didit.String("your-customer-reference"),
Metadata: didit.Some(map[string]any{"reference": "example"}),
Country: didit.Some(didit.DigitalIDWalletAPIUaePassWalletVerificationStartCountryEnum("ARE")),
ReturnURL: "https://app.example.com/identity/complete",
},
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import java.util.Map;
import me.didit.Didit;
import me.didit.types.DigitalIdWalletApiUaePassWalletVerificationStartCountryEnum;
import me.didit.types.DigitalIdWalletApiUaePassWalletVerificationStartRequest;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.idWallets().startUaePass(DigitalIdWalletApiUaePassWalletVerificationStartRequest.builder()
.vendorData("your-customer-reference")
.metadata(Map.of("reference", "example"))
.country(DigitalIdWalletApiUaePassWalletVerificationStartCountryEnum.of("ARE"))
.returnUrl("https://app.example.com/identity/complete")
.build());
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->idWallets->startUaePass([
'vendor_data' => 'your-customer-reference',
'metadata' => ['reference' => 'example'],
'country' => 'ARE',
'return_url' => 'https://app.example.com/identity/complete',
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.id_wallets.start_uae_pass(
vendor_data: "your-customer-reference",
metadata: { reference: "example" },
country: "ARE",
return_url: "https://app.example.com/identity/complete"
)
puts result.to_husing System;
using System.Collections.Generic;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.IdWallets.StartUaePassAsync(new DigitalIdWalletApiUaePassWalletVerificationStartRequest
{
VendorData = "your-customer-reference",
Metadata = new Dictionary<string, object> { ["reference"] = "example" },
Country = new DigitalIdWalletApiUaePassWalletVerificationStartCountryEnum("ARE"),
ReturnUrl = "https://app.example.com/identity/complete",
});
Console.WriteLine(JsonSerializer.Serialize(result));{
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"wallet_verification": {
"wallet": {
"id": "<string>",
"name": "<string>",
"issuing_authority": "<string>"
},
"country": "<string>",
"status": "<string>",
"outcome": "pending",
"error": "<string>",
"interaction": "redirect",
"simulated": true,
"expires_at": "2023-11-07T05:31:56Z",
"next_action": {
"type": "redirect",
"url": "<string>",
"digital_credentials": {
"protocol": "<string>",
"request": {}
},
"verification_code": "<string>",
"poll_interval_seconds": 123
},
"identity": {
"full_name": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"date_of_birth": "2023-12-25",
"nationality": "<string>",
"issuing_state": "<string>"
},
"attributes": {},
"level_of_assurance": "<string>",
"verified_at": "2023-11-07T05:31:56Z",
"signature_valid": true,
"credential_type": "<string>"
},
"vendor_data": "<string>",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z"
}{
"error": "<string>",
"detail": "<string>"
}{
"detail": "Forbidden - User doesn't have permission"
}{
"error": "<string>",
"detail": "<string>"
}{
"error": "<string>",
"detail": "<string>"
}{
"error": "<string>",
"detail": "<string>"
}UAE PASS Verification API
How Didit verifies UAE PASS users against the details you declare, returning only whether they match. Coverage, requirements, results and pricing.
curl --request POST \
--url https://verification.didit.me/v3/id-verification/wallets/uae-pass/ \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Idempotency-Key: your-unique-attempt-key' \
--header 'Content-Type: application/json' \
--data '{
"country": "ARE",
"vendor_data": "your-customer-reference",
"metadata": {
"reference": "example"
},
"return_url": "https://app.example.com/identity/complete"
}'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.id_wallets.start_uae_pass(
vendor_data="your-customer-reference",
metadata={"reference": "example"},
country="ARE",
return_url="https://app.example.com/identity/complete",
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.idWallets.startUaePass({
vendor_data: "your-customer-reference",
metadata: { reference: "example" },
country: "ARE",
return_url: "https://app.example.com/identity/complete",
});
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.IDWallets.StartUaePass(ctx, didit.IDWalletsStartUaePassParams{
Body: didit.DigitalIDWalletAPIUaePassWalletVerificationStartRequest{
VendorData: didit.String("your-customer-reference"),
Metadata: didit.Some(map[string]any{"reference": "example"}),
Country: didit.Some(didit.DigitalIDWalletAPIUaePassWalletVerificationStartCountryEnum("ARE")),
ReturnURL: "https://app.example.com/identity/complete",
},
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import java.util.Map;
import me.didit.Didit;
import me.didit.types.DigitalIdWalletApiUaePassWalletVerificationStartCountryEnum;
import me.didit.types.DigitalIdWalletApiUaePassWalletVerificationStartRequest;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.idWallets().startUaePass(DigitalIdWalletApiUaePassWalletVerificationStartRequest.builder()
.vendorData("your-customer-reference")
.metadata(Map.of("reference", "example"))
.country(DigitalIdWalletApiUaePassWalletVerificationStartCountryEnum.of("ARE"))
.returnUrl("https://app.example.com/identity/complete")
.build());
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->idWallets->startUaePass([
'vendor_data' => 'your-customer-reference',
'metadata' => ['reference' => 'example'],
'country' => 'ARE',
'return_url' => 'https://app.example.com/identity/complete',
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.id_wallets.start_uae_pass(
vendor_data: "your-customer-reference",
metadata: { reference: "example" },
country: "ARE",
return_url: "https://app.example.com/identity/complete"
)
puts result.to_husing System;
using System.Collections.Generic;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.IdWallets.StartUaePassAsync(new DigitalIdWalletApiUaePassWalletVerificationStartRequest
{
VendorData = "your-customer-reference",
Metadata = new Dictionary<string, object> { ["reference"] = "example" },
Country = new DigitalIdWalletApiUaePassWalletVerificationStartCountryEnum("ARE"),
ReturnUrl = "https://app.example.com/identity/complete",
});
Console.WriteLine(JsonSerializer.Serialize(result));{
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"wallet_verification": {
"wallet": {
"id": "<string>",
"name": "<string>",
"issuing_authority": "<string>"
},
"country": "<string>",
"status": "<string>",
"outcome": "pending",
"error": "<string>",
"interaction": "redirect",
"simulated": true,
"expires_at": "2023-11-07T05:31:56Z",
"next_action": {
"type": "redirect",
"url": "<string>",
"digital_credentials": {
"protocol": "<string>",
"request": {}
},
"verification_code": "<string>",
"poll_interval_seconds": 123
},
"identity": {
"full_name": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"date_of_birth": "2023-12-25",
"nationality": "<string>",
"issuing_state": "<string>"
},
"attributes": {},
"level_of_assurance": "<string>",
"verified_at": "2023-11-07T05:31:56Z",
"signature_valid": true,
"credential_type": "<string>"
},
"vendor_data": "<string>",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z"
}{
"error": "<string>",
"detail": "<string>"
}{
"detail": "Forbidden - User doesn't have permission"
}{
"error": "<string>",
"detail": "<string>"
}{
"error": "<string>",
"detail": "<string>"
}{
"error": "<string>",
"detail": "<string>"
}expected_details, so this standalone endpoint never starts it: every request answers 403 with wallet_unavailable, sandbox applications included.
Coverage and activation
| Property | Value |
|---|---|
| Wallet | UAE PASS |
| Wallet ID | uae_pass |
| Countries | |
| Production wallet activation | ⏳ Coming soon |
| Published wallet price | Coming soon |
How to verify with UAE PASS
- Enable UAE PASS for the country in the ID Verification step of your workflow.
- Create a verification session with
expected_details:identification_number(the Emirates ID number), or a name (first_name,last_name) withdate_of_birth. Without them UAE PASS is not offered to the session. - 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 inid_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.
Related
Authorizations
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
Body
Start a UAE PASS verification (ARE).
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.
1 - 2048Response
Never returned for UAE PASS: this endpoint always answers 403 wallet_unavailable.
One standalone wallet verification, as every wallet endpoint answers it.