Universal ID

Scan capability overview

The Anyline Universal ID mode provides the functionality to scan MRZ documents, driving licenses, identity cards and insurance cards in one scan mode.

Currently, the following alphabets/scripts are supported:

  • Latin (default)

  • Arabic

  • Cyrillic

The scannable data fields that can be scanned with the Anyline Universal ID scanner depend on the type that is scanned.

For each scan result, the Universal ID mode generates a new, generic ID object, containing all relevant information.

Supported Fields

Driving Licenses, ID Cards and Insurance Cards

Field Name Driving License ID Card Insurance Card

additionalInformation

additionalInformation1

additionalInformation2

address

age

audit

authority

cardAccessNumber

cityNumber

conditions

dateOfBirth

dateOfExpiry

dateOfIssue

dateOfRegistration

degreeOfDisability

divisionNumber

documentDiscriminator

documentNumber

duplicate

duration

educationalInstitution

endorsements

eyes

firstIssued

firstName

folio

fullName

fullName\@zho

hair

headOfFamily

height

lastName

licenseClass

licenseType

maidenName

militaryRank

municipalityNumber

nationality

office

parentsFirstName

parish

personalNumber

placeAndDateOfBirth

placeOfBirth

previousType

province

restrictions

sex

socialSecurityNumber

stateNumber

voterId

weight

MRZ Documents

If a document containing MRZ information is scanned with the Universal ID plugin, the content will be the same as for the MRZ Scan Capability.

MRZ is available on any ICAO standard Machine Readable Travel Documents. The Anyline MRZ module field names are according to the ICAO standard field names.

The MRZ and Universal ID plugins are not using the same result names for specific fields.

Some result field names are only available on MRZ documents those are marked as "N/A" in their synonym map cells.

Field Name MRZ Field Name Universal ID layouts

surname

lastName

givenNames

firstName

dateOfBirth

dateOfBirth

dateOfExpiry

dateOfExpiry

documentNumber

documentNumber

documentType

documentType

issuingCountryCode

N/A

nationalityCountryCode

N/A

sex

sex

personalNumber

personalNumber

optionalData

N/A

checkDigitDateOfExpiry

N/A

checkDigitDocumentNumber

N/A

checkDigitDateOfBirth

N/A

checkDigitPersonalNumber

N/A

checkDigitFinal

N/A

allCheckDigitsValid

N/A

vizAddress

address

vizDateOfIssue

dateOfIssue

vizSurname

lastName

vizGivenNames

firstName

vizDateOfBirth

dateOfBirth

vizDateOfExpiry

dateOfExpiry

Supported document types and countries

The naming schema for all layouts is built from multiple segments in the following fashion: [category][type][version][side] e.g. AT_DVL_O_04001_F.

For some countries also subdivisions are supported, those are added to the first segment separated by a dash: [ISO 3661-1 alpha2]-[category][type][version][side] e.g. US-CA_IDC_O_R301_F.

Document categories:

  • DVL: driving licenses

  • IDC: identification card

  • HIC: health insurance cards

Document types:

  • O: ordinary (default, e.g. national ID for IDC. or a standard driver’s license for DVL)

  • R: resident (resident permit/card)

  • MO: military ordinary

  • MT: military temporal

  • EO: EDU (student cards) ordinary

  • P: pensioner/retiree

  • HO: handicapped/disabled

Document version:

  • Official European Council version where available

  • Others are assigned a unique identifier for distinguishing documents that otherwise share all other layout code attributes

Latin Cards

These are all layouts supported with the Latin script.

European Driving Licenses

Country Code Layout Whitelist code

Austria

AT

AT_DVL_O_04001_F

AT_DVL_O_04001_F

AT_DVL_O_05001_F

AT_DVL_O_05002-05001_F

AT_DVL_O_05002_F

Belgium

BE

BE_DVL_O_02001_F

BE_DVL_O_02003-02002-02001_F

BE_DVL_O_02002_F

BE_DVL_O_02003_F

BE_DVL_O_03001_F

BE_DVL_O_05001-04003-04002-04001-03001_F

BE_DVL_O_04001_F

BE_DVL_O_04002_F

BE_DVL_O_04003_F

BE_DVL_O_05001_F

Croatia

HR

HR_DVL_O_02001_F

HR_DVL_O_02001_F

Czech Republic

CZ

CZ_DVL_O_02001_F

CZ_DVL_O_02003-02002-02001_F

CZ_DVL_O_02002_F

CZ_DVL_O_02003_F

Denmark

DK

DK_DVL_O_03001_F

DK_DVL_O_03001_F

DK_DVL_O_04001_F

DK_DVL_O_04001_F

Estonia

EE

EE_DVL_O_02004_F

EE_DVL_O_02004_F

EE_DVL_O_R311_F

EE_DVL_O_R311_F

Finland

FI

FI_DVL_O_04001_F

FI_DVL_O_04001_F

France

FR

FR_DVL_O_06001_F

FR_DVL_O_07001-06001_F,FR_DVL_O_07001-06001_F_v2

FR_DVL_O_07001_F

Germany

DE

DE_DVL_O_02001_F

DE_DVL_O_02006-02003-02002-02001_F

DE_DVL_O_02002_F

DE_DVL_O_02003_F

DE_DVL_O_02006_F

DE_DVL_O_02007_F

DE_DVL_O_02007_F

Hungary

HU

HU_DVL_O_02001_F

HU_DVL_O_02001_F

Ireland

IE

IE_DVL_O_04001_F

IE_DVL_O_04001_F

Italy

IT

IT_DVL_O_06001_F

IT_DVL_O_06001_F

Latvia

LV

LV_DVL_O_01003_F

LV_DVL_O_01003_F

Lithuania

LT

LT_DVL_O_04001_F

LT_DVL_O_04001_F

Luxembourg

LU

LU_DVL_O_01010_F

LU_DVL_O_01010_F

Netherlands

NL

NL_DVL_O_04001_F

NL_DVL_O_04001_F

NL_DVL_O_05001_F

NL_DVL_O_05001_F

NL_DVL_O_06001_F

NL_DVL_O_06001_F

Norway

NO

NO_DVL_O_07001_F

NO_DVL_O_07001_F

Poland

PL

PL_DVL_O_04001_F

PL_DVL_O_04001_F

PL_DVL_O_05001_F

PL_DVL_O_05001_F

Portugal

PT

PT_DVL_O_06001_F

PT_DVL_O_06001_F

Romania

RO

RO_DVL_O_05001_F

RO_DVL_O_06001-05001_F

RO_DVL_O_06001_F

Slovakia

SK

SK_DVL_O_03001_F

SK_DVL_O_04001-03001_F

SK_DVL_O_04001_F

Slovenia

SI

SI_DVL_O_04001_F

SI_DVL_O_04001_F

Spain

ES

ES_DVL_O_04002_F

ES_DVL_O_04002_F

Sweden

SE

SE_DVL_O_04001_F

SE_DVL_O_05001-04001_F

SE_DVL_O_05001_F

SE_DVL_O_06001_F

SE_DVL_O_06001_F

SE_DVL_O_07001_F

SE_DVL_O_07001_F

Switzerland

CH

CH_DVL_O_02001_F

CH_DVL_O_02001_F

United Kingdom

GB

GB_DVL_O_07001_F

GB_DVL_O_07001_F

GB_DVL_O_08001_F

GB_DVL_O_09002-09001-08002-08001_F

GB_DVL_O_08002_F

GB_DVL_O_09001_F

GB_DVL_O_09002_F

North American Driving Licenses

Country State Code Layout Whitelist code

Canada

Alberta

CA-AB

CA-AB_DVL_O_R281_F

CA-AB_DVL_O_R281_F

British Columbia

CA-BC

CA-BC_DVL_O_R281_F

CA-BC_DVL_O_R281_F

Manitoba

CA-MB

CA-MB_DVL_O_R371_F

CA-MB_DVL_O_R371_F

Nova Scotia

CA-NS

CA-NS_DVL_O_R371_F

CA-NS_DVL_O_R371_F

Ontario

CA-ON

CA-ON_DVL_O_R281_F

CA-ON_DVL_O_R281_F

Quebec

CA-QC

CA-QC_DVL_O_R281_F

CA-QC_DVL_O_R281_F

Saskatchewan

CA-SK

CA-SK_DVL_O_R371_F

CA-SK_DVL_O_R371_F

United States

Alabama

US-AL

US-AL_DVL_O_R271_F

US-AL_DVL_O_R271_F

Alaska

US-AK

US-AK_DVL_O_R271_F

US-AK_DVL_O_R271_F

Arizona

US-AZ

US-AZ_DVL_O_R241_F

US-AZ_DVL_O_R241_F

Arkansas

US-AR

US-AR_DVL_O_R271_F

US-AR_DVL_O_R271_F

California

US-CA

US-CA_DVL_O_R241_F

US-CA_DVL_O_R241_F

US-CA_DVL_O_R341_F

US-CA_DVL_O_R341_F

Colorado

US-CO

US-CO_DVL_O_R271_F

US-CO_DVL_O_R271_F

US-CO_DVL_O_R341_F

US-CO_DVL_O_R341_F

Connecticut

US-CT

US-CT_DVL_O_R261_F

US-CT_DVL_O_R261_F, US-CT_DVL_O_R261_F_v2

Delaware

US-DE

US-DE_DVL_O_R271_F

US-DE_DVL_O_R271_F

District of Columbia

US-DC

US-DC_DVL_O_R271_F

US-DC_DVL_O_R271_F

Florida

US-FL

US-FL_DVL_O_R261_F

US-FL_DVL_O_R261_F, US-FL_DVL_O_R261_F_v2

Georgia

US-GA

US-GA_DVL_O_R281_F

US-GA_DVL_O_R281_F

US-GA_DVL_O_R381_F

US-GA_DVL_O_R381_F, US-GA_DVL_O_R381_F_v2

Hawaii

US-HI

US-HI_DVL_O_R271_F

US-HI_DVL_O_R271_F

Idaho

US-ID

US-ID_DVL_O_R271_F

US-ID_DVL_O_R271_F

Illinois

US-IL

US-IL_DVL_O_R241_F

US-IL_DVL_O_R241_F

Indiana

US-IN

US-IN_DVL_O_R361_F

US-IN_DVL_O_R361_F

Iowa

US-IA

US-IA_DVL_O_R271_F

US-IA_DVL_O_R271_F, US-IA_DVL_O_R271_F_v2

US-IA_DVL_O_R391_F

US-IA_DVL_O_R391_F

Kansas

US-KS

US-KS_DVL_O_R271_F

US-KS_DVL_O_R271_F

Kentucky

US-KY

US-KY_DVL_O_R271_F

US-KY_DVL_O_R271_F

Louisiana

US-LA

US-LA_DVL_O_R271_F

US-LA_DVL_O_R271_F

Maine

US-ME

US-ME_DVL_O_R271_F

US-ME_DVL_O_R271_F

US-ME_DVL_O_R371_F

US-ME_DVL_O_R371_F

Maryland

US-MD

US-MD_DVL_O_R271_F

US-MD_DVL_O_R271_F

Massachusetts

US-MA

US-MA_DVL_O_R261_F

US-MA_DVL_O_R261_F

Michigan

US-MI

US-MI_DVL_O_R261_F

US-MI_DVL_O_R261_F, US-MI_DVL_O_R261_F_v2

Minnesota

US-MN

US-MN_DVL_O_R271_F

US-MN_DVL_O_R271_F

Mississippi

US-MS

US-MS_DVL_O_R271_F

US-MS_DVL_O_R271_F

Missouri

US-MO

US-MO_DVL_O_R361_F

US-MO_DVL_O_R361_F

US-MO_DVL_O_R371_F

US-MO_DVL_O_R371_F

Montana

US-MT

US-MT_DVL_O_R271_F

US-MT_DVL_O_R271_F

Nebraska

US-NE

US-NE_DVL_O_R271_F

US-NE_DVL_O_R271_F

US-NE_DVL_O_R391_F

US-NE_DVL_O_R391_F

Nevada

US-NV

US-NV_DVL_O_R271_F

US-NV_DVL_O_R271_F, US-NV_DVL_O_R271_F_v2

New Hampshire

US-NH

US-NH_DVL_O_R271_F

US-NH_DVL_O_R271_F

New Jersey

US-NJ

US-NJ_DVL_O_R261_F

US-NJ_DVL_O_R261_F

US-NJ_DVL_O_R401_F

US-NJ_DVL_O_R401_F

New Mexico

US-NM

US-NM_DVL_O_R271_F

US-NM_DVL_O_R271_F

New York

US-NY

US-NY_DVL_O_R261_F

US-NY_DVL_O_R261_F

North Carolina

US-NC

US-NC_DVL_O_R261_F

US-NC_DVL_O_R261_F

North Dakota

US-ND

US-ND_DVL_O_R271_F

US-ND_DVL_O_R271_F

Ohio

US-OH

US-OH_DVL_O_R361_F

US-OH_DVL_O_R361_F

Oklahoma

US-OK

US-OK_DVL_O_R271_F

US-OK_DVL_O_R271_F

Oregon

US-OR

US-OR_DVL_O_R271_F

US-OR_DVL_O_R271_F

US-OR_DVL_O_R381_F

US-OR_DVL_O_R381_F

Pennsylvania

US-PA

US-PA_DVL_O_R261_F

US-PA_DVL_O_R261_F, US-PA_DVL_O_R261_F_v2

Rhode Island

US-RI

US-RI_DVL_O_R261_F

US-RI_DVL_O_R261_F, US-RI_DVL_O_R261_F_v2

South Carolina

US-SC

US-SC_DVL_O_R281_F

US-SC_DVL_O_R281_F

South Dakota

US-SD

US-SD_DVL_O_R271_F

US-SD_DVL_O_R271_F

Tennessee

US-TN

US-TN_DVL_O_R271_F

US-TN_DVL_O_R271_F, US-TN_DVL_O_R271_F_v2

Texas

US-TX

US-TX_DVL_O_R261_F

US-TX_DVL_O_R261_F

US-TX_DVL_O_R351_F

US-TX_DVL_O_R351_F

Utah

US-UT

US-UT_DVL_O_R271_F

US-UT_DVL_O_R271_F, US-UT_DVL_O_R271_F_v2

US-UT_DVL_O_R391_F

US-UT_DVL_O_R391_F

Vermont

US-VT

US-VT_DVL_O_R271_F

US-VT_DVL_O_R271_F

Virginia

US-VA

US-VA_DVL_O_R271_F

US-VA_DVL_O_R271_F

Washington

US-WA

US-WA_DVL_O_R271_F

US-WA_DVL_O_R271_F

West Virginia

US-WV

US-WV_DVL_O_R361_F

US-WV_DVL_O_R361_F

US-WV_DVL_O_R421_F

US-WV_DVL_O_R421_F

Wisconsin

US-WI

US-WI_DVL_O_R271_F

US-WI_DVL_O_R271_F

Wyoming

US-WY

US-WY_DVL_O_R271_F

US-WY_DVL_O_R271_F

Oceanian Driving Licenses

Country State Code Layout Whitelist code

Australia

Australian Capital Territory

AU-ACT

AU-ACT_DVL_O_R261_F

AU-ACT_DVL_O_R261_F

New South Wales

AU-NSW

AU-NSW_DVL_O_R241_F

AU-NSW_DVL_O_R241_F

Northern Territory

AU-NT

AU-NT_DVL_O_R261_F

AU-NT_DVL_O_R261_F

Queensland

AU-QLD

AU-QLD_DVL_O_R241_F

AU-QLD_DVL_O_R241_F

South Australia

AU-SA

AU-SA_DVL_O_R241_F

AU-SA_DVL_O_R241_F

Victoria

AU-VIC

AU-VIC_DVL_O_R241_F

AU-VIC_DVL_O_R241_F

Western Australia

AU-WA

AU-WA_DVL_O_R261_F

AU-WA_DVL_O_R261_F

New Zealand

NZ

NZ_DVL_O_R261_F

NZ_DVL_O_R261_F

African Driving Licenses

Country Code Layout Whitelist code

Botswana

BW

BW_DVL_O_01001_F

BW_DVL_O_01001_F

Malawi

MW

MW_DVL_O_R341_F

MW_DVL_O_R341_F

Mozambique

MZ

MZ_DVL_O_R341_F

MZ_DVL_O_R341_F

South Africa

ZA

ZA_DVL_O_R351_F

ZA_DVL_O_R351_F, ZA_DVL_O_R351_F_v2

Zambia

ZM

ZM_DVL_O_R341_F

ZM_DVL_O_R341_F

Asian Driving Licenses

Country Code Layout Whitelist code

Turkey

TR

TR_DVL_O_01001_F

TR_DVL_O_01001_F

European Identity Cards

Country

Code

Layout

Whitelist code

Austria

AT

AT_IDC_O_02001_F

AT_IDC_O_02003-02002-02001_F

AT_IDC_O_02002_F

AT_IDC_O_02003_F

AT_IDC_O_03001_F

AT_IDC_O_03001_F

Belgium

BE

BE_IDC_O_09001_F

BE_IDC_O_09003-09002-09001_F

BE_IDC_O_09002_F

BE_IDC_O_09003_F

Croatia

HR

HR_IDC_O_03001_F

HR_IDC_O_03002-03001_F

HR_IDC_O_03002_F

HR_IDC_O_04001_F

HR_IDC_O_04001_F

Czech Republic

CZ

CZ_IDC_O_04001_F

CZ_IDC_O_04002-04001_F

CZ_IDC_O_04002_F

Estonia

EE

EE_IDC_O_04001_F

EE_IDC_O_04001_F

Finland

FI

FI_IDC_O_09001_F

FI_IDC_O_09001_F

France

FR

FR_IDC_O_02001_F

FR_IDC_O_02002-02001_F

FR_IDC_O_02002_F

FR_IDC_O_03001_F

FR_IDC_O_03001_F

Germany

DE

DE_IDC_O_02001_F

DE_IDC_O_02001_F

DE_IDC_O_02004_F

DE_IDC_O_02004_F

Hungary

HU

HU_IDC_O_05001_F

HU_IDC_O_05004-05003-05002-05001_F

HU_IDC_O_05002_F

HU_IDC_O_05003_F

HU_IDC_O_05004_F

Italy

IT

IT_IDC_O_04004_F

IT_IDC_O_04004_F

Latvia

LV

LV_IDC_O_01001_F

LV_IDC_O_01001_F

Lithuania

LT

LT_IDC_O_02001_F

LT_IDC_O_02002-02001_F

LT_IDC_O_02002_F

Luxembourg

LU

LU_IDC_O_02005_F

LU_IDC_O_02005_F

Moldova

MD

MD_IDC_O_02001_F

MD_IDC_O_02002-02001_F

MD_IDC_O_02002_F

Netherlands

NL

NL_IDC_O_04001_F

NL_IDC_O_05001-04001_F

NL_IDC_O_05001_F

Norway

NO

NO_IDC_O_01002_F

NO_IDC_O_01002_F

Poland

PL

PL_IDC_O_02002_F

PL_IDC_O_03001-02003-02002_F

PL_IDC_O_02003_F

PL_IDC_O_03001_F

Portugal

PT

PT_IDC_O_03001_F

PT_IDC_O_03005-03004-03003-03002-03001_F, PT_IDC_O_03005-03004-03003-03002-03001_F_v2

PT_IDC_O_03002_F

PT_IDC_O_03003_F

PT_IDC_O_03004_F

PT_IDC_O_03005_F

Slovakia

SK

SK_IDC_O_02001_F

SK_IDC_O_05002-05001-04001-03001-02001_F

SK_IDC_O_03001_F

SK_IDC_O_04001_F

SK_IDC_O_05001_F

SK_IDC_O_05002_F

Slovenia

SI

SI_IDC_O_02001_F

SI_IDC_O_02001_F

Spain

ES

ES_IDC_O_05001_F

ES_IDC_O_05001_F

ES_IDC_O_06001_F

ES_IDC_O_06001_F

Sweden

SE

SE_IDC_O_03001_F

SE_IDC_O_03001_F

Switzerland

CH

CH_IDC_O_01001_F

CH_IDC_O_01003-01002-01001_F

CH_IDC_O_01002_F

CH_IDC_O_01003_F

Military Identity cards
Country Code Layout Whitelist code

Austria

AT

AT_IDC_MO_R351_B

AT_IDC_MO_R351_B

AT_IDC_MO_R381_B

AT_IDC_MO_R381_B

AT_IDC_MT_R351_F

AT_IDC_MT_R351_F

AT_IDC_MT_R382_F

AT_IDC_MT_R382_F

AT_IDC_MT_R383_F

AT_IDC_MT_R383_F

Disabled Identity cards
Country Code Layout Whitelist code

Austria

AT

AT_IDC_HO_R381_F

AT_IDC_HO_R381_F

Pensioner Identity cards
Country Code Layout Whitelist code

Austria

AT

AT_IDC_P_R381_F

AT_IDC_P_R381_F

Student Identity cards
Country Code Layout Whitelist code

Austria

AT

AT_IDC_EO_R361_F

AT_IDC_EO_R361_F

AT_IDC_EO_R362_F

AT_IDC_EO_R362_F

AT_IDC_EO_R363_F

AT_IDC_EO_R363_F

AT_IDC_EO_R364_F

AT_IDC_EO_R364_F

North American Identity Cards

Country State Code Layout Whitelist code

Mexico

MX

MX_IDC_O_R271_F

MX_IDC_O_R271_F

MX_IDC_O_R272_F

MX_IDC_O_R272_F

MX_IDC_O_R273_F

MX_IDC_O_R273_F

United States

Alabama

US-AL

US-AL_IDC_O_R301_F

US-AL_IDC_O_R301_F

Alaska

US-AK

US-AK_IDC_O_R301_F

US-AK_IDC_O_R301_F

Arizona

US-AZ

US-AZ_IDC_O_R301_F

US-AZ_IDC_O_R301_F

Arkansas

US-AR

US-AR_IDC_O_R301_F

US-AR_IDC_O_R301_F

California

US-CA

US-CA_IDC_O_R301_F

US-CA_IDC_O_R301_F

Colorado

US-CO

US-CO_IDC_O_R301_F

US-CO_IDC_O_R301_F

US-CO_IDC_O_R421_F

US-CO_IDC_O_R421_F

Connecticut

US-CT

US-CT_IDC_O_R301_F

US-CT_IDC_O_R301_F

Delaware

US-DE

US-DE_IDC_O_R301_F

US-DE_IDC_O_R301_F

District of Columbia

US-DC

US-DC_IDC_O_R301_F

US-DC_IDC_O_R301_F

Florida

US-FL

US-FL_IDC_O_R301_F

US-FL_IDC_O_R301_F

Georgia

US-GA

US-GA_IDC_O_R331_F

US-GA_IDC_O_R331_F

Hawaii

US-HI

US-HI_IDC_O_R351_F

US-HI_IDC_O_R351_F

Idaho

US-ID

US-ID_IDC_O_R321_F

US-ID_IDC_O_R321_F

Illinois

US-IL

US-IL_IDC_O_R301_F

US-IL_IDC_O_R301_F

Indiana

US-IN

US-IN_IDC_O_R331_F

US-IN_IDC_O_R331_F

Iowa

US-IA

US-IA_IDC_O_R331_F

US-IA_IDC_O_R331_F

Kansas

US-KS

US-KS_IDC_O_R321_F

US-KS_IDC_O_R321_F

Kentucky

US-KY

US-KY_IDC_O_R351_F

US-KY_IDC_O_R351_F

US-KY_IDC_O_R421_F

US-KY_IDC_O_R421_F

Maine

US-ME

US-ME_IDC_O_R321_F

US-ME_IDC_O_R321_F

Maryland

US-MD

US-MD_IDC_O_R321_F

US-MD_IDC_O_R321_F

Massachusetts

US-MA

US-MA_IDC_O_R301_F

US-MA_IDC_O_R301_F

Michigan

US-MI

US-MI_IDC_O_R301_F

US-MI_IDC_O_R301_F

Minnesota

US-MN

US-MN_IDC_O_R321_F

US-MN_IDC_O_R321_F

Mississippi

US-MS

US-MS_IDC_O_R321_F

US-MS_IDC_O_R321_F

Missouri

US-MO

US-MO_IDC_O_R321_F

US-MO_IDC_O_R321_F

Montana

US-MT

US-MT_IDC_O_R321_F

US-MT_IDC_O_R321_F

Nebraska

US-NE

US-NE_IDC_O_R331_F

US-NE_IDC_O_R331_F

US-NE_IDC_O_R391_F

US-NE_IDC_O_R391_F

Nevada

US-NV

US-NV_IDC_O_R331_F

US-NV_IDC_O_R331_F

New Hampshire

US-NH

US-NH_IDC_O_R351_F

US-NH_IDC_O_R351_F

New Jersey

US-NJ

US-NJ_IDC_O_R301_F

US-NJ_IDC_O_R301_F

US-NJ_IDC_O_R401_F

US-NJ_IDC_O_R401_F

New Mexico

US-NM

US-NM_IDC_O_R331_F

US-NM_IDC_O_R331_F

New York

US-NY

US-NY_IDC_O_R301_F

US-NY_IDC_O_R301_F

US-NY_IDC_O_R401_F

US-NY_IDC_O_R401_F

North Carolina

US-NC

US-NC_IDC_O_R301_F

US-NC_IDC_O_R301_F

North Dakota

US-ND

US-ND_IDC_O_R351_F

US-ND_IDC_O_R351_F

Ohio

US-OH

US-OH_IDC_O_R301_F

US-OH_IDC_O_R301_F

Oklahoma

US-OK

US-OK_IDC_O_R352_F

US-OK_IDC_O_R352_F

US-OK_IDC_O_R371_F

US-OK_IDC_O_R371_F

Oregon

US-OR

US-OR_IDC_O_R321_F

US-OR_IDC_O_R321_F

Pennsylvania

US-PA

US-PA_IDC_O_R301_F

US-PA_IDC_O_R301_F

Rhode Island

US-RI

US-RI_IDC_O_R301_F

US-RI_IDC_O_R301_F

South Carolina

US-SC

US-SC_IDC_O_R331_F

US-SC_IDC_O_R331_F

South Dakota

US-SD

US-SD_IDC_O_R351_F

US-SD_IDC_O_R351_F

Texas

US-TX

US-TX_IDC_O_R301_F

US-TX_IDC_O_R301_F

US-TX_IDC_O_R401_F

US-TX_IDC_O_R401_F

Utah

US-UT

US-UT_IDC_O_R321_F

US-UT_IDC_O_R321_F

US-UT_IDC_O_R391_F

US-UT_IDC_O_R391_F

Vermont

US-VT

US-VT_IDC_O_R351_F

US-VT_IDC_O_R351_F

Virginia

US-VA

US-VA_IDC_O_R351_F

US-VA_IDC_O_R351_F

Washington

US-WA

US-WA_IDC_O_R331_F

US-WA_IDC_O_R331_F

West Virginia

US-WV

US-WV_IDC_O_R352_F

US-WV_IDC_O_R352_F

Wisconsin

US-WI

US-WI_IDC_O_R351_F

US-WI_IDC_O_R351_F

Wyoming

US-WY

US-WY_IDC_O_R331_F

US-WY_IDC_O_R331_F

African Identity Cards

State Code Layout Whitelist code

Lesotho

LS

LS_IDC_O_R391_F

LS_IDC_O_R391_F

Asian Identity Cards

State Code Layout Whitelist code

Hong Kong

CN-HK

CN-HK_IDC_O_R331_F

CN-HK_IDC_O_R331_F

CN-HK_IDC_O_R332_F

CN-HK_IDC_O_R332_F

Pakistan

PK

PK_IDC_O_R371_F

PK_IDC_O_R371_F

PK_IDC_O_R382_F

PK_IDC_O_R382_F

PK_IDC_O_R373_B

PK_IDC_O_R373_B

PK_IDC_O_R382_B

PK_IDC_O_R382_B

Turkey

TR

TR_IDC_R_R411_F

TR_IDC_R_R411_F

TR_IDC_O_R421_F

TR_IDC_O_R421_F

European Health Insurance Cards

Country

Code

Layout

Whitelist code

Austria

AT

AT_HIC_O_R381_B

AT_HIC_O_R381_B

France

FR

FR_HIC_O_R281_F

FR_HIC_O_R281_F

Germany

DE

DE_HIC_O_R281_F

DE_HIC_O_R281_F

Italy

IT

IT_HIC_O_R281_F

IT_HIC_O_R281_F

Spain

ES

ES_HIC_O_R281_F

ES_HIC_O_R281_F

United Kingdom

GB

GB_HIC_O_R281_F

GB_HIC_O_R281_F

Arabic Cards

These are all layouts supported with the Arabic script.

Note that all fields containing Arabic text are postfixed with the tag @ara

Arabic Identity Cards

State Code Layouts

Algeria

DZ

DZ_IDC_O_R391_F

Bahrain

BH

BH_IDC_O_R321_F

BH_IDC_O_R372_F

Egypt

EG

EG_IDC_O_R341_F

Jordan

JO

JO_IDC_O_R341_F

Kuwait

KW

KW_IDC_C_R321_F

Morocco

MA

MA_IDC_O_R381_F

MA_IDC_O_R392_F

Oman

OM

OM_IDC_R_R321_F

OM_IDC_O_R371_F

Qatar

QA

QA_IDC_R_R321_F

QA_IDC_O_R371_F

Saudi Arabia

SA

SA_IDC_R_R321_F

SA_IDC_R_R322_F

SA_IDC_R_R323_F

SA_IDC_O_R371_F

Tunisia

TN

TN_IDC_O_R381_F

United Arab Emirates

AE

AE_RSP_O_R311_F

Arabic Driving Licenses

State Code Layouts

Algeria

DZ

DZ_DVL_O_R391_F

Bahrain

BH

BH_DVL_O_R341_F

BH_DVL_O_R342_F

Egypt

EG

EG_DVL_O_R341_F

Kuwait

KW

KW_DVL_O_R321_F

Morocco

MA

MA_DVL_O_R381_F

MA_DVL_O_R392_F

Oman

OM

OM_DVL_O_R331_F

Qatar

QA

QA_DVL_O_R331_F

Saudi Arabia

SA

SA_DVL_O_R331_F

Tunisia

TN

TN_DVL_O_R381_F

United Arab Emirates

AE

AE_DVL_O_R331_F

Cyrillic Cards

These are all layouts supported with the Cyrillic script.

Note that all fields containing Cyrillic text are postfixed with the tag @cyr

Cyrillic Identity Cards

State Code Layouts

Bulgaria

BG

BG_IDC_O_02001_F

Serbia

RS

RS_IDC_O_01001_F

Ukraine

UA

UA_IDC_O_1_F

Cyrillic Driving Licenses

State Code Layouts

Bulgaria

BG

BG_DVL_O_02002_F

Russia

RU

RU_DVL_O_03001_F

Serbia

RS

RS_DVL_O_03001_F

Ukraine

UA

UA_DVL_O_03001_F

UA_DVL_O_04001_F

UA_DVL_O_05001_F

Filtering Scannable Documents Types

By default, every document supported by the Universal ID is enabled. This includes MRZ documents, driving licenses, identity cards and health insurance cards.

If this is not desired, then it is possible to configure which specific layouts to enable. To do this, one needs to add the "allowedLayouts": {} keyword-dictionary pair to the universalIdConfig. The contents of this dictionary will control the filtering.

MRZ

In order to enable MRZ scanning one has to include the mrz keyword with an empty list as its value inside the dictionary corresponding to the "allowedLayouts" keyword: "allowedLayouts": {"mrz": []}.

The MRZ scanning is either enabled or disabled. There is no option to enable only for specific types and therefore the values within the corresponding list are not checked.

Driving Licenses

In order to enable driver license scanning one has to include the drivingLicense keyword with a list as its value inside the dictionary corresponding to the "allowedLayouts" keyword. The filtering is controlled by the values of the list. If it is empty then all supported driving license types will be allowed for scanning: "allowedLayouts": {"drivingLicense": []}

If the list has elements in them then only layouts that correspond to those will be allowed to be scanned from the driving licenses. The following configuration for example only enables the AT_DVL_O_04001_F from the driving license layouts: "allowedLayouts": {"drivingLicense": ["AT_DVL_O_04001_F"]}

Take note that certain values correspond to multiple layouts. The following configuration for example only enables the AT_DVL_O_04001_F, AT_DVL_O_05001_F and AT_DVL_O_05002_F layouts from the driving license layouts: "allowedLayouts": {"drivingLicense": ["AT_DVL_O_04001_F", "AT_DVL_O_05002-05001_F"]}

For the accepted filter values, see the whitelist codes within the layout listing tables.

Certain layouts have multiple filtering options. For best user experience, when one desires to enable a layout to be scanned, all filters belonging to that layout should be enabled. E.g.: The layout US-PA_DVL_O_R261_F has two filters, US-PA_DVL_O_R261_F and US-PA_DVL_O_R261_F_v2.

Identity Cards

In order to enable identity card scanning one has to include the idFront keyword with a list as its value inside the dictionary corresponding to the "allowedLayouts" keyword. The filtering is controlled by the values of the list. If it is empty then all supported identity card types will be allowed for scanning: "allowedLayouts": {"idFront": []}

If the list has elements in them then only layouts that correspond to those will be allowed to be scanned from the identity cards. See Driving Licenses for filtering examples.

Health Cards

In order to enable European Health Insurance Card (EHIC) scanning one has to include the insuranceCard keyword with a list as its value inside the dictionary corresponding to the "allowedLayouts" keyword. The filtering is controlled by the values of the list. If it is empty then all supported cards will be allowed for scanning: "allowedLayouts": {"insuranceCard": []}

If the list has elements in them then only layouts that correspond to those will be allowed to be scanned from the cards. See Driving Licenses for filtering examples.

Multiple Filters

Using filters at the same time for different type of documents is simple. One only has to insert them into the the dictionary corresponding to the "allowedLayouts" keyword at the same time. The rules described previously regarding filtering still applies (see Driving Licenses).

The following configuration for example enables MRZ scanning and allows all layouts from the driving licenses and from the identity cards: "allowedLayouts": {"mrz": [], "drivingLicense": [], "idFront": [] }

If a non valid string is used as a keyword in the "allowedLayouts" dictionary, or within one of the lists inside it, no error is thrown. The non valid value is simply not taken into consideration. This is the case for typos and for elements that should belong to other keywords.
The configuration "allowedLayouts": {} does not allow any documents to be scanned. To scan all supported layouts set the default from the configuration above.

Limitations

  • Some special characters are not supported yet: Scanning data with unsupported characters may work, but the result will contain errors for these text parts.

  • Data fields with the postfix :code:`@zho` are Chinese fields that are directly transliterated from the Chinese Commercial Code. At the moment only transliterations to Mainland Chinese is supported, so some Chinese characters might not be transliterated yet.

Plugin configuration and result

Plugin configuration

  • Find the PluginConfig parameters here.

Plugin result

  • Find the PluginResult parameters here.