DOCSCAN API Reference Guide

API Endpoint Access URL
Description
Supported Documents & Countries
HTTP Methods
HTTP Parameters
HTTP Response
Code Samples
Community Contributed Articles
Related PixLab API Endpoints

API Endpoint Access URL

https://api.pixlab.io/docscan

Description

The DOCSCAN API endpoint scan, process and extracts information from virtually all officially issued ID documents including Passports, ID Cards, Driving Licenses, Visas, Birth & Death Certificates from nearly all recognized UN countries ↗. As of this release, over 11,094 ID documents with or without MRZ from more than 197 countries are fully supported. No other KYC platform has achieved such a milestone.

In addition to ID document scanning capabilities, DOCSCAN features an automatic face detection and extraction tool. This feature crops faces from scanned documents and converts binary information such as ID Cards raw images or Passport Machine Readable Zone (MRZ) into JSON-formatted text ready to be consumed by your application. The resulting JSON data includes essential details like full name, issuing country, document number, address, expiry date, etc. prepared for seamless application integration. For practical application, see examples of JSON outputs for processed Passport images or ID card images at the example section below.

Input Passport Specimen (JPEG/PNG/BMP Image)

Extracted ID Holder Information (with automatic face cropping)

DOCSCAN is the sole REST API endpoint located at https://api.pixlab.io/docscan needed to perform ID scanning with automatic face cropping.
As of this release, over 11,094 ID documents with or without MRZ from more than 197 countries are fully supported.
PixLab recommend linking your AWS S3 bucket via the PxLab Console ↗ to ensure that all cropped images and extracted data are directly stored in your bucket, providing complete control over your users data.
Explore various code samples below, with additional examples available on the PixLab Github Repository ↗.
For handling PDF documents, first convert them to raw images using the PDFTOIMG ↗ API Endpoint, and send the returned image link directly to the DOCSCAN API endpoint using a simple GET HTTP Request.
Developers are encouraged to refer to the code samples section & community contributed tutorials section to learn more about integrating DOCSCAN on their existing code bases.

Supported Documents & Countries

DOCSCAN supports a comprehensive range of officially issued ID documents, including but not limited to: Passports, ID Cards (Citizen ID, Resident ID, Immigration Card, Golden ID, etc.), Driving Licenses, Visas, Birth & Death Certificates from nearly all UN-recognized countries. With this release, the API can handle over 11,094 ID documents, with or without Machine Readable Zones (MRZ), from more than 197 countries. Below is a list of supported countries and ID document types:

Afghanistan

Supported Document Types	State
Passport	-
Identity Card	-

Albania

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-

Algeria

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card (2016)	-

American Samoa

Supported Document Types	State
Driver's License	-
Identity Card	-

Andorra

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card (2018)	-

Angola

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-

Anguilla

Supported Document Types	State
Passport	-

Antarctica

Antigua and Barbuda

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-
Identity Card - Social Security Card	-

Argentina

Supported Document Types	State
Passport	-
Driver's License (2010 & 2013)	-
Driver's License	Buenos Aires
Driver's License	Cordoba
Driver's License	La Pampa
Driver's License	Mendoza
Driver's License	Montecarlo
Driver's License	Neuquen
Driver's License	Puerto General San Martín
Driver's License	Rosario
Driver's License	Salta
Driver's License	San Miguel De Tucuman
Identity Card	-

Armenia

Supported Document Types	State
Passport	-
Driver's License (2011)	-
Identity Card	-

Australia

Supported Document Types	State
Passport	-
Driver's License	Australian Capital Territory ACT
Driver's License	New South Wales NSW
Driver's License	Northern Territory NT
Driver's License	Queensland QLD
Driver's License	South Australia SA
Driver's License	Tasmania TAS
Driver's License	Victoria VIC
Driver's License	Western Australia WA
Identity Card - Resident Permit	-
Identity Card	New South Wales NSW
Identity Card	Queensland QLD
Identity Card - Photo Card	Western Australia WA
Other - Marine Licence Indicator	Queensland QLD

Austria

Supported Document Types	State
Passport	-
Driver's License (2014)	-
Identity Card	-
Identity Card - Residence Permit	-

Azerbaijan

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card - Seafarers' Identity Document (2007)	-
Identity Card - Residence Permit	-
Identity Card - Temporary Residence Permit	-
Identity Card	-

Bahamas

Supported Document Types	State
Passport	-
Driver's License	-

Bahrain

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-

Bangladesh

Supported Document Types	State
Passport	-
Driver's License - Smart ID Card (Motor)	-
Driver's License	-
Identity Card - Smart ID Card	-
Identity Card (Old)	-
Other - Digital Registration Certificate	-

Barbados

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-

Belarus

Supported Document Types	State
Passport	-
Driver's License	-

Belgium

Supported Document Types	State
Passport	-
Driver's License	-
Driver's License - Voorlopig Rijbewijs	-
Identity Card - Identity Card, E card	-
Identity Card - Identity Card, Netherlands	-
Identity Card - Identity Card, French (2015)	-
Identity Card (2015)	-
Identity Card - Residence Permit (2013)	-
Identity Card - Identity Card, German (2015)	-
Identity Card - Identity Card, Dutch (2015)	-

Belize

Supported Document Types	State
Passport	-
Driver's License	-
Driver's License	Belmopan City
Identity Card	-
Identity Card - Social Security Card	-

Benin

Supported Document Types	State
Passport	-
Identity Card	-

Bermuda

Supported Document Types	State
Passport	-
Driver's License	-

Bhutan

Supported Document Types	State
Passport	-
Identity Card	-

Bolivia

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-
Identity Card - Foreign Identity Card	-

Bosnia and Herzegovina

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-

Botswana

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-

Bouvet Island

Supported Document Types	State
Passport	-

Brazil

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-
Identity Card - Consular Id Card	-

British Indian Ocean Territory

Supported Document Types	State
Passport	-

Brunei

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card - Identity Cards	-

Bulgaria

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-

Burkina Faso

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-

Burundi

Supported Document Types	State
Passport	-
Driver's License	-

Cambodia

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-
Identity Card - Work Permit Card	-

Cameroon

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-

Canada

Supported Document Types	State
Passport	-
Driver's License	Alberta AB
Driver's License	British Columbia BC
Driver's License - Enhanced Driver's License	British Columbia BC
Driver's License	Manitoba MB
Driver's License	New Brunswick NB
Driver's License	Newfoundland and Labrador NL
Driver's License	Northwest Territories NWT
Driver's License	Nova Scotia NS
Driver's License	Nunavut NU
Driver's License	Ontario ON
Driver's License	Prince Edward Island PE
Driver's License	Quebec QC
Driver's License	Saskatchewan SK
Driver's License	Yukon YT
Identity Card - Residence Permit	-
Identity Card - Indian Status	-
Identity Card	Albert AB
Identity Card	British Columbia BC
Identity Card - Service Card	British Columbia BC
Identity Card	Manitoba MB
Identity Card	New Brunswick NB
Identity Card (m)	Newfoundland and Labrador NS
Identity Card	Northwest Territories NT
Identity Card	Nova Scotia NS
Identity Card	Nunavut NU
Identity Card - Health ID Card	Nunavut NU
Identity Card - Health ID Card	Ontario ON
Identity Card	Ontario ON
Identity Card	Prince Edward Island PE
Identity Card - Health Insurance Card	Quebec QC
Identity Card	Saskatchewan SK
Identity Card	Yukon YT

Cape Verde

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-

Cayman Islands

Supported Document Types	State
Passport	-
Driver's License	-

Central African Republic

Supported Document Types	State
Passport	-
Driver's License	-

Chad

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-

Chile

Supported Document Types	State
Passport	-
Driver's License	-
Driver's License	Santa Maria
Identity Card (2014)	-

China

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card - HK/Macao Travel Permit	-
Identity Card - Taiwan Citizen Entry Card	-
Identity Card	-
Identity Card - Resident Identity Card (2017)	-
Identity Card - Mainland Travel Permit for Hong Kong and Macau Residents	-
Identity Card - People’s Liberation Army	-
Identity Card - Exit Entry Permit for Travelling to and from Hong Kong and Macau	-
Identity Card - Mainland Travel Permit for Taiwan Resident	-
Identity Card - Citizen Identity Card	-
Identity Card - HK/Macao Citizen Entry Card	-

Christmas Island

Supported Document Types	State
Passport	-

Cocos (Keeling) Islands

Supported Document Types	State
Passport	-

Colombia

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-
Identity Card - Consuler Id Card	-
Identity Card - Foreigner ID	-
Identity Card - Special Permit of Permanence	-

Comoros

Supported Document Types	State
Passport	-
Identity Card	-

Congo

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-

Congo, The Democratic Republic

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card - Voter's Card	-

Cook Islands

Costa Rica

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-
Identity Card - Residence Permit	-

Cote D'Ivoire

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-

Croatia

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-
Identity Card - Residence Permit (2016)	-

Cuba

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-

Cyprus

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card (2015)	-
Identity Card - Residence Permit	-

Czech Republic

Supported Document Types	State
Passport	-
Driver's License (2004 & 2013)	-
Identity Card (2012 & 2014)	-
Identity Card - Residence Permit	-

Denmark

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card - Residence Permit (2018)	-

Djibouti

Supported Document Types	State
Passport	-
Driver's License	-

Dominica

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card - Social Security Card	-
Identity Card - Multi-Purpose Identification Card	-

Dominican Republic

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-

East Timor

Supported Document Types	State
Passport	-
Identity Card	-

Ecuador

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-
Identity Card - Consuler Id Card	-

Egypt

Supported Document Types	State
Passport	-
Driver's License	-
Driver's License	\
Identity Card	-
Other - Tax Card	-

El Salvador

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card (2008)	-

Equatorial Guinea

Supported Document Types	State
Passport	-

Eritrea

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-

Estonia

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-
Identity Card - Long-Term Residence Permit	-
Identity Card - Residence Permit	-
Identity Card - Temporary Residence Permit	-

Ethiopia

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-

Falkland Islands

Supported Document Types	State
Passport	-

Faroe Islands

Supported Document Types	State
Passport	-

Fiji Islands

Supported Document Types	State
Passport	-
Driver's License	-

Finland

Supported Document Types	State
Passport	-
Driver's License (1998-2013)	-
Identity Card (2017)	-
Identity Card - Residence Permit (2017)	-
Identity Card - Identity Card, Alaikäisen (2011)	-
Identity Card - Domestic Identity Card (2011)	-

France

Supported Document Types	State
Passport	-
Driver's License (2013)	-
Identity Card	-
Identity Card - Residence Permit (2011)	-

French Guiana

Supported Document Types	State
Passport	-

French Polynesia

Supported Document Types	State
Passport	-
Driver's License	-

French Southern territories

Supported Document Types	State
Passport	-

Gabon

Supported Document Types	State
Passport	-
Identity Card	-

Gambia

Supported Document Types	State
Passport	-

Georgia

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card (2011)	-
Identity Card - Residence Permit	-
Identity Card - Temporary Residence Permit	-

Germany

Supported Document Types	State
Passport	-
Driver's License - DRIVER LICENSE	-
Identity Card (2010)	-
Identity Card - Temporary Identity Card (2004)	-
Identity Card - Residence Permit (2011)	-

Ghana

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-
Identity Card - Health Identity Card	-
Identity Card - Voter's Card	-
Identity Card	ECOWAS ECOWAS

Gibraltar

Supported Document Types	State
Passport	-
Identity Card (2000)	-

Greece

Supported Document Types	State
Passport	-
Driver's License (2009 & 2013)	-
Identity Card - Identity Card for police officers (2010)	-
Identity Card (2005)	-
Identity Card - Residence Permit	-

Greenland

Supported Document Types	State
Passport	-

Grenada

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-

Guadeloupe

Supported Document Types	State
Passport	-

Guam

Supported Document Types	State
Passport	-

Guatemala

Supported Document Types	State
Passport	-
Driver's License (2013)	-
Identity Card (2009)	-
Identity Card - Consuler Id Card	-

Guinea

Supported Document Types	State
Passport	-

Guinea-Bissau

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-

Guyana

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-

Haiti

Supported Document Types	State
Passport	-
Identity Card	-

Heard Island and McDonald Islands

Supported Document Types	State
Passport	-

Holy See (Vatican City State)

Supported Document Types	State
Passport	-

Honduras

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-
Identity Card - Residence Permit	-

Hong Kong

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-
Other - CI	-
Other - Certificate of Incorporation	-
Other - Hong Kong SAR Business Registration	-

Hungary

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card (2016)	-
Identity Card - Residence Permit (2011)	-
Identity Card	-

Iceland

Supported Document Types	State
Passport	-
Driver's License	-

India

Supported Document Types	State
Passport	-
Driver's License (National)	-
Driver's License	Andhra Pradesh AP
Driver's License	Arunachal Pradesh AR
Driver's License	Assam AS
Driver's License	Bihar BR
Driver's License	Chhattisgarh CG
Driver's License	Delhi NCT
Driver's License	Goa GA
Driver's License	Gujarat GJ
Driver's License	Haryana HR
Driver's License	Himachal Pradesh HP
Driver's License	Jammu and Kashmir JAK
Driver's License	Jharkhand JH
Driver's License	Karnataka KA
Driver's License	Kerala KL
Driver's License	Madhya Pradesh MP
Driver's License	Maharashtra MH
Driver's License	Manipur MN
Driver's License	Meghalaya ML
Driver's License	Mizoram MZ
Driver's License	Nagaland NL
Driver's License	Odisha OD
Driver's License	Puducherry
Driver's License	Punjab PB
Driver's License	Rajasthan RJ
Driver's License	Sikkim SK
Driver's License	Tamil Nadu TN
Driver's License	Telangana TS
Driver's License	Tripura TR
Driver's License	Uttarakhand UK
Driver's License	West Bengal WB
Identity Card - Resident Identity Card	-
Identity Card	-
Identity Card - Ayushman Bharat Card	-
Identity Card - Pan Card	-
Identity Card - Elector Photo Identity Card	Election Commission of India
Identity Card - Elector Identity Card	Election Commission of India
Identity Card	Ministry of Home Affairs
Other - Certificate of Registration	Kerala KL
Other - Medical Identity Card	Maharashtra MH

Indonesia

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-

Iran

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-

Iraq

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-
Identity Card - Residence Card	-
Identity Card - Voter Card	-

Ireland

Supported Document Types	State
Passport	-
Driver's License	-
Driver's License - Learner Permit	-
Identity Card - Residence Permit	-
Identity Card - Passport Card	-
Identity Card - Visa Card	-
Identity Card - Certificate of Registration	-
Identity Card - Public Services Card	-

Israel

Supported Document Types	State
Passport	-
Driver's License (2018)	-
Identity Card (2013)	-

Italy

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card (2004)	-
Identity Card - Residence Permit (2013)	-
Identity Card - Health Card-National Service Card	-
Identity Card - European Health Assistance Card	-

Jamaica

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card - Elector Registration ID card	-

Japan

Supported Document Types	State
Passport	-
Driver's License	JP
Identity Card - Residence Card	-

Jordan

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-
Identity Card - Identity Card for the Sons of Jordanian Women	-

Kazakstan

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-
Identity Card - Residence Permit	-

Kenya

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-

Kiribati

Supported Document Types	State
Passport	-

Kuwait

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-

Kyrgyzstan

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-

Laos

Supported Document Types	State
Passport	-
Identity Card	-

Latvia

Supported Document Types	State
Passport	-
Driver's License (2013)	-
Identity Card (2019)	-
Identity Card - Residence Permit	-

Lebanon

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-

Lesotho

Supported Document Types	State
Passport	-

Liberia

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-

Libyan Arab Jamahiriya

Supported Document Types	State
Passport	-
Driver's License	-

Liechtenstein

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-
Identity Card - Residence Permit	-

Lithuania

Supported Document Types	State
Passport	-
Driver's License (2003-2016)	-
Identity Card (2009 & 2012)	-
Identity Card - Residence Permit (2004)	-

Luxembourg

Supported Document Types	State
Passport	-
Driver's License (2013)	-
Identity Card (2004-2013)	-
Identity Card - Residence Permit (2011)	-

Macao

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card (第二代非接觸式智能身份證)	-
Identity Card - Non-resident Worker’s Identification card	-
Other - HTHKH SIM Card	-
Other - Macau SAR Business Registration	-

Macedonia

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-
Identity Card - Residence Permit	-

Madagascar

Supported Document Types	State
Passport	-
Driver's License	-

Malawi

Supported Document Types	State
Passport	-
Driver's License	-

Malaysia

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card (2012)	-
Identity Card - Residence Permit (Permanent)	-
Identity Card - Foreign Student Identification	-

Maldives

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-

Mali

Supported Document Types	State
Passport	-

Malta

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card (2014)	-
Identity Card - Residence Permit	-

Marshall Islands

Martinique

Mauritania

Supported Document Types	State
Passport	-

Mauritius

Supported Document Types	State
Passport	-
Identity Card	-

Mayotte

Mexico

Supported Document Types	State
Passport	-
Driver's License	-
Driver's License	Baja California BC
Driver's License (Loreto)	Baja California Sur BCS
Driver's License	Brugge
Driver's License	Ciudad de México CDMX
Driver's License	Estado de México
Driver's License (2008)	Guanajuato Gto
Driver's License	Guerrero GR
Driver's License	Hidalgo HG
Driver's License	Jalisco JA
Driver's License (2012-2015)	Michoacan MI
Driver's License	Nayarit
Driver's License	Nuevo León NL
Driver's License	Oaxaca OA
Driver's License (2005-2011)	Puebla PU
Driver's License	Queretaro QT
Driver's License	Quintana Roo QR
Driver's License	San Luis Potosi SLP
Driver's License	Sonora SO
Driver's License	Tabasco TB
Driver's License	Tamaulipas TM
Driver's License	Veracruz VE
Driver's License	Yucatan YU
Driver's License	Zacatecas ZA
Identity Card	-
Identity Card - Consular Identity Card (2014)	-
Identity Card - Resident Card	-
Identity Card - Elector Card (2014)	-

Micronesia, Federated States o

Supported Document Types	State
Passport	-

Moldova

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-
Identity Card - Emporary Residence Permit For Stateless (2016)	-
Identity Card - Residence Permit For Aliens	-
Identity Card - Permanent Residence Permit	-
Identity Card - Temporary Residence Permit For Aliens (2016)	-

Monaco

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-
Identity Card - Residence Permit	-

Mongolia

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-

Montserrat

Supported Document Types	State
Passport	-

Morocco

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card (2008)	-

Mozambique

Supported Document Types	State
Passport	-
Identity Card	-

Myanmar

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card - Identity Card for Overseas Worker	-
Identity Card	-

Namibia

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-

Nauru

Supported Document Types	State
Passport	-

Nepal

Supported Document Types	State
Passport	-
Driver's License (Non Professional)	-
Identity Card	-

Netherlands

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card (2014)	-
Identity Card - Residence Permit (2014)	-
Identity Card - Substitute Identity Card (2017)	-

Netherlands Antilles

New Caledonia

New Zealand

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-
Identity Card - Residence Permit	-

Nicaragua

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card - Residence Permit	-
Identity Card	-

Niger

Supported Document Types	State
Passport	-
Identity Card	-

Nigeria

Supported Document Types	State
Passport	-
Driver's License (1995)	-
Identity Card (2003)	-
Identity Card - Residence Permit	-
Identity Card - Voter's Card	-
Identity Card - National Identification Number Slip	-

Niue

Supported Document Types	State
Passport	-

Norfolk Island

Supported Document Types	State
Passport	-

North Korea

Supported Document Types	State
Passport	-

Northern Mariana Islands

Supported Document Types	State
Driver's License	-
Identity Card	-

Norway

Supported Document Types	State
Passport	-
Driver's License (2013 & 2018)	-
Driver's License - FØRARKORT (2007)	-
Driver's License - FØRERKORT (2007)	-
Identity Card - Residence Permit	-
Identity Card - Identity Card for Construction Sector (2008)	-
Identity Card (Military)	-
Identity Card - National Identity Card (2020)	-

Oman

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card (2013)	-
Identity Card - Residence Permit (2013)	-

Pakistan

Supported Document Types	State
Passport	-
Driver's License (2010)	-
Driver's License	Balochistan
Driver's License (2009)	Islamabad
Driver's License	Khyber Pakhtunkhwa
Driver's License	Lahore
Driver's License	Punjab
Driver's License	Sindh
Identity Card - National Identity Card (Domestic)	-
Identity Card - Origin Card	-
Identity Card - National Identity Card	-
Identity Card - National Identity Card (Oversea)	-
Other - Smart Card	Excise and taxation department ETD

Palau

Supported Document Types	State
Passport	-

Palestine

Supported Document Types	State
Passport	-
Driver's License	-
Driver's License	Palestinian National Authority PNA
Identity Card	-

Panama

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-
Identity Card - Residence Permit	-

Papua New Guinea

Supported Document Types	State
Passport	-

Paraguay

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card (2018)	-
Identity Card	Paraguay PY

Peru

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card (2007)	-
Identity Card - Residence Permit	-

Philippines

Supported Document Types	State
Passport	-
Driver's License - Non-Professional Driver Licence (2000)	-
Driver's License - Professional Driver Licence (2016)	-
Driver's License (2017)	-
Driver's License - Student Permit	-
Identity Card - PhilHealth (Digitized)	-
Identity Card - Seafarer’s Identity Card	-
Identity Card - TIN Card	-
Identity Card - Professional Identification Card	-
Identity Card - Voter's ID	-
Identity Card - Unified Multi-Purpose ID	-
Identity Card - ACR I-Card	-
Identity Card - Overseas Filipino Worker e-Card	-
Identity Card - Overseas Filipino Worker ID Card	-
Identity Card - Postal Identity Card (PREMIUM)	-
Identity Card - National ID	-
Identity Card - Social Security Card	-

Pitcairn

Supported Document Types	State
Passport	-

Poland

Supported Document Types	State
Passport	-
Driver's License (2013)	-
Identity Card (2015)	-
Identity Card - Residence Permit (2011)	-

Portugal

Supported Document Types	State
Passport	-
Driver's License (2013)	-
Identity Card (2007 & 2015)	-
Identity Card - Residence Permit (2008)	-

Puerto Rico

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-
Identity Card - Electoral Identification Card	-

Qatar

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card (2011)	-
Identity Card - Residence Permit	-

Reunion

Romania

Supported Document Types	State
Passport	-
Driver's License (2008)	-
Identity Card	-
Identity Card - Residence Permit	-
Identity Card - Residence Permit	Bucuresti

Russian Federation

Supported Document Types	State
Passport	-
Driver's License (2011)	-
Identity Card - Domestic Document of Identity	-

Rwanda

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card - National Identity Card	-

Saint Helena

Supported Document Types	State
Passport	-

Saint Kitts and Nevis

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-

Saint Lucia

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-

Saint Pierre and Miquelon

Saint Vincent and the Grenadin

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card - National Identity Card	-

Samoa

Supported Document Types	State
Passport	-

San Marino

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-

Sao Tome and Principe

Saudi Arabia

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-
Identity Card - Residence Permit	-

Senegal

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-

Serbia

Supported Document Types	State
Passport	-
Driver's License	-
Driver's License	Kosovo
Identity Card (2008)	-
Identity Card	Kosovo

Seychelles

Supported Document Types	State
Passport	-

Sierra Leone

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-

Singapore

Supported Document Types	State
Passport	-
Driver's License (2002)	-
Identity Card	-
Identity Card - Residence Permit	-
Identity Card - Work Permit	-

Slovakia

Supported Document Types	State
Passport	-
Driver's License (2004-2015)	-
Driver's License - Vehicle Registration (2015)	-
Identity Card (2008-2015)	-
Identity Card - Residence Permit (2004)	-
Identity Card - Residence Permit, MRZ (2004)	-

Slovenia

Supported Document Types	State
Passport	-
Driver's License (2013)	-
Identity Card	-
Identity Card - Residence Permit (2011)	-

Solomon Islands

Supported Document Types	State
Passport	-

Somalia

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card (2014)	-

South Africa

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card (2015)	-
Identity Card - Study Permit	-
Identity Card - Corporate Permit	-
Identity Card - Identity Document	-

South Georgia and the South Sa

South Korea

Supported Document Types	State
Passport	-
Driver's License - Driver License	-
Identity Card	KR

Spain

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card (2015)	-
Identity Card - Residence Permit (1997)	-

Sri Lanka

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card - National Identity Card	-

Sudan

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-

Suriname

Supported Document Types	State
Passport	-
Driver's License (2013)	-
Identity Card	-

Svalbard and Jan Mayen

Swaziland

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card - National Identity Card	-

Sweden

Supported Document Types	State
Passport	-
Driver's License - with TRANSPORT (2009 & 2016)	-
Driver's License (2007)	-
Driver's License - with Vägverket (2007)	-
Identity Card - Residence Permit, UPPEHÅLLSTILLSTÅND (2011 & 2012)	-
Identity Card - Residence Permit	-
Identity Card (2012)	-
Identity Card - Residence Permit, UPPEHÅLLSKORT (2012)	-

Switzerland

Supported Document Types	State
Passport	-
Driver's License (2003)	-
Identity Card (2003)	-
Identity Card - Identity Card For The Priviliged (2007)	-
Identity Card - Residence Permit (2008)	-
Identity Card - Residence Permit (2011)	French
Identity Card - Residence Permit (2011)	German
Identity Card - Residence Permit (2011)	Italian

Syria

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-

Taiwan

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card - Residence Permit (APRC)	-
Identity Card	-
Identity Card - Medicare Card	-

Tajikistan

Supported Document Types	State
Passport	-
Driver's License	-

Tanzania

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-
Identity Card - Voter's Card	-

Thailand

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-

Togo

Supported Document Types	State
Passport	-
Driver's License	-

Tokelau

Tonga

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-

Trinidad and Tobago

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-

Tunisia

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card (2008)	-

Turkey

Supported Document Types	State
Passport	-
Driver's License (2016)	-
Identity Card (2016)	-
Identity Card - Residence Permit (2014)	-
Identity Card - Birth Certificate	-
Identity Card - Temporary Protection Identity Card	-
Identity Card - Work Permit	-

Turkmenistan

Supported Document Types	State
Passport	-
Driver's License	-

Turks and Caicos Islands

Supported Document Types	State
Passport	-

Tuvalu

Supported Document Types	State
Passport	-

Uganda

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-

Ukraine

Supported Document Types	State
Passport	-
Driver's License (2016)	-
Identity Card - Passport Card	-
Identity Card - Residence Permit	-

United Arab Emirates

Supported Document Types	State
Passport	-
Driver's License	Abu Dhabi
Driver's License	Ajman
Driver's License	Dubai
Driver's License	Khaimah
Driver's License	Quwain
Driver's License	Sharjah
Identity Card - Resident Identity Card	-
Identity Card - Resident Visa	-
Identity Card	-
Identity Card - eVisa	-
Identity Card - Golden Card	-

United Kingdom

Supported Document Types	State
Passport	-
Driver's License	-
Driver's License - Provisional Driving Licence (2007)	-
Driver's License	England ENG
Driver's License (2007)	Guernsey GSY
Driver's License	Isle of Man IOM
Driver's License	Jersey JSY
Driver's License	Wales WAL
Driver's License - Provisional Driving Licence (1998)	Wales WAL
Identity Card - Certificate of Entitlement (2010)	-
Identity Card - Identity Card (No longer valid since 2011)	-
Identity Card - Residence Permit (2010 & 2015)	-
Identity Card - Residence Documentation (w/o renewal date) (2010)	-
Identity Card - Residence Documentation (2012)	-

United States

Supported Document Types	State
Passport	-
Driver's License - Driver Licence	-
Driver's License	-
Driver's License (2010)	Alabama AL
Driver's License - Commercial Learner's Permit (2010)	Alabama AL
Driver's License - Under 21 (2010)	Alabama AL
Driver's License (2014)	Alaska AK
Driver's License - Alcohol-Restricted Identity Card (2014)	Alaska AK
Driver's License - Identity Card, Under 21 (2014)	Alaska AK
Driver's License (2014)	Arizona AZ
Driver's License - Under 21 (2014)	Arizona AZ
Driver's License - Under 18 (Graduated) (2014)	Arizona AZ
Driver's License (2018)	Arkansas AR
Driver's License - Under 21 (2018)	Arkansas AR
Driver's License - Intermediate Driver's License, Under 21 (2018)	Arkansas AR
Driver's License - Commercial Driver's License (2016)	Arkansas AR
Driver's License (2010)	California CA
Driver's License - Under 21 (FEDERAL LIMITS APPLY)	California CA
Driver's License (2014)	Colorado CO
Driver's License - Under 21 (2016)	Colorado CO
Driver's License - Commercial Driver License (2016)	Colorado CO
Driver's License (2011)	Connecticut CT
Driver's License - Under 21 (2017)	Connecticut CT
Driver's License - Commercial Driver License (2017)	Connecticut CT
Driver's License - Adult Learner Permit (2017)	Connecticut CT
Driver's License (2018)	Delaware DE
Driver's License - Under 21 (2018)	Delaware DE
Driver's License (2013)	Florida FL
Driver's License - Under 21 (2017)	Florida FL
Driver's License (2010 & 2012)	Georgia GA
Driver's License - Under 21 (2019)	Georgia GA
Driver's License	Guam GU
Driver's License (2010 & 2015)	Hawaii HI
Driver's License - Under 21 (2010 & 2015)	Hawaii HI
Driver's License - Limited Purpose Driver License (2010 & 2015)	Hawaii HI
Driver's License - Commercial Driver License (2016 & 2018)	Idaho ID
Driver's License (2016 & 2018)	Idaho ID
Driver's License - Under 21	Idaho ID
Driver's License (2016)	Illinois IL
Driver's License - Under 21 (2016)	Illinois IL
Driver's License (2007 & 2010)	Indiana IN
Driver's License - Under21 (2019)	Indiana IN
Driver's License - Under 21 (2007 & 2010)	Indiana IN
Driver's License (2010)	Iowa IA
Driver's License - Under 21 (2010)	Iowa IA
Driver's License - Commercial Driver License (2016)	Iowa IA
Driver's License - Instruction Permit (2016)	Iowa IA
Driver's License (2017)	Kansas KS
Driver's License - Under 21 (2017)	Kansas KS
Driver's License (2012 & 2004)	Kentucky KY
Driver's License - Under 21 (2012 & 2004)	Kentucky KY
Driver's License (2015)	Louisiana LA
Driver's License - Under 21 (2015)	Louisiana LA
Driver's License - Chauffeur's License (2015)	Louisiana LA
Driver's License - Commercial License (2015)	Louisiana LA
Driver's License (2011)	Maine ME
Driver's License - Under 21 (2011)	Maine ME
Driver's License (2016)	Maryland MD
Driver's License - Under 21 (2016)	Maryland MD
Driver's License (2016)	Massachusetts MA
Driver's License - Under 21 (2010 & 2016)	Massachusetts MA
Driver's License (2011 & 2017)	Michigan MI
Driver's License - Under 21 (2011 & 2017)	Michigan MI
Driver's License (2014)	Minnesota MN
Driver's License - Under 21 (2018)	Minnesota MN
Driver's License - Commercial Driver License (2018)	Minnesota MN
Driver's License - Enhanced Driver License (2018)	Minnesota MN
Driver's License - Enhanced Commercial Driver License (2018)	Minnesota MN
Driver's License (2016)	Mississippi MS
Driver's License - Under 21 (2001)	Mississippi MS
Driver's License - Commercial Driver License (2016)	Mississippi MS
Driver's License - Commercial License (2001)	Mississippi MS
Driver's License (2012)	Missouri MO
Driver's License - Under 21 (2012)	Missouri MO
Driver's License (2016)	Montana MT
Driver's License - Under 21 (2016)	Montana MT
Driver's License - Commercial License (2016)	Montana MT
Driver's License - Operators License (2013 & 2017)	Nebraska NE
Driver's License - Commercial Driver License (2013 & 2017)	Nebraska NE
Driver's License - Commercial Learner Permit (2013 & 2017)	Nebraska NE
Driver's License - Provisional Operators Permit, Under 21 (2013 & 2017)	Nebraska NE
Driver's License (2013 & 2017)	Nebraska NE
Driver's License - Under 21 (2013 & 2017)	Nebraska NE
Driver's License (2008 & 2010)	Nevada NV
Driver's License - Under 21 (2008 & 2010)	Nevada NV
Driver's License - Commercial Driver License (2008 & 2010)	Nevada NV
Driver's License - Driver Authorization Card (2008 & 2010)	Nevada NV
Driver's License - Instruction Permit (2008 & 2010)	Nevada NV
Driver's License - Limited-Term Driver License (2008 & 2010)	Nevada NV
Driver's License (2017)	New Hampshire NH
Driver's License - Driver License, Under 21 (2017)	New Hampshire NH
Driver's License (2011)	New Jersey NJ
Driver's License - Under 21 (2011)	New Jersey NJ
Driver's License (2007 & 2016)	New Mexico NM
Driver's License - Under 21 (2007 & 2016)	New Mexico NM
Driver's License - Driving Authorization Card	New Mexico NM
Driver's License (2008)	New York State NY
Driver's License - Learner Permit (2017)	New York State NY
Driver's License - Learner Permit, Under 21 (2017)	New York State NY
Driver's License - Under 21 (2017)	New York State NY
Driver's License - NOT Federal, Under 21 (2017)	New York State NY
Driver's License - Learner Permit, NOT Federal, Under 21 (2017)	New York State NY
Driver's License - NOT FEDERAL (2017)	New York State NY
Driver's License (2015 & 2017)	North Carolina NC
Driver's License - Under 21 (2015 & 2017)	North Carolina NC
Driver's License (2006)	North Dakota ND
Driver's License - Under 21 (2018)	North Dakota ND
Driver's License (2015)	Ohio OH
Driver's License - Under 21 (2018)	Ohio OH
Driver's License (2003)	Oklahoma OK
Driver's License - Under 21 (2012)	Oklahoma OK
Driver's License - Commercial Driver License (2012)	Oklahoma OK
Driver's License (2007)	Oregon OR
Driver's License - Under 21 (2018)	Oregon OR
Driver's License (2017)	Pennsylvania PA
Driver's License - Under 21 (2017)	Pennsylvania PA
Driver's License - Under 18 (2017)	Pennsylvania PA
Driver's License	Rhode Island RI
Driver's License - Commercial Driver License	Rhode Island RI
Driver's License (2010)	South Carolina SC
Driver's License - Under 21 (2018)	South Carolina SC
Driver's License	South Dakota SD
Driver's License (2011 & 2012)	Tennessee TN
Driver's License - Under 21 (2011 & 2012)	Tennessee TN
Driver's License (2009)	Texas TX
Driver's License - Under 21 (2020)	Texas TX
Driver's License (2006)	Utah UT
Driver's License - Under 21 (2016)	Utah UT
Driver's License	Vermont VT
Driver's License - Under 21 (2019)	Vermont VT
Driver's License (2018)	Virginia VA
Driver's License - Under 21 (2018)	Virginia VA
Driver's License (2018)	Washington WA
Driver's License - Under 21 (2018)	Washington WA
Driver's License (2017)	Washington DC DC
Driver's License (2011)	West Virginia WV
Driver's License - Under 21 (2011)	West Virginia WV
Driver's License (2015)	Wisconsin WI
Driver's License - Under 21 (2015)	Wisconsin WI
Driver's License - Probationary/Commercial Driver License (2015)	Wisconsin WI
Driver's License	Wyoming WY
Driver's License - Under 21	Wyoming WY
Identity Card - Employment Authorization	-
Identity Card - Permanent Resident	-
Identity Card - Passport Card	-
Identity Card - Border Crossing Card	-
Identity Card - Trust Traveler Card	-
Identity Card - Military ID Card	-
Identity Card - DIplomatic ID card	-
Identity Card - Geneva Conventions Identification Card	-
Identity Card - Official ID Card	-
Identity Card - Travel Document	-
Identity Card	-
Identity Card - Uniformed Services	-
Identity Card - visa (2009)	-
Identity Card - Veteran Health Identity Card	-
Identity Card - Transport Working Identification (2007, 2018)	-
Identity Card (2010)	Alabama AL
Identity Card - Identity Card, Under 21 (2010)	Alabama AL
Identity Card (2003)	Alaska AK
Identity Card - Identity Card, Under 21 (2018)	Alaska AK
Identity Card (2001)	Arizona AZ
Identity Card - Identity Card, Under 21 (2014)	Arizona AZ
Identity Card (2016)	Arkansas AR
Identity Card - Identity Card, Under 21 (2018)	Arkansas AR
Identity Card	California CA
Identity Card - Identity Card, Under 21	California CA
Identity Card (2014)	Colorado CO
Identity Card - Identity Card, Under 21 (2016)	Colorado CO
Identity Card (2011)	Connecticut CT
Identity Card - Identity Card, Under 21 (2017)	Connecticut CT
Identity Card (2010)	Delaware DE
Identity Card - Identity Card, Under 21 (2018)	Delaware DE
Identity Card (2017)	Florida FL
Identity Card - Identity Card, Under 21 (2017)	Florida FL
Identity Card (2010 & 2012)	Georgia GA
Identity Card - Identity Card, Under 21 (2010 & 2012)	Georgia GA
Identity Card	Guam GU
Identity Card	Hawaii HI
Identity Card - Identity Card, Under 21	Hawaii HI
Identity Card	Idaho ID
Identity Card - Identity Card, Under 21	Idaho ID
Identity Card (2007)	Illinois IL
Identity Card - Firearms Owner's Identification Card	Illinois IL
Identity Card - Identity Card, Under 21	Illinois IL
Identity Card (2007 & 2010)	Indiana IN
Identity Card - Identity Card, Under 21 (2007 & 2010)	Indiana IN
Identity Card - Identity Card, Under21 (2019)	Indiana IN
Identity Card (2010 & 2016)	Iowa IA
Identity Card - Identity Card, Under 21 (2010 & 2016)	Iowa IA
Identity Card (2012)	Kansas KS
Identity Card (2004 & 2012)	Kentucky KY
Identity Card - Identity Card, Under 21 (2004 & 2012)	Kentucky KY
Identity Card (2013)	Louisiana LA
Identity Card (1999)	Maine ME
Identity Card - Identity Card, Under 21 (2011)	Maine ME
Identity Card (2002)	Maryland MD
Identity Card - Identity Card, Under 21 (2016)	Maryland MD
Identity Card (2016)	Massachusetts MA
Identity Card - Liquor ID Card (2010 & 2016)	Massachusetts MA
Identity Card - Identity Card, Under 21 (2016)	Massachusetts MA
Identity Card (2011 & 2017)	Michigan MI
Identity Card - Identity Card, Under 21 (2011 & 2017)	Michigan MI
Identity Card (2004)	Minnesota MN
Identity Card - Identity Card, Under21 (2018)	Minnesota MN
Identity Card (2001)	Mississippi MS
Identity Card - Identity Card, Under 21 (2001)	Mississippi MS
Identity Card (2012)	Missouri MO
Identity Card - Identity Card, Under 21 (2012)	Missouri MO
Identity Card (2008)	Montana MT
Identity Card - Identity Card, Under 21 (2016)	Montana MT
Identity Card (2013 & 2017)	Nebraska NE
Identity Card - Identity Card, Under 21 (2013 & 2017)	Nebraska NE
Identity Card (2008 & 2010)	Nevada NV
Identity Card - Identity Card, Under21 (2008 & 2010)	Nevada NV
Identity Card - Seasonal Resident ID (2008 & 2010)	Nevada NV
Identity Card (2017)	New hampshire NH
Identity Card - Identity Card, Under 21 (2017)	New hampshire NH
Identity Card (2011)	New Jersey NJ
Identity Card - Identity Card, Under 21 (2011)	New Jersey NJ
Identity Card (2007 & 2016)	New Mexico NM
Identity Card	New York City NYC
Identity Card (2017)	New York State NY
Identity Card - Common Identification Benefit Card (2016)	New York State NY
Identity Card - Identity Card, Under 21 (2017)	New York State NY
Identity Card - Identity Card, NOT Federal, Under 21 (2017)	New York State NY
Identity Card	North Carolina NC
Identity Card - Identity Card, Under 21	North Carolina NC
Identity Card (2006)	North Dakota ND
Identity Card - Identity Card, Under 21 (2018)	North Dakota ND
Identity Card (2018)	Ohio OH
Identity Card - Identity Card, Under 21 (2018)	Ohio OH
Identity Card (2012)	Oklahoma OK
Identity Card - Muscogee (Creek) Nation Citizenship Card	Oklahoma OK
Identity Card - Identity Card, Under 21 (2012)	Oklahoma OK
Identity Card (2007)	Oregon OR
Identity Card - Identity Card, Under 21 (2007)	Oregon OR
Identity Card (2017)	Pennsylvania PA
Identity Card - Identity Card, Under 21 (2017)	Pennsylvania PA
Identity Card - Medical Marijuana Identity Card	Pennsylvania PA
Identity Card	Rhode Island RL
Identity Card - Identity Card, Under 21	Rhode Island RL
Identity Card (2010)	South Carolina SC
Identity Card - Identity Card, Under 21 (2010)	South Carolina SC
Identity Card	South Dakota SD
Identity Card - Identity Card, Under 21	South Dakota SD
Identity Card (2012)	Tennessee TN
Identity Card (2009)	Texas TX
Identity Card - Identity Card, Under 21 (2020)	Texas TX
Identity Card	Utah UT
Identity Card	Vermont VT
Identity Card (2009 & 2018)	Virginia VA
Identity Card - Identity Card, Under 21 (2009 & 2018)	Virginia VA
Identity Card (2018)	Washington WA
Identity Card - Identity Card, Under 21 (2018)	Washington WA
Identity Card (2013)	Washington DC DC
Identity Card	West Virginia WV
Identity Card - Identity Card, Under 21 (2011)	West Virginia WV
Identity Card (2015)	Wisconsin WI
Identity Card - Identity Card, Under 21 (2015)	Wisconsin WI
Identity Card	Wyoming WY
Other - Social Security Card	-

United States Minor Outlying Islands

Supported Document Types	State
Passport	-

Uruguay

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card (2015)	-
Identity Card - Consuler Card	-

Uzbekistan

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-

Vanuatu

Supported Document Types	State
Passport	-
Driver's License	-

Venezuela

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-

Vietnam

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-
Identity Card - Temporary Resident Card	-

Virgin Islands, British

Supported Document Types	State
Passport	-
Driver's License	-

Virgin Islands, U.S.

Supported Document Types	State
Driver's License	-
Identity Card	-

Wallis and Futuna

Supported Document Types	State
Passport	-

Western Sahara

Supported Document Types	State
Passport	-

Yemen

Supported Document Types	State
Passport	-
Driver's License	-

Yugoslavia

Supported Document Types	State
Passport	-

Zambia

Supported Document Types	State
Passport	-
Driver's License	-
Identity Card	-
Identity Card - Residence Permit	-

Zimbabwe

Supported Document Types	State
Passport	-
Driver's License - Driving Certificate	-
Driver's License	-
Identity Card - National Registration	-

HTTP METHODS

GET, POST Request Body ↓

HTTP PARAMETERS

Mandatory Parameters

Fields	Type	Description
`img`	URL	Input image URL (i.e. ID document to be scanned) if a simple HTTP `GET` method where your media file is already hosted and accessible via URL is being used instead of a more complete `POST` upload request. If you want to upload your image directly from your application or scripts, then submit a `multipart/form-data` POST request. Refer to the `POST` request body section, the code sample section here, with additional examples available on the PixLab Github Repository ↗ on how to upload your ID document image directly from your application using the `POST` method for faster processing. If you are mainly dealing with PDF documents, we recommend that you convert them first to raw images using the PDFTOIMG ↗ API Endpoint.
`key`	Hex String	Your PixLab API Key ↗. Your API Key ↗ is mandatory in order to authenticate the upcoming request. You can also embed your API Key in the `WWW-Authenticate` HTTP header and omit this parameter if you want to. Connect to the PixLab Console ↗ to generate your first API key.

Optional Parameters

Fields	Type	Description
`type`	String	Type of document going to be scanned if known in advance. As of this release, over 11,094 ID documents with or without MRZ from more than 197 countries are fully supported. The following are the allowed document types strings: `passport`: Any type of officially issued Machine Readable Document such as Passports or Travel Documents as stated in the ICAO Document 9303 ↗. `idcard`: Any type of *officialy issued government ID card with or without MRZ including but not limited to: Citizen Card ID, Resident ID, Immigration Card, etc.* from one of the supported countries. `driver_license`: Any type of officilaly issued Driver License with or without MRZ from one of the supported countries. `visa`: Machine-Readable issued Visa (ICAO Document 9303 ↗ part 7). `birth_certificate`: Any type of officilaly issued Birth Cerificate from one of the supported countries. `death_certificate`: Any type of officilaly issued Death Cerificate from one of the supported countries. `unknown`: Set the value to `unknown` if you are unsure about the type of the ID document being scanned. DOCSCAN is smart enough to isolate the type of the ID using a heurestic approach with the help of Machine Learning. Please note that this feature is only available starting from the Team or Enterprise Plan ↗ due to the heay compute resources it require.
`country`	String	Country of origin of the ID document being scanned. You can omit this field for Passports or ICAO Travel documents, or if the country of origin of the document being scanned is unknown in advance (feature only available starting from the Team or Enterprise Plan ↗). As of this release, over 11,094 ID documents with or without MRZ from more than 197 countries are fully supported. The list of supported countries and documents is documneted here.

POST Request Body Guidelines(for using POST over GET)

Allowed Content-Types:

multipart/form-data - Use this for direct (local) media file uploads. Refer to this Python script ↗ for a typical implementation.
application/json - Use this when your media file is already hosted and accessible via URL.

Example Showcase: The screen capture below illustrates a typical local image upload using a multipart/form-data POST request made via Postman:

Code samples demonstrating how to perform a POST upload request in your preferred programming language can be found in the section below, or on the PixLab Github Repository ↗.

HTTP RESPONSE

application/json: The DOCSCAN API endpoints always return a JSON object for each request, regardless of whether it was executed successfully. The table below lists the fields returned in a typical HTTP response:

Field	Type	Description
`status`	Integer	HTTP status code where 200 indicates success. Any other code indicates an error.
`type`	String	Type of the scanned document.
`face_url`	URL	URL to the cropped image of the face from the document. PixLab recommend that you store extracted images directly on your own AWS S3 Bucket by linking it via the PixLab Console ↗ for complete control of users data.
`mrz_raw_text`	String	Extracted raw MRZ text from the document (applicable for Passports and Visas only).
`fields`	Object	Depending on the type of the document being scanned (Passport, Driver License, ID Card, etc.), a JSON Object with the following fields is always returned: `fullName`: The full name of the ID holder as scanned from the uploaded ID document. `issuingCountry`: The country or organization that issued the document. `documentNumber`: The unique number assigned to the document by the issuing authority. `address`: The address of the ID holder as listed on the ID, if available. `dateOfBirth`: The birth date of the ID holder, typically in YYYY-MM-DD format. `dateOfExpiry`: The expiration date of the document, typically in YYYY-MM-DD format. `sex`: The gender of the ID holder (if available), usually represented as 'M' for male, 'F' for female, or 'O' for other. `nationality`: The nationality of the ID holder, often coded in full country name or ISO 3166-1 alpha-3 format. `issuingDate`: The date the document was issued, typically in YYYY-MM-DD format. `checkDigit`: A checksum digit available on Passport document only calculated from other data within the document to verify its authenticity. `personalNumber`: An optional unique number assigned to the holder by the issuing authority. `finalCheckDigit`: An optional final checksum digit calculated from all the data on the document to ensure its integrity. `issuingState`: The state or region that issued the document, if applicable. `issuingStateCode`: A code representing the state or region that issued the document, if applicable. `religion`: The religion of the ID holder, if it is included on the document.
`error`	String	Error message, present if the status field is different from 200.

Code Samples

Explore a range of production-ready code samples for practical use cases, available for download and experimentation at the PixLab Github Repository ↗. If you need to familiarize yourself with the DOCSCAN API endpoint before starting, refer to the documentation above ↑.

Community Contributed Articles

Explore the comprehensive guides and tutorials below, contributed by the community, to integrate DOCSCAN into your existing code base using your preferred framework and programming language:

Related PixLab API Endpoints ↗

FACEDETECT • CROP • PDF2IMG • OCR • NSFW • MOGRIFY • BLUR