Emirates ID Get Name Async

Introduction
The Emirates ID Get Name API product provides a comprehensive solution for establishing that this Emirates ID belong to this person , offering several benefits and can be used for below purposes:
Compliance
Business Transactions
Identification and Documentation
Risk Management
Government Oversight
Fraud Prevention
The Emirates ID Get Name API product facilitates seamless and reliable validation of the ownership of Emirates ID , enabling organizations to ensure compliance, enhance risk management practices, prevent fraud, and support secure and trustworthy interactions. By leveraging this API, organizations can streamline their processes, improve data accuracy, and maintain the integrity of their operations in line with global standards.
What is an Emirates ID
Emirates ID is an identity card issued by the Federal Authority for Identity and Citizenship (https://www.ica.gov.ae/). It is a legal requirement for all UAE citizens and residents to apply for one and carry it with them at all times. The Emirates ID is used:
To get government services.
To vote in the elections of Federal National Council.
As a travel document for UAE citizens to travel within the GCC.
As a document to pass immigration through the eGates and smart gates at several airports in the UAE.
Structure of Emirates ID
Each Emirates ID card has a unique 15 digit number which is divided into 4 parts. Here is what they mean:
The 1st part is the same on all the cards and it represents UAE international code, which is 784.
The 2nd part matches your year of birth.
The 3rd part has 7 digits, which do not mean anything and are put together randomly by the system.
The 4th part is just a 1 digit and it stands for a verification number, which could be a digit from 0 to 9.
The number of the ID is designed for each person and stays with that person forever. It cannot be changed or amended. Even if you stop being a UAE resident and leave the country, in case you come back after a few years to get your residency again, the number assigned to your card will be the same again.
Who can get an Emirates ID
UAE nationals
GCC nationals residing in the UAE
Expatriate residents.
Note :- 
We strongly recommned using both Emirates ID Verification Prefill﻿ & Emirates ID Get Name Async﻿ APIs together. 
Emirates ID Verification API will establish that the inputs provided like Emirates ID number, nationality & DOB are correct. Also, it will confirm the status & expiry date of Emirates ID.
Emirates ID Get Name API will confirm that this Emirates ID belongs to this person as we will fetch you the name of the emirates ID card holder. Please note that this API doesn't establish that all Emirates ID number, nationality & DOB are correct as per the physical issued emirates ID and the ID is active. We use a govt. source to fetch the name as per the 3 inputs and emirates ID number has to be correct as a basic requirement. 
Coverage:

Approximately 65% to 70% of Emirates ID data is available for coverage in this API. Rest of the data is not available from the source itself. 
API Applications
B2B (Business-to-Business) Applications:
Background Checks : Background screening companies can integrate these APIs to verify the identity and background of individuals as part of pre-employment screening or tenant verification services.
HR and Payroll: HR software providers can use these APIs to validate employee identity and personal information for payroll processing and compliance with labor laws.
Insurance: Insurance companies can use these APIs for identity verification when underwriting policies, processing claims, and preventing insurance fraud.
Legal Services: Law firms may use these APIs for client identity verification and conflict of interest checks.
Education: Educational institutions can use these APIs to verify student identities during the admission process and ensure accurate academic records.
Travel and Hospitality: Hotels and airlines can use these APIs to verify passenger identities during bookings, enhancing security and streamlining check-in processes.
Government Agencies: Different government departments can use these APIs to share identity data securely for various purposes, such as immigration, law enforcement, or social services.
B2C (Business-to-Consumer) Applications:
Identity Verification for Online Services: Online platforms and apps can use these APIs to verify the identity of users during account registration. Users can submit their Emirates ID details, and the platform can use the APIs to fetch and verify the user's information.
Government Services: Government agencies can offer online services that require identity verification. Citizens can use their Emirates ID to access services such as applying for licenses, permits, or accessing personal records.
E-commerce: E-commerce platforms can use these APIs to verify the identity of customers during the purchase process, enhancing security and preventing fraudulent transactions.
Healthcare: Healthcare providers can use these APIs to verify patient identities, ensuring that medical records are accurate and that the right treatment is provided to the right person.
Banking and Financial Services: Banks can utilize these APIs for customer identity verification during account opening, loan applications, and other financial transactions. This helps in compliance with Know Your Customer (KYC) regulations.
API Endpoints
The API consists of two main endpoints:
/api/v3/uae-api/name-emirates-id-async: This endpoint is used to initiate a request for emirates id information using the provided data & callback url.

/api/v3/uae-api/name-emirates-id-get-data: This endpoint is used to fetch the requested information using the requestId received in the response of the initiate request.
Emirates ID Initiate Request Async API
The Async API for fetching Emirates ID data is a powerful tool designed to provide asynchronous access to essential identity information related to individuals in the United Arab Emirates (UAE). This API is particularly valuable for organizations and services that require accurate identity verification and data retrieval while ensuring a smooth and efficient user experience.
Key Features:
Asynchronous Processing: The API operates asynchronously, allowing users to initiate data retrieval requests without the need for time-consuming wait periods.
Efficient Data Retrieval: Users can submit Emirates ID numbers, dates of birth, current nationalities, and callback URLs to initiate data retrieval for individuals.
Status Tracking: The API provides real-time status updates, enabling users to monitor the progress of their data retrieval requests.
Secure Data Handling: Emirates ID data is handled with the utmost care and security to protect individuals' privacy and ensure compliance with data protection regulations.
API Details
You must first login before sending the request. The authorization header in the request must include the access token obtained from the login API call.
Initiating a request for an emiratesIdNumber(ASYNC):
Need to pass the following information. Providing all input parameters is mandatory. 
emiratesIdNumber(required)
dateOfBirth(required)
currentnationality(required)
callbackUrl(required)
﻿
Sample cURL
Pre-Production
Production
Curl
curl --location 'https://api-preproduction.signzy.app/api/v3/uae-api/name-emirates-id-async' \
--header 'Content-Type: application/json' \
--header 'Authorization: <token>' \
--data '{
    "emiratesIdNumber": "784199453168392",
    "dateOfBirth": "1994-09-11",
    "currentNationality": "palau",
    "callbackUrl": "<callbackUrl>"
}'
curl --location 'https://api-preproduction.signzy.app/api/v3/uae-api/name-emirates-id-async' \
--header 'Content-Type: application/json' \
--header 'Authorization: <token>' \
--data '{
    "emiratesIdNumber": "784199453168392",
    "dateOfBirth": "1994-09-11",
    "currentNationality": "palau",
    "callbackUrl": "<callbackUrl>"
}'
﻿
Curl
curl --location 'https://api.signzy.ae/api/v3/uae-api/name-emirates-id-async' \
--header 'Content-Type: application/json' \
--header 'Authorization: <token>' \
--data '{
    "emiratesIdNumber": "<Emirates ID number>",
    "dateOfBirth": "<yyyy-mm-dd>",
    "currentNationality": "<country>",
    "callbackUrl": "<callback URL>"
}'
curl --location 'https://api.signzy.ae/api/v3/uae-api/name-emirates-id-async' \
--header 'Content-Type: application/json' \
--header 'Authorization: <token>' \
--data '{
    "emiratesIdNumber": "<Emirates ID number>",
    "dateOfBirth": "<yyyy-mm-dd>",
    "currentNationality": "<country>",
    "callbackUrl": "<callback URL>"
}'
﻿
Request Body Parameters
The API expects the following input in the request payload:
JSON
{
    "emiratesIdNumber": "<Emirates ID Number>",
    "dateOfBirth": "<yyyy-mm-dd>",
    "currentNationality": "<country>",
    "callbackUrl": "<Callback URL>"
}
{
    "emiratesIdNumber": "<Emirates ID Number>",
    "dateOfBirth": "<yyyy-mm-dd>",
    "currentNationality": "<country>",
    "callbackUrl": "<Callback URL>"
}
﻿
Parameter
Data Type
Required
Description
emiratesidNumber
number
Yes
Required The Emirates ID which is to be verified.
Emirates id should begin with ”784”.
Next 4 parameters after 784 is year of birth. That should match to the year of birth entered in date of birth.
dateOfBirth
string
Yes
Required Date of Birth of Emirates ID holder in yyyy-mm-dd format(mandatory).
currentNationality
string
Yes
Required Current Nationality of user(must be available in the list of supported countries. Please check Emirates ID Verification Prefill﻿ document for supported countries).
callbackUrl
string
Yes
Required The URL to which the API will send a response after processing the request(callbackUrl should be correct and accessible in order to post the response).
Sample Response
Request Processing
Request Successful
Request Failure
{
    "result": {
        "requestId": "<request ID>",
        "statusCode": 409,
        "status": "FAILURE"
    }
}
{
    "result": {
        "requestId": "<request ID>",
        "statusCode": 409,
        "status": "FAILURE"
    }
}
﻿
Response Body parameters
Parameter
Data Type
Description
requestId
string
RequestID to track the request and use it in get data API.
statusCode
string
The status code of the request.
status
string
The message describing the current status of the API request.
Sample Error
Upstream Error 409
Empty emiratesIdNumber 400
emiratesIdNumber not passed 400
Malformatted emiratesIdNumber 400
Empty dateOfBirth 400
dateOfBirth not passed 400
Malformatted dateOfBirth 400
Empty currentNationality 400
currentNationality not passed 400
Malformatted currentNationality 400
Empty callbackUrl 400
callbackUrl not passed 400
Malformatted callbackUrl 400
Internal Server Error 500
{
  "error": {
    "name": "error",
    "message": "dateOfBirth is not allowed to be empty",
    "status": 400,
    "reason": "VALIDATION_ERROR",
    "type": "Bad Request",
    "statusCode": "400"
  }
}
{
  "error": {
    "name": "error",
    "message": "dateOfBirth is not allowed to be empty",
    "status": 400,
    "reason": "VALIDATION_ERROR",
    "type": "Bad Request",
    "statusCode": "400"
  }
}
﻿
Emirates ID Get Data API
The Get-Data API is a robust solution that complements our Async API for Emirates ID data retrieval. It serves as the endpoint for efficiently retrieving Emirates ID data once it becomes available. With this API, users can effortlessly access the requested identity information associated with a specific requestId, obtained from the Async API's response.
Key Features:
Data Retrieval: The GetData API facilitates the retrieval of Emirates ID data that was previously requested via the Async API.
Efficiency: Users can retrieve the data they need without the need to continuously poll for updates. It ensures that users only receive the data when it is available.
Data Security: Emirates ID data is handled with the utmost care and security, following stringent data protection protocols.
API Details
You must first login before sending the request. The authorization header in the request must include the access token obtained from the login API call.
Need to pass the following information. Providing requestId is mandatory. 
requestId(required)
Sample cURL
Pre-Production
Production
Curl
curl --location 'https://api-preproduction.signzy.app/api/v3/uae-api/name-emirates-id-get-data' \
--header 'Content-Type: application/json' \
--header 'Authorization: <token>' \
--data '{
    "requestId": "<request ID>"
}'
curl --location 'https://api-preproduction.signzy.app/api/v3/uae-api/name-emirates-id-get-data' \
--header 'Content-Type: application/json' \
--header 'Authorization: <token>' \
--data '{
    "requestId": "<request ID>"
}'
﻿
Curl
curl --location 'https://api.signzy.ae/api/v3/uae-api/name-emirates-id-get-data' \
--header 'Content-Type: application/json' \
--header 'Authorization: <token>' \
--data '{
    "requestId": "<request ID>"
}'
curl --location 'https://api.signzy.ae/api/v3/uae-api/name-emirates-id-get-data' \
--header 'Content-Type: application/json' \
--header 'Authorization: <token>' \
--data '{
    "requestId": "<request ID>"
}'
﻿
Request Body Parameters
The API expects the following input in the request payload:
JSON
{
    "requestId": "<Request ID> (obtained from the first API)",
}
{
    "requestId": "<Request ID> (obtained from the first API)",
}
﻿
Parameter
Data Type
Required
Description
requestId
string
Yes
Required Unique request ID generated for the input provided in async API
Sample Response
Success 200
{
    "result": {
  "requestId": "<Request ID> (obtained from the first API)",
  "input": {
    "emiratesIdNumber": "<Emirates ID Number>",
    "dateOfBirth": "<yyyy-mm-dd>",
    "currentNationality": "<country>",
    "callbackUrl": "<Callback URL>"
  },
  "statusCode": 200,
  "status": "SUCCESS",
  "message": "EmiratesID details found",
  "output": {
    "nameEnglish": "<name in English>",
    "nameArabic": "<name in Arabic>",
    "maskedMobileNumber": "05*****440"
  }
}
}
{
    "result": {
  "requestId": "<Request ID> (obtained from the first API)",
  "input": {
    "emiratesIdNumber": "<Emirates ID Number>",
    "dateOfBirth": "<yyyy-mm-dd>",
    "currentNationality": "<country>",
    "callbackUrl": "<Callback URL>"
  },
  "statusCode": 200,
  "status": "SUCCESS",
  "message": "EmiratesID details found",
  "output": {
    "nameEnglish": "<name in English>",
    "nameArabic": "<name in Arabic>",
    "maskedMobileNumber": "05*****440"
  }
}
}
﻿
Response Body parameters
Parameter
Data Type
Description
requestId
string
Request ID for which data is fetched.
input
object
The object containing input data for which output has been fetched.
statusCode
number
The status code of the request.
status
string
The message describing the current status of the API request.
message
string
The message describing the current status of the API request.
output
object
The object containing output response for given input data.
output parameters(Response Body)
Parameter
Data Type
Description
nameEnglish
string
Name of ID card holder in English.
nameArabic
string
Name of ID card holder in Arabic.
maskedMobileNumber
string
Masked mobile number of ID card holder.
Sample Error
Malformatted RequestId 400
requestId Not Found 409
{
    "error": {
        "name": "error",
        "message": "RequestId not found",
        "reason": "BAD_REQUEST",
        "type": "Bad Request",
        "statusCode": "40"
    }
}
{
    "error": {
        "name": "error",
        "message": "RequestId not found",
        "reason": "BAD_REQUEST",
        "type": "Bad Request",
        "statusCode": "40"
    }
}
﻿
﻿
Error Response Parameters
Parameter
Description
error
This parameter contains the error.
error.name
the error name.
error.message
the error message.
error.status
Status of the api
error.reason
Reason for error
error.type
Type of the error
error.statusCode
Request Status code from Signzy
﻿
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]. We strive to provide prompt and reliable assistance, ensuring your queries are addressed effectively.
We value your feedback and are committed to making your experience smooth and enjoyable. Our team is dedicated to assisting you with any needs you may have. Thank you for choosing our services. We look forward to helping you!
﻿

Parameter	Data Type	Required	Description
emiratesidNumber	number	Yes	Required The Emirates ID which is to be verified. Emirates id should begin with ”784”. Next 4 parameters after 784 is year of birth. That should match to the year of birth entered in date of birth.
dateOfBirth	string	Yes	Required Date of Birth of Emirates ID holder in yyyy-mm-dd format(mandatory).
currentNationality	string	Yes	Required Current Nationality of user(must be available in the list of supported countries. Please check Emirates ID Verification Prefill document for supported countries).
callbackUrl	string	Yes	Required The URL to which the API will send a response after processing the request(callbackUrl should be correct and accessible in order to post the response).

Parameter	Data Type	Description
requestId	string	RequestID to track the request and use it in get data API.
statusCode	string	The status code of the request.
status	string	The message describing the current status of the API request.

Parameter	Data Type	Required	Description
requestId	string	Yes	Required Unique request ID generated for the input provided in async API

Parameter	Data Type	Description
requestId	string	Request ID for which data is fetched.
input	object	The object containing input data for which output has been fetched.
statusCode	number	The status code of the request.
status	string	The message describing the current status of the API request.
message	string	The message describing the current status of the API request.
output	object	The object containing output response for given input data.

Parameter	Data Type	Description
nameEnglish	string	Name of ID card holder in English.
nameArabic	string	Name of ID card holder in Arabic.
maskedMobileNumber	string	Masked mobile number of ID card holder.

Parameter	Description
error	This parameter contains the error.
error.name	the error name.
error.message	the error message.
error.status	Status of the api
error.reason	Reason for error
error.type	Type of the error
error.statusCode	Request Status code from Signzy

Did this page help you?

Emirates ID Verification Prefill

UAE Residency Visa