8.5.1
Web
Speed up ID Capture integration with Agent Skills
Install the official skill to help your coding agent (Claude Code, Codex, Cursor, etc.) integrate, debug, and customize ID Capture on Web following Scandit's recommended patterns. More info →
Run this in a terminal in your project directory, then follow the instructions to select your coding agent.
npx skills add https://github.com/scandit/skills --skill id-capture-webYour coding agent loads the skill automatically based on your prompt; to invoke it explicitly, call /id-capture-web followed by your task.
Already installed? Update steps differ by agent — see how to keep your skills up to date.
ID Scanning Supported Documents
Scandit ID Capture provides various IdCaptureScanner types, each designed for specific scanning workflows. These workflows can involve scanning either specific parts of a document or the entire document, including both the front and back sides. This section details the types of documents supported by each scanner type.
Full Document Scanner
This scanner combines data extraction from all supported parts of the document and merges the data from barcodes, human-readable text, and machine-readable text into one result.
- For card-format documents, data is extracted from the front & the back side of the document.
- For booklet-format documents (e.g. passports), data is extracted from the main information page.
Asia
| Country | Supported Documents |
|---|---|
| Afghanistan | ID Card |
| Armenia | ID Card, Passport, Paper Passport, Work Permit |
| Azerbaijan | ID Card |
| Bangladesh | ID Card, Passport, Polycarbonate Passport |
| Brunei | ID Card |
| Cambodia | ID Card, Passport |
| China | Passport, Exit Entry Permit |
| Hong Kong | ID Card |
| India | Passport, PAN Card, Voter ID |
| India Andhra Pradesh | Driver’s License |
| India Gujarat | Driver’s License |
| India Haryana | Driver’s License |
| India Karnataka | Driver’s License |
| India Kerala | Driver’s License |
| India Madhya Pradesh | Driver’s License |
| India Maharashtra | Driver’s License |
| India Tamil Nadu | Driver’s License |
| Indonesia | Driver’s License, ID Card, Passport, Polycarbonate Passport |
| Japan | Passport, My Number Card |
| Kazakhstan | Passport |
| Kyrgyzstan | ID Card, Passport, Polycarbonate Passport |
| Malaysia | Driver’s License, Passport, MyKAS, MyKad, MyKid, MyPR, MyTentera, Refugee ID, i-Kad, MyPolis |
| Maldives | ID Card |
| Myanmar | Driver’s License, Passport |
| Nepal | Passport |
| Pakistan | ID Card, Passport, Consular ID, Proof of Registration, Polycarbonate Passport |
| Pakistan Punjab | Driver’s License |
| Philippines | Driver’s License, ID Card, Passport, Multipurpose ID, Professional ID, Social Security Card |
| Singapore | Driver’s License, ID Card, Passport, Employment Pass, Fin Card, Resident ID, S Pass, Work Permit |
| South Korea | Polycarbonate Passport |
| Sri Lanka | Driver’s License, ID Card, Passport |
| Tajikistan | ID Card |
| Thailand | ID Card, Passport, Alien ID, Polycarbonate Passport |
| Turkmenistan | Passport, Polycarbonate Passport |
| Uzbekistan | ID Card, Passport, Driver’s License |
Europe
| Country | Supported Documents |
|---|---|
| Europe | Health Insurance Card |
| Albania | Driver’s License, ID Card, Passport, Driver Card, Professional Driver License |
| Austria | Driver’s License, ID Card, Passport, Paper Passport, Polycarbonate Passport, Refugee Passport, Polycarbonate Refugee Passport |
| Belarus | Driver’s License, ID Card, Passport, Polycarbonate Passport, Paper Passport |
| Belgium | Driver’s License, ID Card, Passport, Residence Permit, Minors ID, Resident ID, Provisional Driving License, Special ID, Paper Passport |
| Bosnia And Herzegovina | Driver’s License, ID Card (incl. Cyrillic script), Passport |
| Bulgaria | Driver’s License (incl. Cyrillic script), ID Card (incl. Cyrillic script), Passport, Alien ID, Residence Permit, Paper Passport |
| Croatia | Driver’s License, ID Card, Passport, Residence Permit |
| Cyprus | Driver’s License, ID Card, Passport, Residence Permit |
| Czechia | Driver’s License, ID Card, Passport, Residence Permit |
| Denmark | Driver’s License, Passport, Polycarbonate Passport |
| Estonia | Driver’s License, ID Card, Passport, Polycarbonate Passport, Paper Passport |
| Finland | Driver’s License, ID Card, Passport, Residence Permit, Alien ID, Polycarbonate Passport |
| France | Driver’s License, ID Card, Professional ID, Paper Passport |
| Georgia | Driver’s License, ID Card, Paper Passport |
| Germany | Driver’s License, ID Card, Passport, Residence Permit, eID, Driver Qualification Card, Paper Passport |
| Greece | Driver’s License, ID Card, Passport, Residence Permit, Polycarbonate Passport, Paper Passport |
| Hungary | Driver’s License, ID Card, Passport, Paper Passport |
| Ireland | Driver’s License, Passport, Passport Card, Public Services Card, Polycarbonate Passport |
| Italy | Driver’s License, ID Card, Residence Permit, Paper Passport |
| Kosovo | Driver’s License, ID Card, Passport, Paper Passport |
| Latvia | Driver’s License, ID Card, Passport, Alien ID, Polycarbonate Passport, Polycarbonate Alien Passport |
| Liechtenstein | ID Card, Driver’s License |
| Lithuania | Driver’s License, ID Card, Passport, Residence Permit |
| Luxembourg | Driver’s License, ID Card, Passport, Residence Permit |
| Malta | Driver’s License, ID Card, Residence Permit, Paper Passport, Polycarbonate Passport |
| Moldova | Passport, Driver’s License, ID Card, Polycarbonate Passport, Paper Passport |
| Montenegro | Driver’s License, ID Card (incl. Cyrillic script), Passport |
| Netherlands | Driver’s License, ID Card, Passport, Residence Permit, Alien ID, Polycarbonate Passport |
| North Macedonia | Driver’s License (incl. Cyrillic script), ID Card (incl. Cyrillic script), Passport, Polycarbonate Passport |
| Norway | Driver’s License, ID Card, Passport, Residence Permit, Polycarbonate Passport |
| Poland | Driver’s License, ID Card, Passport, Polycarbonate Passport, Paper Passport |
| Portugal | Driver’s License, ID Card, Passport, Paper Passport |
| Romania | Driver’s License, ID Card, Passport, Residence Permit |
| Russia | Driver’s License, Passport |
| Serbia | Driver’s License, ID Card (incl. Cyrillic script), Passport |
| Slovakia | Driver’s License, ID Card, Passport, Residence Permit, Polycarbonate Passport |
| Slovenia | Driver’s License, ID Card, Passport, Residence Permit |
| Spain | Driver’s License, ID Card, Passport, Residence Permit, Alien ID, Paper Passport |
| Sweden | Driver’s License, ID Card, Passport, Residence Permit, SIS ID, Social Security Card, Polycarbonate Refugee Passport |
| Switzerland | Driver’s License, ID Card, Passport, Residence Permit, Polycarbonate Passport, Paper Passport |
| UK | Driver’s License, Passport, Residence Permit, Proof of Age Card, Military ID, Asylum Request, Paper Passport |
| Ukraine | Driver’s License (incl. Cyrillic script), ID Card (incl. Cyrillic script), Passport, Residence Permit (incl. Cyrillic script) |
Central and South America
| Country | Supported Documents |
|---|---|
| Argentina | ID Card, Passport, Alien ID, Paper Passport |
| Bahamas | Driver’s License, Residence Permit, Work Permit, Paper Passport, Polycarbonate Passport, Temporary Residence Permit |
| Bolivia | Driver’s License, ID Card, Passport, Minors ID, Paper Passport |
| Brazil | Driver’s License, Alien ID |
| Brazil Ceara | ID Card |
| Brazil Distrito Federal | ID Card |
| Brazil Goias | ID Card |
| Brazil Maranhao | ID Card |
| Brazil Mato Grosso | ID Card |
| Brazil Minas Gerais | ID Card |
| Brazil Para | ID Card |
| Brazil Parana | ID Card |
| Brazil Pernambuco | ID Card |
| Brazil Rio De Janeiro | ID Card |
| Brazil Santa Catarina | ID Card |
| Brazil Sao Paolo | ID Card |
| Brazil Sergipe | ID Card |
| Chile | Driver’s License, ID Card, Passport, Alien ID, Paper Passport |
| Colombia | Driver’s License, ID Card, Passport, Alien ID, Minors ID, Temporary Protection Permit |
| Costa Rica | ID Card, Passport, Paper Passport, Polycarbonate Passport, Residence Permit |
| Cuba | Passport |
| Dominican Republic | ID Card, Passport, Non Voter ID |
| Ecuador | Driver’s License, ID Card, Passport |
| El Salvador | ID Card, Driver’s License |
| Guatemala | Driver’s License, ID Card, Passport, Alien ID, Consular ID, Paper Passport |
| Guyana | ID Card |
| Haiti | Driver’s License, ID Card, Passport, Paper Passport |
| Honduras | Paper Passport |
| Jamaica | Driver’s License, Passport, Voter ID |
| Mexico | Passport, Consular Voter ID, Voter ID, Consular ID, Residence Permit |
| Mexico Aguascalientes | Driver’s License |
| Mexico Baja California | Driver’s License |
| Mexico Chiapas | Driver’s License |
| Mexico Chihuahua | Driver’s License |
| Mexico Ciudad De Mexico | Driver’s License |
| Mexico Coahuila | Driver’s License |
| Mexico Colima | Driver’s License |
| Mexico Durango | Driver’s License |
| Mexico Guanajuato | Driver’s License |
| Mexico Hidalgo | Driver’s License |
| Mexico Jalisco | Driver’s License |
| Mexico Mexico | Driver’s License |
| Mexico Michoacan | Driver’s License |
| Mexico Morelos | Driver’s License |
| Mexico Nayarit | Driver’s License |
| Mexico Nuevo Leon | Driver’s License |
| Mexico Oaxaca | Driver’s License |
| Mexico Quintana Roo | Driver’s License |
| Mexico Quintana Roo Solidaridad | Driver’s License |
| Mexico Quintana Roo, Benito Juarez | Driver’s License |
| Mexico Quintana Roo-Cozumel | Driver’s License |
| Mexico San Luis Potosi | Driver’s License |
| Mexico Sinaloa | Driver’s License |
| Mexico Sonora | Driver’s License |
| Mexico Tabasco | Driver’s License |
| Mexico Tamaulipas | Driver’s License |
| Mexico Tlaxcala | Driver’s License |
| Mexico Veracruz | Driver’s License |
| Mexico Yucatan | Driver’s License |
| Mexico Zacatecas | Driver’s License |
| Nicaragua | ID Card, Paper Passport |
| Panama | Driver’s License, ID Card, Passport, Residence Permit |
| Paraguay | Driver’s License, ID Card, Paper Passport |
| Peru | Driver’s License, ID Card, Passport, Minors ID |
| Puerto Rico | Driver’s License |
| Saint Kitts And Nevis | Driver’s License |
| Trinidad And Tobago | Driver’s License, ID Card, Passport |
| Uruguay | ID Card, Paper Passport |
| Venezuela | Driver’s License, ID Card, Passport |
Middle East and Africa
| Country | Supported Documents |
|---|---|
| Algeria | Driver’s License, ID Card, Passport, Paper Passport |
| Bahrain | ID Card (incl. Arabic script), Driver’s License, Paper Passport |
| Benin | ID Card |
| Botswana | ID Card |
| Burkina Faso | ID Card, Driver's License, Paper Passport |
| Cameroon | ID Card, Passport, Polycarbonate Passport |
| Comoros | Passport, Paper Passport |
| Democratic Republic of the Congo | Voter ID |
| Egypt | ID Card (incl. Arabic script), Driver’s License |
| Eswatini | Passport |
| Gambia | ID Card, Paper Passport |
| Ghana | Driver’s License, ID Card, Passport |
| Guinea | ID Card, Polycarbonate Passport |
| Iran | Paper Passport |
| Iraq | Passport, Polycarbonate Passport |
| Israel | Driver’s License, Paper Passport |
| Ivory Coast | Driver’s License, ID Card |
| Jordan | ID Card (incl. Arabic script), Paper Passport |
| Kenya | ID Card, Passport, Driver’s License |
| Kuwait | Driver’s License, ID Card (incl. Arabic script), Resident ID (incl. Arabic script), Paper Passport |
| Lebanon | Driver’s License, ID Card (incl. Arabic script), Paper Passport |
| Liberia | ID Card |
| Libya | Passport (incl. Arabic script), Paper Passport |
| Mali | ID Card |
| Mauritius | ID Card |
| Morocco | Driver’s License, ID Card, Paper Passport |
| Mozambique | ID Card, Driver’s License |
| Namibia | ID Card, Paper Passport |
| Nigeria | Driver’s License, ID Card, Passport, Voter ID, Polycarbonate Passport |
| Oman | ID Card (incl. Arabic script), Resident ID (incl. Arabic script), Driver’s License, Paper Passport |
| Palestine | Passport (incl. Arabic script), Paper Passport |
| Qatar | Driver’s License, Passport (incl. Arabic script), Residence Permit (incl. Arabic script), ID Card |
| Rwanda | ID Card, Polycarbonate Passport |
| Saudi Arabia | Driver’s License (incl. Arabic script), ID Card, Passport (incl. Arabic script), Resident ID (incl. Arabic script), Paper Passport |
| Senegal | ID Card, Paper Passport |
| South Africa | Driver’s License, ID Card, Passport |
| Sudan | Passport, Polycarbonate Passport |
| Syria | ID Card (incl. Arabic script), Passport (incl. Arabic script), Paper Passport |
| Tanzania | Driver’s License, ID Card, Polycarbonate Passport, Voter ID |
| Togo | ID Card |
| Tunisia | Driver’s License, Passport (incl. Arabic script), Paper Passport |
| Turkey | Driver’s License, ID Card, Passport, Paper Passport |
| UAE | Driver’s License, ID Card (incl. Arabic script), Passport (incl. Arabic script), Resident ID (incl. Arabic script), Paper Passport, Polycarbonate Passport |
| Uganda | Driver’s License, ID Card, Paper Passport, Polycarbonate Passport |
| Zambia | Driver's License, Paper Passport |
| Zimbabwe | ID Card, Passport, Driver's License, Polycarbonate Passport |
North America
| Country | Supported Documents |
|---|---|
| Canada | Passport, Residence Permit, Tribal ID, Weapon Permit, Citizenship Certificate, Polycarbonate Passport |
| Canada Alberta | Driver’s License, ID Card |
| Canada British Columbia | Driver’s License, ID Card, Public Services Card |
| Canada Manitoba | Driver’s License, ID Card |
| Canada New Brunswick | Driver’s License, ID Card |
| Canada Newfoundland And Labrador | Driver’s License, ID Card |
| Canada Northwest Territories | Driver’s License, ID Card |
| Canada Nova Scotia | Driver’s License, ID Card |
| Canada Nunavut | Driver’s License, ID Card |
| Canada Ontario | Driver’s License, ID Card, Health Insurance Card |
| Canada Prince Edward Island | ID Card, Driver’s License |
| Canada Quebec | Driver’s License, Health Insurance Card |
| Canada Saskatchewan | Driver’s License, ID Card |
| Canada Yukon | Driver’s License, ID Card |
| USA | Passport, Passport Card, Border Crossing Card, Global Entry Card, Green Card, Military ID, Twic Card, Uniformed Services ID, Veteran ID, Work Permit, Polycarbonate Passport, Social Security Card |
| USA Alabama | Driver’s License*, ID Card* |
| USA Alaska | Driver’s License*, ID Card* |
| USA Arizona | Driver’s License*, ID Card* |
| USA Arkansas | Driver’s License*, ID Card* |
| USA California | Driver’s License*, ID Card* |
| USA Colorado | Driver’s License*, ID Card* |
| USA Connecticut | Driver’s License*, ID Card* |
| USA Delaware | Driver’s License*, ID Card* |
| USA District Of Columbia | Driver’s License*, ID Card* |
| USA Florida | Driver’s License*, ID Card*, Medical Marijuana ID |
| USA Georgia | Driver’s License*, ID Card* |
| USA Hawaii | Driver’s License*, ID Card* |
| USA Idaho | Driver’s License*, ID Card |
| USA Illinois | Driver’s License*, ID Card* |
| USA Indiana | Driver’s License*, ID Card* |
| USA Iowa | Driver’s License*, ID Card* |
| USA Kansas | Driver’s License*, ID Card* |
| USA Kentucky | Driver’s License*, ID Card* |
| USA Louisiana | Driver’s License*, ID Card* |
| USA Maine | Driver’s License*, ID Card* |
| USA Maryland | Driver’s License*, ID Card* |
| USA Massachusetts | Driver’s License*, ID Card* |
| USA Michigan | Driver’s License*, ID Card* |
| USA Minnesota | Driver’s License*, ID Card* |
| USA Mississippi | Driver’s License*, ID Card* |
| USA Missouri | Driver’s License*, ID Card* |
| USA Montana | Driver’s License*, ID Card* |
| USA Nebraska | Driver’s License*, ID Card* |
| USA Nevada | Driver’s License*, ID Card* |
| USA New Hampshire | Driver’s License*, ID Card* |
| USA New Jersey | Driver’s License*, ID Card* |
| USA New Mexico | Driver’s License*, ID Card* |
| USA New York | Driver’s License*, ID Card* |
| USA New York City | ID Card |
| USA North Carolina | Driver’s License*, ID Card* |
| USA North Dakota | Driver’s License*, ID Card* |
| USA Ohio | Driver’s License*, ID Card* |
| USA Oklahoma | Driver’s License*, ID Card* |
| USA Oregon | Driver’s License*, ID Card* |
| USA Pennsylvania | Driver’s License*, ID Card*, Medical Marijuana ID |
| USA Rhode Island | Driver’s License*, ID Card* |
| USA South Carolina | Driver’s License*, ID Card* |
| USA South Dakota | Driver’s License*, ID Card* |
| USA Tennessee | Driver’s License*, ID Card* |
| USA Texas | Driver’s License*, ID Card* |
| USA Utah | Driver’s License*, ID Card* |
| USA Vermont | Driver’s License*, ID Card* |
| USA Virginia | Driver’s License*, ID Card* |
| USA Washington | Driver’s License*, ID Card* |
| USA West Virginia | Driver’s License*, ID Card* |
| USA Wisconsin | Driver’s License*, ID Card* |
| USA Wyoming | Driver’s License*, ID Card* |
* Vertical IDs are supported
Oceania
| Country | Supported Documents |
|---|---|
| Australia | Passport, Polycarbonate Passport |
| Australia Australian Capital Territory | Driver’s License, ID Card |
| Australia New South Wales | Driver’s License, ID Card, Mobile Driver’s License |
| Australia Northern Territory | Driver’s License, Proof of Age Card |
| Australia Queensland | Driver’s License, Proof of Age Card |
| Australia South Australia | Driver’s License, Proof of Age Card, Mobile Driver’s License |
| Australia Tasmania | Driver’s License, ID Card |
| Australia Victoria | Driver’s License, Proof of Age Card, Mobile Driver’s License |
| Australia Western Australia | Driver’s License, ID Card |
| New Zealand | Driver’s License, Passport, Polycarbonate Passport |
Anonymized Documents
Some countries have specific requirements for the anonymization of documents. By default, ID Capture will omit sensitive fields from countries with such restrictions. To control this behavior, you can set the IdAnonymizationMode parameter.
Depending on the anonymization mode, certain sensitive fields are not extracted from documents (their values are returned as nil) or they are blacked out on the returned document images.
Documents and fields that are subject to anonymization are listed below:
Anonymized Documents
| Country | Documents | Fields |
|---|---|---|
| Germany | ID Card | Document Number (VIZ & MRZ), Additional Document Number, Full MRZ |
| Germany | Passport, Diplomatic Passport, Minor’s Passport | Document Number (VIZ & MRZ), Full MRZ |
| Hong Kong | ID Card | Document Number |
| Hong Kong | Passport, Diplomatic Passport | Document Number (VIZ & MRZ), MRZ Opt1, Full MRZ |
| Malaysia | MyKad, MyKAS, MyKid, MyPR, MyTentera | Religion |
| Netherlands | Driver’s License | Personal ID Number |
| Netherlands | ID Card | Personal ID Number, MRZ Opt1, Full MRZ |
| Netherlands | Passport, Diplomatic Passport | MRZ Opt1, Full MRZ |
| Singapore | Driver’s License | Document Number |
| Singapore | Employment Pass | Personal ID Number |
| Singapore | Fin Card, ID Card, Resident ID | Document Number |
| Singapore | Passport, Diplomatic Passport | Document Number (VIZ & MRZ), MRZ Opt1, Full MRZ |
| Singapore | S Pass, Work Permit | Document Number, Personal ID Number |
| South Korea | Driver’s License | Personal ID Number |
| South Korea | ID Card | Document Number |
| South Korea | Passport, Diplomatic Passport | Personal ID Number, MRZ Opt1, Full MRZ |
Single-Side Scanner
This scanner performs data extraction on specific parts of the document, focusing only on one side.
Machine Readable Zone (MRZ)
The single-side scanner's machine-readable zone mode is compatible with all machine-readable travel documents (MRTD) as defined by the International Civil Aviation Organization (ICAO). Additionally, it supports certain non-ICAO standards.
Captured MRZ data is parsed and can be accessed through the CapturedId interface. For details on retrieving raw MRZ data, please refer to the MrzResult documentation.
| Region | Supported Documents | ICAO MRTD Type |
|---|---|---|
| Worldwide | All Passports | TD3 |
| Worldwide | ICAO-compliant Visa | MRV |
| Europe | All ID Cards | TD1 |
| USA | Enhanced Driver’s License Green Card Passport Card Border Crossing Card NEXUS + Global Entry Cards | TD1 |
| Canada | Enhanced Driver’s License | TD1 |
| Switzerland | Driver’s License | Non-ICAO |
| Asia | China Mainland Travel Permit for Hong Kong & Macau Residents China Mainland Travel Permit for Taiwan Residents China Exit-Entry Permit for Traveling to and from Hong Kong and Macau (往来港澳通行证) China Exit-Entry Permit for Traveling to and from Taiwan (往来台灣通行证) APEC (Asia-Pacific Economic Cooperation) Business Travel Card | Non-ICAO |
Barcode
The single-side scanner's barcode mode extracts data from ID documents with PDF417 barcodes.
Barcodes are captured and parsed so that the data can be accessed via CapturedId. To access the raw barcode data, consult the documentation of BarcodeResult.
| Country | Supported Documents | PDF417 Barcode Location |
|---|---|---|
| USA | Driver License, ID Card Support for all versions of the Driver License and Identification Standard published by AAMVA | Back |
| USA | Common Access Card (CAC) | Front |
| USA | Uniformed Services ID Card (USID) | Back |
| Argentina | ID Card | Front |
| Colombia | ID Card, Driver’s License | Back |
| South Africa | Smart ID Card, Driver’s License | Back |
Visual Inspection Zone (VIZ)
The single-side scanner's Visual Inspection Zone mode extracts human-readable text from documents. Unlike the full document scanner, this mode focuses solely on the front side of the document, extracting only the visible text while ignoring barcodes and machine-readable zones.
Extracted text data is accessible through the CapturedId interface. For more information on retrieving raw text data, please refer to the VizResult documentation.
ID Validation Supported Documents
ID Validate includes a range of checks to ensure the scanned document is valid. The available checks are dependent on the document type and country and are described in the following section.
| Region | Supported Documents | Supported Checks |
|---|---|---|
| USA | Driver’s License, ID Card | Voided Document Detection, AAMVA Barcode Verification |
| Canada | Driver’s License, ID Card | Voided Document Detection |