ID
Scan capability overview
The Anyline ID plugin provides the functionality to scan MRZ documents, driving licenses, identity cards and insurance cards in one scan plugin.
Currently, the following alphabets/scripts are supported:
-
Latin (default)
-
Arabic
-
Cyrillic
The scannable data fields that can be scanned with the Anyline ID scanner depend on the type that is scanned.
For each scan result, the ID plugin generates a new, generic ID object, containing all relevant information.
Supported document types
Driving Licenses, ID Cards and Insurance Cards
With the ID plugin, you can scan various layouts of driving licenses, ID cards and insurance cards from various countries. The layout name contains information about the supported document.
The naming schema for all layouts is built from multiple segments in the following fashion:
[ISO 3661-1 alpha2]_[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]-[ISO 3661-2]_[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
Document side:
-
F: front side
-
B: back side
MRZ Documents
If a document containing MRZ information is scanned with the ID plugin, the content will be the same as for the MRZ Scan Capability. MRZ is available on any ICAO standard Machine Readable Travel Document.
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
The Anyline MRZ field names are according to the ICAO standard field names.
In addition to the supported field names on MRZ documents, the following table also lists equivalent field names on other document types if available. Some fields are only available on MRZ documents. For these, there is no equivalent field name in the table below.
| The MRZ and ID plugins are not using the same result names for specific fields. |
| Field Name MRZ | Equivalent Field Name on Other Document Types |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
N/A |
|
N/A |
|
|
|
|
|
N/A |
|
N/A |
|
N/A |
|
N/A |
|
N/A |
|
N/A |
|
N/A |
|
|
|
|
|
|
|
|
|
|
|
|
List of supported document categories and countries
Latin Cards
These are all layouts supported with the Latin script.
The Latin script currently supports the following characters: ", ', (, ), *, ,, -, ., /, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, <, A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z, a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, s, t, u, v, w, x, y, z, À, Á, Â, Ä, Æ, Ç, È, É, Ê, Ë, Í, Î, Ï, Ñ, Ó, Ô, Ö, Ù, Ú, Û, Ü, Ý, ß, à, á, â, ä, æ, ç, è, é, ê, ë, í, î, ï, ó, ô, ö, ù, û, ü, ÿ, ą, ć, ę, Ğ, ğ, İ, ı, ń, Œ, œ, Ş, ş, Ÿ, ż, ú, ñ, Ġ, ý, Ć.
Any character not in this list will either be represented as it’s base character or omitted in the result.
|
European Driving Licenses
| Country | Code | Layout | Whitelist code |
|---|---|---|---|
Austria |
AT |
|
|
|
|
||
|
|||
Belgium |
BE |
|
|
|
|||
|
|||
|
|
||
|
|||
|
|||
|
|||
|
|||
Croatia |
HR |
|
|
Czech Republic |
CZ |
|
|
|
|||
|
|||
Denmark |
DK |
|
|
|
|
||
Estonia |
EE |
|
|
|
|
||
Finland |
FI |
|
|
France |
FR |
|
|
|
|||
Germany |
DE |
|
|
|
|||
|
|||
|
|||
|
|
||
Hungary |
HU |
|
|
Ireland |
IE |
|
|
Italy |
IT |
|
|
Latvia |
LV |
|
|
Lithuania |
LT |
|
|
Luxembourg |
LU |
|
|
Netherlands |
NL |
|
|
|
|
||
|
|
||
Norway |
NO |
|
|
Poland |
PL |
|
|
|
|
||
Portugal |
PT |
|
|
Romania |
RO |
|
|
|
|||
Slovakia |
SK |
|
|
|
|||
Slovenia |
SI |
|
|
Spain |
ES |
|
|
Sweden |
SE |
|
|
|
|||
|
|
||
|
|
||
Switzerland |
CH |
|
|
United Kingdom |
GB |
|
|
|
|
||
|
|||
|
|||
|
|||
|
|
North American Driving Licenses
| Country | State | Code | Layout | Whitelist code |
|---|---|---|---|---|
Canada |
Alberta |
CA-AB |
|
|
British Columbia |
CA-BC |
|
|
|
Manitoba |
CA-MB |
|
|
|
Nova Scotia |
CA-NS |
|
|
|
Ontario |
CA-ON |
|
|
|
Quebec |
CA-QC |
|
|
|
Saskatchewan |
CA-SK |
|
|
|
United States |
Alabama |
US-AL |
|
|
Alaska |
US-AK |
|
|
|
Arizona |
US-AZ |
|
|
|
Arkansas |
US-AR |
|
|
|
California |
US-CA |
|
|
|
|
|
|||
Colorado |
US-CO |
|
|
|
|
|
|||
Connecticut |
US-CT |
|
|
|
Delaware |
US-DE |
|
|
|
District of Columbia |
US-DC |
|
|
|
Florida |
US-FL |
|
|
|
Georgia |
US-GA |
|
|
|
|
|
|||
Hawaii |
US-HI |
|
|
|
Idaho |
US-ID |
|
|
|
Illinois |
US-IL |
|
|
|
Indiana |
US-IN |
|
|
|
Iowa |
US-IA |
|
|
|
|
|
|||
Kansas |
US-KS |
|
|
|
Kentucky |
US-KY |
|
|
|
Louisiana |
US-LA |
|
|
|
Maine |
US-ME |
|
|
|
|
|
|||
Maryland |
US-MD |
|
|
|
Massachusetts |
US-MA |
|
|
|
Michigan |
US-MI |
|
|
|
Minnesota |
US-MN |
|
|
|
Mississippi |
US-MS |
|
|
|
Missouri |
US-MO |
|
|
|
|
|
|||
Montana |
US-MT |
|
|
|
Nebraska |
US-NE |
|
|
|
|
|
|||
Nevada |
US-NV |
|
|
|
New Hampshire |
US-NH |
|
|
|
New Jersey |
US-NJ |
|
|
|
|
|
|||
New Mexico |
US-NM |
|
|
|
New York |
US-NY |
|
|
|
North Carolina |
US-NC |
|
|
|
North Dakota |
US-ND |
|
|
|
Ohio |
US-OH |
|
|
|
Oklahoma |
US-OK |
|
|
|
Oregon |
US-OR |
|
|
|
|
|
|||
Pennsylvania |
US-PA |
|
|
|
Rhode Island |
US-RI |
|
|
|
South Carolina |
US-SC |
|
|
|
South Dakota |
US-SD |
|
|
|
Tennessee |
US-TN |
|
|
|
Texas |
US-TX |
|
|
|
|
|
|||
Utah |
US-UT |
|
|
|
|
|
|||
Vermont |
US-VT |
|
|
|
Virginia |
US-VA |
|
|
|
Washington |
US-WA |
|
|
|
West Virginia |
US-WV |
|
|
|
|
|
|||
Wisconsin |
US-WI |
|
|
|
Wyoming |
US-WY |
|
|
Oceanian Driving Licenses
| Country | State | Code | Layout | Whitelist code |
|---|---|---|---|---|
Australia |
Australian Capital Territory |
AU-ACT |
|
|
New South Wales |
AU-NSW |
|
|
|
Northern Territory |
AU-NT |
|
|
|
Queensland |
AU-QLD |
|
|
|
South Australia |
AU-SA |
|
|
|
Victoria |
AU-VIC |
|
|
|
Western Australia |
AU-WA |
|
|
|
New Zealand |
NZ |
|
|
African Driving Licenses
| Country | Code | Layout | Whitelist code |
|---|---|---|---|
Botswana |
BW |
|
|
Malawi |
MW |
|
|
Mozambique |
MZ |
|
|
South Africa |
ZA |
|
|
Zambia |
ZM |
|
|
Asian Driving Licenses
| Country | Code | Layout | Whitelist code |
|---|---|---|---|
Turkey |
TR |
|
|
European Identity Cards
Country |
Code |
Layout |
Whitelist code |
Austria |
AT |
|
|
|
|||
|
|||
|
|
||
Belgium |
BE |
|
|
|
|||
|
|||
Croatia |
HR |
|
|
|
|||
|
|
||
Czech Republic |
CZ |
|
|
|
|||
Estonia |
EE |
|
|
Finland |
FI |
|
|
France |
FR |
|
|
|
|||
|
|
||
Germany |
DE |
|
|
|
|
||
Hungary |
HU |
|
|
|
|||
|
|||
|
|||
Italy |
IT |
|
|
Latvia |
LV |
|
|
Lithuania |
LT |
|
|
|
|||
Luxembourg |
LU |
|
|
Moldova |
MD |
|
|
|
|||
Netherlands |
NL |
|
|
|
|||
Norway |
NO |
|
|
Poland |
PL |
|
|
|
|||
|
|||
Portugal |
PT |
|
|
|
|||
|
|||
|
|||
|
|||
Slovakia |
SK |
|
|
|
|||
|
|||
|
|||
|
|||
Slovenia |
SI |
|
|
Spain |
ES |
|
|
|
|
||
Sweden |
SE |
|
|
Switzerland |
CH |
|
|
|
|||
|
Military Identity cards
| Country | Code | Layout | Whitelist code |
|---|---|---|---|
Austria |
AT |
|
|
|
|
||
|
|
||
|
|
||
|
|
Disabled Identity cards
| Country | Code | Layout | Whitelist code |
|---|---|---|---|
Austria |
AT |
|
|
Pensioner Identity cards
| Country | Code | Layout | Whitelist code |
|---|---|---|---|
Austria |
AT |
|
|
North American Identity Cards
| Country | State | Code | Layout | Whitelist code |
|---|---|---|---|---|
Mexico |
MX |
|
|
|
|
|
|||
|
|
|||
United States |
Alabama |
US-AL |
|
|
Alaska |
US-AK |
|
|
|
Arizona |
US-AZ |
|
|
|
Arkansas |
US-AR |
|
|
|
California |
US-CA |
|
|
|
Colorado |
US-CO |
|
|
|
|
|
|||
Connecticut |
US-CT |
|
|
|
Delaware |
US-DE |
|
|
|
District of Columbia |
US-DC |
|
|
|
Florida |
US-FL |
|
|
|
Georgia |
US-GA |
|
|
|
Hawaii |
US-HI |
|
|
|
Idaho |
US-ID |
|
|
|
Illinois |
US-IL |
|
|
|
Indiana |
US-IN |
|
|
|
Iowa |
US-IA |
|
|
|
Kansas |
US-KS |
|
|
|
Kentucky |
US-KY |
|
|
|
|
|
|||
Maine |
US-ME |
|
|
|
Maryland |
US-MD |
|
|
|
Massachusetts |
US-MA |
|
|
|
Michigan |
US-MI |
|
|
|
Minnesota |
US-MN |
|
|
|
Mississippi |
US-MS |
|
|
|
Missouri |
US-MO |
|
|
|
Montana |
US-MT |
|
|
|
Nebraska |
US-NE |
|
|
|
|
|
|||
Nevada |
US-NV |
|
|
|
New Hampshire |
US-NH |
|
|
|
New Jersey |
US-NJ |
|
|
|
|
|
|||
New Mexico |
US-NM |
|
|
|
New York |
US-NY |
|
|
|
|
|
|||
North Carolina |
US-NC |
|
|
|
North Dakota |
US-ND |
|
|
|
Ohio |
US-OH |
|
|
|
Oklahoma |
US-OK |
|
|
|
|
|
|||
Oregon |
US-OR |
|
|
|
Pennsylvania |
US-PA |
|
|
|
Rhode Island |
US-RI |
|
|
|
South Carolina |
US-SC |
|
|
|
South Dakota |
US-SD |
|
|
|
Texas |
US-TX |
|
|
|
|
|
|||
Utah |
US-UT |
|
|
|
|
|
|||
Vermont |
US-VT |
|
|
|
Virginia |
US-VA |
|
|
|
Washington |
US-WA |
|
|
|
West Virginia |
US-WV |
|
|
|
Wisconsin |
US-WI |
|
|
|
Wyoming |
US-WY |
|
|
Asian Identity Cards
| State | Code | Layout | Whitelist code |
|---|---|---|---|
Hong Kong |
CN-HK |
|
|
|
|
||
Pakistan |
PK |
|
|
|
|
||
|
|
||
|
|
||
Turkey |
TR |
|
|
|
|
European Health Insurance Cards
Country |
Code |
Layout |
Whitelist code |
Austria |
AT |
|
|
France |
FR |
|
|
Germany |
DE |
|
|
Italy |
IT |
|
|
Spain |
ES |
|
|
United Kingdom |
GB |
|
|
Arabic Cards
These are all layouts supported with the Arabic script.
All fields containing Arabic text are postfixed with the tag @ara
|
The Arabic script currently supports the following characters: ', (, ), ,, -, ., /, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z, a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, s, t, u, v, w, x, y, z, Ä, Ö, Ü, ß, ä, ö, ü, ؟, ء, آ, أ, ؤ, إ, ئ, ا, ب, ة, ت, ث, ج, ح, خ, د, ذ, ر, ز, س, ش, ص, ض, ط, ظ, ع, غ, ـ, ف, ق, ك, ل, م, ن, ه, و, ى, ي, ٠, ١, ٢, ٣, ٤, ٥, ٦, ٧, ٨, ٩.
Any character not in this list will either be represented as it’s base character or omitted in the result.
|
Arabic Identity Cards
| State | Code | Layouts |
|---|---|---|
Algeria |
DZ |
|
Bahrain |
BH |
|
|
||
Egypt |
EG |
|
Jordan |
JO |
|
Kuwait |
KW |
|
Morocco |
MA |
|
|
||
Oman |
OM |
|
|
||
Qatar |
QA |
|
|
||
Saudi Arabia |
SA |
|
|
||
|
||
|
||
Tunisia |
TN |
|
United Arab Emirates |
AE |
|
Arabic Driving Licenses
| State | Code | Layouts |
|---|---|---|
Algeria |
DZ |
|
Bahrain |
BH |
|
|
||
Egypt |
EG |
|
Kuwait |
KW |
|
Morocco |
MA |
|
|
||
Oman |
OM |
|
Qatar |
QA |
|
Saudi Arabia |
SA |
|
Tunisia |
TN |
|
United Arab Emirates |
AE |
|
Cyrillic Cards
These are all layouts supported with the Cyrillic script.
All fields containing Cyrillic text are postfixed with the tag @cyr
|
The Cyrillic script currently supports the following characters: ', (, ), -, ., /, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z, a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, s, t, u, v, w, x, y, z, Ä, Ö, Ü, ß, ä, ö, ü, Б, Г, Д, Ж, З, И, Й, Л, П, Ф, Ц, Ч, Ш, Щ, Ъ, Ы, Ь, Э, Ю, Я, Ё, Ђ, Ѓ, Є, Ї, Љ, Њ, Ћ, Ќ, Џ, Ґ, б, в, г, д, ж, з, и, й, к, л, м, н, п, т, ф, ц, ч, ш, щ, ъ, ы, ь, э, ю, я, ё, ђ, ѓ, є, ї, љ, њ, ћ, ќ, џ, ґ.
Any character not in this list will either be represented as it’s base character or omitted in the result.
|
Filtering Scannable Documents Types
By default, every document supported by the ID plugin 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 Insurance 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.