Know Your Customer
...
Global
UAE

UAE Residency Visa

Overview & Purpose

We are developing a new UAE Residency Visa API, a solution designed to streamline and enhance the accuracy of residency visa verification. Created in response to the discovery of a new, authoritative data source, this API is engineered to offer real-time residency status confirmation with precision and speed, marking a significant improvement over existing verification methods we have in the UAE.

This API aims to address and resolve the critical issue of date mismatches between Emirates ID and residency visas by utilising the latest data processed from the source website. This new API will enable seamless integration for our clients, offering a robust verification system that not only complies with but also anticipates the evolving regulatory landscape of the UAE.

Emirates ID

Emirates ID is an identity card issued by the Federal Authority for Identity and Citizenship. 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 for various purposes, including:

  • Getting government services
  • Voting in the elections of the Federal National Council
  • Serving as a travel document for UAE citizens within the Gulf Cooperation Council (GCC)
  • Passing immigration through eGates and smart gates at several airports in the UAE

As of 2021, the population of UAE was approximately 10 million, with an annual growth rate in the range of 1-2%. UAE nationals constitute around 11-12% of the total population.

The physical Emirates ID card contains an electronic chip that stores important information about the resident, including basic details, a photo, biometric information, and fingerprints. Each Emirates ID card has a unique 15-digit number divided into four parts:

  1. The first part represents the UAE international code, which is 784 and is the same on all cards.
  2. The second part usually matches the year of birth but can be different.
  3. The third part consists of seven randomly generated digits.
  4. The fourth part is a one-digit verification number ranging from 0 to 9.

The Emirates ID number is unique to each person and remains the same throughout their lifetime, even if they stop being a UAE resident and later return to obtain residency again.

API Details

Sample cURL

Pre-Production
Production
Curl


API Input

The API expects the following input in the request payload:

JSON


Field

Type

Description

emiratesIdNumber

string

The Emirates ID number that needs to be validated.

dateofBirth

string

The DOB of the Emirates ID number that needs to be validated.

currentNationality

string

The Nationality of the Emirates ID number holder. Note: Please check the table for supported nationalities provided below the API output.

API Output

Success Response & Mapping

200


Field

Description

Data Type

emiratesIdNumber

The Emirates ID number that needs to be validated.

string

dateOfBirth

The DOB of the Emirates ID number that needs to be validated.

string

currentNationality

The Nationality of the Emirates ID number holder.

string

fileStatus

The status of the Emirates ID number holder whether Active or not.

Possible Values: 1) ACTIVE - This indicates that the Emirates ID is active. 2) EXPIRED - This indicates that the Emirates ID has expired. 3) CANCELED - This indicates that the Emirates ID is canceled. ID can be cancelled irrespective of expiry date.

string

fileIssueDate

The date the Emirates ID was issued.

string

fileExpiryDate

The date the Emirates ID will expire.

string

emiratesUnifiedNumber

The Unified Identity Number(UID) in UAE is a unique identification number that is assigned to every resident of the country.

string

fileNumber

The File number associated with the Emirates ID.

string

allowedStayDays

Allowed Stay Days in a country

integer

departureDateCountry

Departure Date

string

fileCancellationDate

File Cancellation Date

string

Supported Nationalities(Input)

Country Name

API Input for Nationality

United Arab Emirates

united_arab_emirates

Bahrain

bahrain

Kuwait

kuwait

Oman

oman

Qatar

qatar

Saudi Arabia

saudi_arabia

Algeria

algeria

Comoros

comoros

Djibouti

djibouti

Egypt

egypt

Iraq

iraq

Jordan

jordan

Lebanon

lebanon

Libya

libya

Mauritania

mauritania

Morocco

morocco

Somalia

somalia

State of Palestine

state_of_palestine

Sudan

sudan

Syrian Arab Republic

syrian_arab_republic

Tunisia

tunisia

Yemen

yemen

Afghanistan

afghanistan

Armenia

armenia

Azerbaijan

azerbaijan

Bangladesh

bangladesh

Bhutan

bhutan

Brunei Darussalam

brunei_darussalam

Cambodia

cambodia

China

china

Democratic People's Republic of Korea

democratic_peoples_republic_of_korea

Georgia

georgia

Hong Kong Special Administrative Region

hong_kong_special_administrative_region

India

india

Indonesia

indonesia

Iran Islamic Republic of

iran_islamic_republic_of

Japan

japan

Kazakhstan

kazakhstan

Kyrgyzstan

kyrgyzstan

Laos People's Democratic Republic

laos_peoples_democratic_republic

Malaysia

malaysia

Maldives

maldives

Mongolia

mongolia

Myanmar

myanmar

Nepal

nepal

Pakistan

pakistan

Philippines

philippines

Republic of Korea

republic_of_korea

Singapore

singapore

Sri Lanka

sri_lanka

Tajikistan

tajikistan

Thailand

thailand

Timor-Leste

timor_leste

Turkey

turkey

Turkmenistan

turkmenistan

Taiwan

taiwan

Uzbekistan

uzbekistan

Viet Nam

viet_nam

Angola

angola

Benin

benin

Botswana

botswana

Burkina Faso

burkina_faso

Burundi

burundi

Cabo Verde

cabo_verde

Cameroon

cameroon

Central African Republic

central_african_republic

Chad

chad

Congo

congo

Cote d'Ivoire

cote_d_ivoire

Democratic Republic of the Congo

democratic_republic_of_the_congo

Equatorial Guinea

equatorial_guinea

Eritrea

eritrea

Ethiopia

ethiopia

Gabon

gabon

Gambia

gambia

Ghana

ghana

Guinea

guinea

Guinea-Bissau

guinea_bissau

Kenya

kenya

Lesotho

lesotho

Liberia

liberia

Madagascar

madagascar

Malawi

malawi

Mali

mali

Mauritius

mauritius

Mozambique

mozambique

Namibia

namibia

Niger

niger

Nigeria

nigeria

Rwanda

rwanda

Saint Helena

saint_helena

Sao Tome and Principe

sao_tome_and_principe

Senegal

senegal

Seychelles

seychelles

Sierra Leone

sierra_leone

South Africa

south_africa

South Sudan

south_sudan

Swaziland

swaziland

Togo

togo

Uganda

uganda

United Republic of Tanzania

united_republic_of_tanzania

Zambia

zambia

Zimbabwe

zimbabwe

Albania

albania

Andorra

andorra

Austria

austria

Belarus

belarus

Belgium

belgium

Bosnia and Herzegovina

bosnia_and_herzegovina

Bulgaria

bulgaria

Croatia

croatia

Cyprus

cyprus

Czech Republic

czech_republic

Denmark

denmark

Estonia

estonia

Finland

finland

France

france

Germany

germany

Greece

greece

Holy See (Vatican)

holy_see_vatican

Hungary

hungary

Iceland

iceland

Ireland

ireland

Italy

italy

Latvia

latvia

Latvia Resident

latvia_resident

Liechtenstein

liechtenstein

Lithuania

lithuania

Luxembourg

luxembourg

Malta

malta

Monaco

monaco

Montenegro

montenegro

Netherlands

netherlands

Norway

norway

Poland

poland

Portugal

portugal

Republic of Macedonia

republic_of_macedonia

Republic of Moldova

republic_of_moldova

Romania

romania

Russian Federation

russian_federation

San Marino

san_marino

Serbia

serbia

Slovakia

slovakia

Slovenia

slovenia

Spain

spain

Sweden

sweden

Switzerland

switzerland

Ukraine

ukraine

United Kingdom (UK)

united_kingdom_uk

Antigua and Barbuda

antigua_and_barbuda

Bahamas

bahamas

Barbados

barbados

Belize

belize

Bermuda

bermuda

Canada

canada

Cayman Islands

cayman_islands

Costa Rica

costa_rica

Cuba

cuba

Commonwealth of Dominica

commonwealth_of_dominica

Dominican Republic

dominican_republic

El Salvador

el_salvador

Greenland

greenland

Grenada

grenada

Guatemala

guatemala

Haiti

haiti

Honduras

honduras

Jamaica

jamaica

Martinique

martinique

Mexico

mexico

Nicaragua

nicaragua

Panama

panama

Puerto Rico

puerto_rico

Saint Kitts and Nevis

saint_kitts_and_nevis

Saint Lucia

saint_lucia

Saint Vincent and the Grenadines

saint_vincent_and_the_grenadines

Trinidad and Tobago

trinidad_and_tobago

United States of America

united_states_of_america

Argentina

argentina

Bolivia

bolivia

Brazil

brazil

Chile

chile

Colombia

colombia

Ecuador

ecuador

French Guiana

french_guiana

Guyana

guyana

Paraguay

paraguay

Peru

peru

Suriname

suriname

Uruguay

uruguay

Venezuela

venezuela

Australia

australia

Fiji

fiji

Kiribati

kiribati

Marshall Islands

marshall_islands

Micronesia Federated States of

micronesia_federated_states_of

Nauru

nauru

New Caledonia

new_caledonia

New Zealand

new_zealand

Northern Mariana Islands

northern_mariana_islands

Palau

palau

Papua New Guinea

papua_new_guinea

Samoa

samoa

Solomon Islands

solomon_islands

Tonga

tonga

Tuvalu

tuvalu

Vanuatu

vanuatu

Israel

israel

Kosovo

kosovo

Macao

macao

Republic of Somaliland

republic_of_somaliland

Error Code Response & Mapping

400 (Bad Request)
400(Nationality Input Error)
400 (Invalid Emirates ID)
409 (Upstream Down)


Field

Type

Description

name

string

Text displayed on the screen explaining error type.

reason

string

Reason for the error.

status

number

HTTP status code.

message

string

Error message indicating an upstream error.

type

string

Error type.

statusCode

number

Status code representing the error scenario.

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!