Developer's Documentation for free mobile OCR SDK

Documentation Menu

Specifications

This section lists the languages available for text processing with ABBYY Real-Time Recognition SDK. Some of the languages have built-in dictionary support, which improves recognition quality but takes up additional memory.

dict — has dictionary support

extended — available only in the extended version

Afrikaans

Albanian

Basque

Belarusian extended

Breton

Bulgarian dictextended

Catalan

Chechen extended

Chinese Simplified extended

Chinese Traditional extended

Crimean Tatar extended

Croatian

Czech dict

Danish dict

Dutch (Belgium) dict

Dutch (Netherlands) dict

English dict

Estonian dict

Fijian

Finnish dict

French dict

German (old spelling) dict

German (new spelling) dict

Greek dict

Hawaiian

Hungarian

Icelandic

Indonesian dict

Irish

Italian dict

Japanese extended

Kabardian extended

Korean extended

Latin

Latvian

Lithuanian

Macedonian extended

Malay

Maori

Moldavian

Mongol extended

Norwegian (Bokmal) dict

Norwegian (Nynorsk) dict

Ossetic extended

Polish dict

Portuguese (Brazil) dict

Portuguese (Portugal) dict

Provencal

Rhaeto-Romanic

Romanian

Russian dictextended

Samoan

Serbian extended

Slovak

Slovenian

Spanish dict

Swahili

Swedish dict

Tagalog

Tatar extended

Turkish dict

Ukrainian dictextended

Welsh

The following language pairs are available for translation in the extended version of the distribution:

English to Chinese

Chinese to English

English to French

French to English

English to German

German to English

English to Indonesian

Indonesian to English

English to Japanese

Japanese to English

English to Polish

Polish to English

English to Portuguese (Brazil)

Portuguese (Brazil) to English

English to Russian

Russian to English

English to Spanish

Spanish to English

You can also create your own dictionary and use it for translation. Contact our technical support for advice on the required format.

This section describes the regular expression syntax supported by the ABBYY Real-Time Recognition SDK engine for capturing custom data fields (see Capture a Custom Data Field: iOS and Capture a Custom Data Field: Android).

note Note: All matches are always greedy (match as much as possible). The search stops at the first match: if a string contains two or more substrings matching your regular expression, only the first one (closest to the beginning) is matched.

Supported syntax

Pattern

Syntax

Examples and comments

Literal

any character or text, except metacharacters \^$.|?*+()[{

pill matches "pill" in "caterpillar"
a matches the first "a" in "caterpillar" but not the second (the search stops at the first match)

Metacharacters are part of regular expression syntax; to match these literally, you have to escape them with a backslash. If you want to match 1+1, the correct expression is 1\+1 — otherwise "+" has a special meaning.

Any character

. (dot)

s.t matches "sat", "sit" but not "seat"

Character set

[]

gr[ae]y matches both "gray" and "grey" but not "greay"

Character range in a set

- (minus)

[0-9] matches a single digit
concatenation is allowed: [a-zA-Z0-9] matches an alphanumeric character

Negated character set

[^]

[^0-9] matches anything that is not a digit

Shorthand classes

\s — any whitespace
\S — anything that is not a whitespace
\d — any digit
\D — anything that is not a digit
\w — a word character, which includes alphanumerics and punctuation marks
\W — a non-word character
\R — a new line character or the CR LF sequence
\v — a new line character but not the CR LF sequence
\V — a non-new line character
\h — a horizontal white space character
\H — anything except horizontal white space


Non-printable characters

\n — line feed LF
\r — carriage return CR
\t — tab character
\f — form feed
\a — bell character \u0007
\e — escape character


Unicode character

\uFFFF
\x{FFFF}

\u20AC or \x{20AC} matches the euro currency sign.

Character by its hexadecimal index

\xFF

\xA9 matches the copyright character in the Latin-1 character set

Alternation

|

abc|123 matches either "abc" or "123"
|word matches either an empty string "" or "word"

Repetitions

+
*
?
{n}
{n,m}
{n,}
{,m}

+ matches once or more times
* matches zero or more times
? matches zero times or once (optional match)
{n} matches exactly n times
{n,m} matches n to m times times
{n,} matches n or more times
{,m} matches zero or more times up to m

Note that all repetitions are greedy (prefer to match as much as possible): c.+r will match "caterpillar", not stopping with "cater". If you want to match up to the first occurence of a certain character, use its negation: c[^r]+r will match "cater" in "caterpillar".

Grouping

()

(word)+ matches "word", "wordword" and so on

Unsupported syntax

The following regular expression syntax features are not yet supported in ABBYY Real-Time Recognition SDK:

  • Anchors: ^ (beginning of a line), $ (end of a line), \b (word boundary) and its negation \B, and other.
  • Lazy quantifiers such as +? or {n,m}? that prefer to match as few times as possible.
  • Concatenation with nested character sets such as [[a-z][0-9]].
  • Advanced features such as lookarounds, backreferences, possessive matches, named groups, non-capturing and atomic match groups, evaluation flag settings and other.

ABBYY Real-Time Recognition SDK supports a whole range of identity documents out of the box. Consult the table below for a full list. For the detailed profile specifications, see Data Capture Profiles.

Document

Supported in

All documents with Machine Readable Zone (MRZ)

All Countries

Bank cards: embossed and indent

All Countries

Driver’s license

Austria, Belarus, Belgium, Czech Republic, Finland, Germany, Greece, Hungary, Israel, Italy, Japan, New Zealand, Norway, Poland, Portugal, Russian Federation, Serbia, Spain, Sweden, Switzerland, Turkey, UK, USA (Alabama, Arizona, California, Florida, Washington DC, Massachusetts, Maine, Michigan, New Mexico, Texas, Washington)

International Passport

Austria, China, Georgia, Germany, India, Italy, Japan, Philippines, Russian Federation, Syria, Tajikistan, UK, USA, Uzbekistan

National ID card

Armenia, Austria, Bahrain, Belgium, Bulgaria, Chile, Croatia, Czech Republic, Estonia, Finland, France, Georgia, Germany, Hong Kong, Hungary, Kazakhstan, Kuwait, Kyrgyzstan, Latvia, Lithuania, Malaysia, Nigeria, Norway, Poland, Portugal, Romania, El Salvador, Serbia, Singapore, South Africa, Spain, Switzerland, Turkey, UAE

National passport

Belarus, Russian Federation

Aadhaar card

India

Birth certificate

Russian Federation

Personal insurance policy number

Russian Federation

Vehicle Registration Certificate (STS)

Russian Federation

VISA

Russian Federation

Health insurance card

Japan

Work permit

Singapore

Residence permit

Spain

Permanent residency card

USA

The countries and documents mentioned are supported in technical preview mode. We are working to improve our technologies.

iOS

iOS version: 8.x or later

Supported devices:

  • iPhone 5 or newer
  • iPad Pro
  • iPad (4th generation)
  • iPad Air or newer
  • iPad mini or newer

Android

Android version: 4.4 or later for ARMv7 (armeabi-v7a) and ARMv8 (arm64-v8a) processors

Processor:

  • Arm NEON support
  • multi-core (augmented reality scenarios require 4 cores)

Camera:

  • autofocus lens
  • HD preview: generally recommended frame size is 720×1280, but it can vary depending on the scenario and processing speed

Memory requirements

Library operation in the text capture scenario takes up to:

  • for texts in alphabetic languages — 40 MB RAM
  • for texts in Chinese, Japanese, or Korean languages — 70 MB RAM

Library operation in the data capture scenario takes up to 105 MB RAM for iOS and 170 MB RAM for Android.

The following table lists predefined capture profiles and corresponding result data schemes. Profile name is specified when creating a Data Capture service, and result scheme identifiers are returned by the service.

note Note: Predefined data capture profiles are available only in the extended version of the library.

Document type

Profile name

Result scheme

Result description

Bank card

BankCards

BankCardEmbossed

Bank cards with embossed fields (front side)

BankCardUnembossed

Bank cards with indent-printed fields (front side)

International bank account number

IBAN

IBAN

International bank account number

Machine-readable document zone

MRZ

MRZ

MRZ of a passport

MRZ_MRP

ICAO Doc 9303 machine-readable passports (2 lines, 44 characters each)

MRZ_MRV_A

ICAO Doc 9303 machine-readable visa MRV-A (2 lines, 44 characters each)

MRZ_MRV_B

ICAO Doc 9303 machine-readable visa MRV-B (2 lines, 36 characters each)

MRZ_TD1

ICAO Doc 9303 machine-readable travel document TD-1 (3 lines, 30 characters each)

MRZ_TD2

ICAO Doc 9303 machine-readable travel document TD-2 (2 lines, 36 characters each)

MRZ_BG

MRZ-like zone of the Bulgarian vehicle registration document (3 lines, 30 characters each)

MRZ_CH

MRZ-like zone of the Swiss driver's license (3 lines, 9, 30 and 30 characters)

MRZ_FR

MRZ-like zone of the French national identity card (2 lines, 36 characters each)

MRZ_RU

MRZ-like zone of the Russian passport (2 lines, 44 characters each)

MRZ_MRV_RU

MRZ-like zone of the Russian visa (2 lines, 44 characters each)

Armenian ID card

ID_AM

ID_AM_TYPE1

Armenian ID card (front)

Austrian passport

InternationalPassport_AT

InternationalPassport_AT

Austrian international passport (main page)

Austrian ID card

ID_AT

ID_AT

Austrian ID card (front)

Austrian driver's license

DriverLicense_AT

DriverLicense_AT_TYPE1

Austrian driver's license with the title at the top (front side)

DriverLicense_AT_TYPE2

Austrian driver's license with the title in the top-right corner (front side)

Bahrain ID card

ID_BH

ID_BH_TYPE1

Bahrain ID card (front)

Belarusian passport

Passport_BY

Passport_BY

Belarusian passport (main page)

Passport_BY_PAGE31

Belarusian passport (page 31)

Belarusian driver's license

DriverLicense_BY

DriverLicense_BY

Belarusian driver's license (front side)

Belgium ID card

ID_BE

ID_BE

Belgium ID card (front side)

Belgium driving license

DriverLicense_BE

DriverLicense_BE_TYPE1

Belgium driving license, in English (front side)

British passport

InternationalPassport_UK

InternationalPassport_UK_TYPE1

Non-biometric British passport (main page)

InternationalPassport_UK_TYPE2

Biometric British passport (main page)

British driver's license

DriverLicense_UK

DriverLicense_UK_TYPE1

British driver's license (front side)

DriverLicense_UK_TYPE2

British driver's license with a logo on the right (front side)

DriverLicense_UK_PROVISIONAL

British driver's license, provisional (front side)

Bulgarian ID card

ID_BG

ID_BG_TYPE1

Bulgarian ID card (new type, front side)

ID_BG_TYPE2

Bulgarian ID card (old type, front side)

Chile ID card

ID_CL

ID_CL_TYPE1

Chile identity card (front side)

Chinese passport

InternationalPassport_CN

InternationalPassport_CN_TYPE1

Chinese passport (old type, main page)

InternationalPassport_CN_TYPE2

Chinese passport (new type, main page)

Croatian ID card

ID_HR

ID_HR_TYPE1

Croatian identity card (older type, front side)

ID_HR_TYPE2

Croatian identity card (newer type, front side)

Czech ID card

ID_CZ

ID_CZ

Czech ID card (front side)

Czech driver's license

DriverLicense_CZ

DriverLicense_CZ

Czech driver's license card (front side)

Estonian ID card

ID_EE

ID_EE

Estonian ID card (front side)

Finnish ID card

ID_FI

ID_FI_TYPE1

Finnish identity card (older type, front side)

ID_FI_TYPE2

Finnish identity card (newer type, front side)

Finnish driver's license

DriverLicense_FI

DriverLicense_FI

Finnish driver's license (front side)

French ID card

ID_FR

ID_FR_TYPE1

French identity card (front side)

Georgian ID card

ID_GE

ID_GE_TYPE1

Georgian identity card (front side)

Georgian passport

InternationalPassport_GE

InternationalPassport_GE_TYPE1

Georgian passport (newer type, main page)

InternationalPassport_GE_TYPE2

Georgian passport (older type, main page)

German passport

InternationalPassport_DE

InternationalPassport_DE_TYPE1

German passport (main page)

InternationalPassport_DE_TYPE2

German passport (main page), with two lines for the first name

German ID card

ID_DE

ID_DE_TYPE1

German ID card (front side)

ID_DE_TYPE2

German ID card with TD-1 MRZ on the front (front side)

German driver's license

DriverLicense_DE

DriverLicense_DE

German driver's license (front side)

Greek driving license

DriverLicense_GR

DriverLicense_GR_TYPE1

Greek driving license (front side)

Hong Kong ID card

ID_HK

ID_HK_TYPE1

Hong Kong identity card (front side)

Hungarian driver's license

DriverLicense_HU

DriverLicense_HU_TYPE1

Hungarian driver's license (front side)

Hungarian ID card

ID_HU

ID_HU_TYPE1

Hungarian identity card (older type, front side)

ID_HU_TYPE2

Hungarian identity card (newer type, front side)

Indian Aadhaar card

Aadhaar_IN

Aadhaar_IN_TYPE1

Indian card with Aadhaar number

Indian passport

InternationalPassport_IN

InternationalPassport_IN

Indian passport (main page)

Israeli driver's license

DriverLicense_IL

DriverLicense_IL

Israeli driver's license (front side)

Italian passport

InternationalPassport_IT

InternationalPassport_IT

Italian passport (main page)

Italian driver's license

DriverLicense_IT

DriverLicense_IT_TYPE1

Italian driver's license (new type, front side)

DriverLicense_IT_TYPE2

Italian driver's license (issued 2007-2013, front side)

Japanese passport

InternationalPassport_JP

InternationalPassport_JP

Japanese passport (main page)

Japanese driver's license

DriverLicense_JP

DriverLicense_JP

Japanese driver's license (front side)

Japanese health insurance

HealthInsuranceCard_JP

HealthInsuranceCard_JP

Japanese health insurance card (front side)

Kazakhstan ID card

ID_KZ

ID_KZ_TYPE1

Kazakhstan ID card with 2-line MRZ (front and back sides)

ID_KZ_TYPE2

Kazakhstan ID card with 3-line MRZ (front and back sides)

Kuwait ID card

ID_KW

ID_KW_TYPE1

Kuwait ID card (card-size, front side)

Kyrgyzstani ID card

ID_KG

ID_KG

Kyrgyzstani ID card (front and back)

Latvian ID card

ID_LV

ID_LV

Latvian ID card (front side)

Lithuanian ID card

ID_LT

ID_LT_TYPE1

Lithuanian ID card (front side)

Malaysian ID card

ID_MY

ID_MY

Malaysian ID card (front side)

New Zealand driving license

DriverLicense_NZ

DriverLicense_NZ_TYPE1

New Zealand driving license (new type, front side)

Nigerian ID card

ID_NG

ID_NG_TYPE1

Nigerian ID card (front side)

Norwegian driving license

DriverLicense_NO

DriverLicense_NO_TYPE1

Norwegian driving license (front side)

Norwegian ID card

ID_NO

ID_NO_TYPE1

Norwegian ID card (front side)

Philippine passport

InternationalPassport_PH

InternationalPassport_PH_TYPE1

Non-biometric Philippine passport (main page)

InternationalPassport_PH_TYPE2

Biometric Philippine passport (main page)

Polish ID card

ID_PL

ID_PL_TYPE1

Polish ID card, older type (front and back)

ID_PL_TYPE2

Polish ID card, newer type (front and back)

Polish driver's license

DriverLicense_PL

DriverLicense_PL_TYPE1

Polish driver's license, old type (front side)

Portuguese ID card

ID_PT

ID_PT_TYPE1

Portuguese ID card (front side)

Portuguese driver's license

DriverLicense_PT

DriverLicense_PT_TYPE1

Portuguese driver's license (front side)

Romanian ID card

ID_RO

ID_RO

Romanian ID card (front side)

Russian international biometric passport

InternationalPassport_RU

InternationalPassport_RU

Russian international biometric passport (main page)

Russian visa

Visa_RU

Visa_RU_TYPE1

Russian visa

Russian passport

Passport_RU

Passport_RU

Russian passport (pages 2 and 3)

Passport_RU_Top

Russian passport (page 2, with signatures)

Passport_RU_Bottom

Russian passport (page 3, with a photo)

Russian birth certificate

BirthCertificate_RU

BirthCertificate_RU_TYPE1

Russian birth certificate

Russian insurance individual account number (SNILS)

SocialSecurityNumber_RU

SocialSecurityNumber_RU_TYPE1

Laminated SNILS (front side)

SocialSecurityNumber_RU_TYPE2

Card-size SNILS (front side)

Russian driver's license

DriverLicense_RU

DriverLicense_RU

Russian driver's license, new type (front side)

DriverLicense_RU_TYPE1

Russian driver's license, old type (front side)

DriverLicense_RU_TYPE2

Russian driver's license, old type, vertical (front side)

DriverLicense_RU_TYPE3

Russian driver's license, new type (front side)

Russian vehicle registration certificate

VehicleRegistration_RU

VehicleRegistration_RU_TYPE1

Russian vehicle registration certificate, old type (front and back sides)

VehicleRegistration_RU_TYPE2

Russian vehicle registration certificate, new type (front and back sides)

Salvadorean ID card

ID_SV

ID_SV_TYPE1

Salvadorean ID card (front side)

Serbian driving license

DriverLicense_RS

DriverLicense_RS_TYPE1

Serbian driving license (front side)

Serbian ID card

ID_RS

ID_RS_TYPE1

Serbian ID card (front side)

Singapore ID card

ID_SG

ID_SG

Singapore ID card (front side)

Singapore work permit

WorkPermit_SG

WorkPermit_SG_TYPE1

Singapore work permit (front side)

South African Republic ID card

ID_ZA

ID_ZA_TYPE1

South African Republic ID card (front side)

Spanish ID card

ID_ES

ID_ES_TYPE1

Spanish ID card (old type, front side)

ID_ES_TYPE2

Spanish ID card (new type, front side)

Spanish driving license

DriverLicense_ES

DriverLicense_ES_TYPE1

Spanish driving license (older type, front side)

DriverLicense_ES_TYPE2

Spanish driving license (newer type, front side)

Spanish residence permit

ResidencePermit_ES

ResidencePermit_ES_TYPE1

Spanish residence permit, blue color (front side)

ResidencePermit_ES_TYPE2

Spanish residence permit, pink color (front side)

Swedish driver's license

DriverLicense_SE

DriverLicense_SE_TYPE1

Swedish driver's license with a photo near the signature (front side)

DriverLicense_SE_TYPE2

Swedish driver's license with a logo on the right (front side)

Swiss ID card

ID_CH

ID_CH_TYPE1

Swiss ID card (front side)

Swiss driver's license

DriverLicense_CH

DriverLicense_CH_TYPE1

Swiss driver's license (front side)

Syrian passport

InternationalPassport_SY

InternationalPassport_SY

Syrian passport (main page)

Tajikistani passport

InternationalPassport_TJ

InternationalPassport_TJ_TYPE1

Tajikistani passport in Latin only (main page)

Turkish ID card

ID_TR

ID_TR_TYPE1

Turkish ID card (front side)

Turkish driver's license

DriverLicense_TR

DriverLicense_TR_TYPE1

Turkish driver's license (front side)

UAE ID card

ID_AE

ID_AE_TYPE1

UAE ID card (front side)

USA passport

InternationalPassport_US

InternationalPassport_US_TYPE1

USA passport, old type (main page)

InternationalPassport_US_TYPE2

USA passport, new type (main page)

USA driver's license

DriverLicense_US

DriverLicense_US_AL_TYPE1

USA Alabama driver's license (front side)

DriverLicense_US_AZ_TYPE1

USA Arizona driver's license, card size (front side)

DriverLicense_US_CA_TYPE1

USA California driver's license, card size (front side)

DriverLicense_US_DC_TYPE1

USA Washington DC driver's license, older type (front side)

DriverLicense_US_DC_TYPE2

USA Washington DC driver's license, newer type (front side)

DriverLicense_US_FL_TYPE1

USA Florida driver's license (front side)

DriverLicense_US_MA_TYPE1

USA Massachusetts driver's license, card size (front side)

DriverLicense_US_ME_TYPE1

USA Maine driver's license (front side)

DriverLicense_US_MI_TYPE1

USA Michigan driver's license (front side)

DriverLicense_US_NM_TYPE1

USA New Mexico driver's license, card size (front side)

DriverLicense_US_TX_TYPE1

USA Texas driver's license (front side)

DriverLicense_US_WA_TYPE1

USA Washington driver's license (front side)

USA permanent residency card (Green card)

GreenCard_US

GreenCard_US_TYPE1

USA permanent residency card, also known as Green card (front side)

Uzbek passport

InternationalPassport_UZ

InternationalPassport_UZ_TYPE1

Uzbek passport (main page)

The following table lists field identifiers used in result data schemes returned by the Data Capture service.

Scheme

Field

Field description

Comments

Aadhaar_IN_TYPE1

Number

Aadhaar number

 

BankCardEmbossed
BankCardUnembossed

Number

Card number

 

FullName

Cardholder's full name

 

DateOfExpiry

Card expiry date

 

BirthCertificate_RU_TYPE1

FullNumber

Full document number (series and number, including the number sign)

 

Series

Document series (two Latin and two Cyrillic letters, separated by a hyphen)

 

Number

Document number (not including the number sign)

 

DateOfIssue

Document issue date

 

DayOfIssue

The day of issue date

 

MonthOfIssue

The month of issue date

 

YearOfIssue

The year of issue date

 

Sex

Document holder's sex

 

LastName

Document holder's last name

 

FirstName

Document holder's first name

 

MiddleName

Document holder's patronymic name

 

FirstNameMiddleName

Document holder's first name and patronymic

 

DateOfBirth

Document holder's birth date

 

DriverLicense_AT_TYPE1
DriverLicense_AT_TYPE2

Number

License number

 

LastName

Driver's last name

 

FirstName

Driver's first name

 

DateOfBirthPlaceOfBirth

Driver's date and place of birth

 

DateOfIssue

Document issue date

 

DateOfExpiry

Document expiry date

In the DriverLicense_AT_TYPE1 scheme only

PlaceOfIssue

Region where the license was issued

 

DriverLicense_BE_TYPE1

DateOfIssue

License issue date

 

LastName

Driver's last name

 

FirstName

Driver's first name

 

Number

License number

 

DateOfExpiry

License expiry date

 

DateOfBirth

Driver's date of birth

 

DriverLicense_BY

Number

License number

 

LastName

Driver's last name

 

FirstName

Driver's first name

 

MiddleName

Driver's patronymic name

 

FirstNameMiddleName

Driver's first and patronymic names

 

DateOfBirth

Driver's date of birth

 

PlaceOfBirth

Driver's place of birth

 

DateOfIssue

License issue date

 

DateOfExpiry

License expiry date

 

DriverLicense_CH_TYPE1

Number

License number

 

LastName

Driver's last name

 

FirstName

Driver's first name

 

DateOfBirth

Driver's date of birth

 

PlaceOfBirth

Driver's place of birth

 

PlaceOfIssue

Region where the license was issued

 

DateOfIssue

License issue date

 

DateOfExpiry

License expiry date

 

DriverLicense_CZ

Number

License number

 

DriverID

Driver's personal identifier

 

LastName

Driver's last name

 

FirstName

Driver's first name

 

DateOfBirth

Driver's date of birth

 

DateOfIssue

License issue date

 

DateOfExpiry

License expiry date

 

DriverLicense_DE

Number

License number

 

LastName

Driver's last name

 

LastName_LINE2

Second line of the driver's last name

 

FirstName

Driver's first name

 

DateOfIssue

License issue date

 

PlaceOfBirth

Driver's place of birth

 

DateOfBirth

Driver's date of birth

 

PlaceOfIssue

Region where the license was issued

 

PlaceOfIssue_LINE2

Region where the license was issued, continued

 

DriverLicense_ES_TYPE1
DriverLicense_ES_TYPE2

DateOfIssue

License issue date

 

DateOfBirth

Driver's date of birth

 

FirstName

Driver's first name

 

LastName

Driver's last name

 

LastName_LINE2

Driver's last name, continued

 

Number

License number

 

DateOfExpiry

License expiry date

 

DriverLicense_FI

Number

License number

 

DriverID

Driver's personal identifier

 

LastName

Driver's last name

 

FirstName

Driver's first name

 

Nationality

Driver's nationality

 

DateOfBirth

Driver's date of birth

 

DateOfIssue

License issue date

 

DateOfExpiry

License expiry date

 

PlaceOfIssue

Region where the license was issued

 

DriverLicense_GR_TYPE1

LastName

Driver's last name

 

FirstName

Driver's first name

 

DateOfBirth

Driver's birth date

 

DateOfIssue

License issue date

 

DateOfExpiry

License expiry date

 

IssuedBy

The authority that issued the license

 

PersonalCode

Driver's personal code

 

Number

License number

 

DriverLicense_HU_TYPE1

FirstName

Driver's first name

 

LastName

Driver's last name

 

DateOfIssue

License issue date

 

DateOfExpiry

License expiry date

 

DateOfBirth

Driver's birth date

 

Number

License number

 

DriverLicense_IL

Number

License number

 

DriverID

Driver's personal identifier

 

LastName

Driver's last name

 

FirstName

Driver's first name

 

DateOfBirth

Driver's date of birth

 

DateOfIssue

License issue date

 

DateOfExpiry

License expiry date

 

DriverLicense_IT_TYPE1
DriverLicense_IT_TYPE2

Number

License number

 

LastName

Driver's last name

 

FirstName

Driver's first name

 

DateOfBirth

Driver's date of birth

 

DateOfIssue

License issue date

 

DateOfExpiry

License expiry date

 

DriverLicense_JP

Number

License number

 

DriverLicense_NO_TYPE1

FirstName

Driver's first name

 

LastName

Driver's last name

 

DateOfIssue

License issue date

 

DateOfExpiry

License expiry date

 

DateOfBirth

Driver's birth date

 

Number

License number

 

IssuedBy

The authority that issued the license

 

ReferenceNumber

Reference number

 

DriverLicense_NZ_TYPE1

Number

License number

 

Version

License version

 

DateOfBirth

Driver's birth date

 

LastName

Driver's last name

 

FirstName

Driver's first name

 

FullName_LINE2

Additional line for driver's name

 

DriverLicense_PL_TYPE1

LastName

Driver's last name

 

FirstName

Driver's first name

 

Number

License number

 

DateOfBirth

License birth date

 

DateOfIssue

License issue date

 

DriverLicense_PT_TYPE1

Number

License number

 

DriverID

Driver's personal identifier

 

LastName

Driver's last name

 

FirstName

Driver's first name

 

DateOfBirth

Driver's date of birth

 

DateOfIssue

License issue date

 

DateOfExpiry

License expiry date

 

DriverLicense_RS_TYPE1

FirstName

Driver's first name

 

LastName

Driver's last name

 

DateOfExpiry

License expiry date

 

DateOfIssue

License issue date

 

Number

License number

 

IssuedBy

The authority that issued the license

 

DriverLicense_RU
DriverLicense_RU_TYPE1
DriverLicense_RU_TYPE2
DriverLicense_RU_TYPE3

Number

License number

 

Number_EX

License number

In the DriverLicense_RU_TYPE2 scheme only. Some licenses of this type contain an additional field that repeats the license number. The numbers recognized from the Number and Number_EX fields should be the same.

LastName

Driver's last name

 

FirstName

Driver's first name

Except the DriverLicense_RU scheme

MiddleName

Driver's patronymic name

Except the DriverLicense_RU scheme

FirstNameMiddleName

Driver's first and patronymic names

In the DriverLicense_RU, DriverLicense_RU_TYPE1 schemes only

Sex

Driver's sex

 

DateOfBirth

Driver's date of birth

 

PlaceOfBirth

Driver's place of birth

In the DriverLicense_RU scheme only

RegionOfResidence

Driver's region of residence

In the DriverLicense_RU scheme only

IssuedBy

The authority that issued the license

In the DriverLicense_RU scheme only

DateOfIssue

License issue date

 

DateOfExpiry

License expiry date

 

DriverLicense_SE_TYPE1
DriverLicense_SE_TYPE2

Number

License number

 

DriverID

Driver's personal identifier

 

LastName

Driver's last name

 

FirstName

Driver's first name

 

DateOfBirth

Driver's date of birth

 

DateOfIssue

License issue date

 

DateOfExpiry

License expiry date

 

DriverLicense_TR_TYPE1

Number

License number

 

DriverID

Driver's personal identifier

 

LastName

Driver's last name

 

FirstName

Driver's first name

 

DateOfBirth

Driver's date of birth

 

DateOfIssue

License issue date

 

DateOfExpiry

License expiry date

 

DriverLicense_UK_TYPE1
DriverLicense_UK_TYPE2
DriverLicense_UK_PROVISIONAL

Number

License number

 

LastName

Driver's last name

 

FirstName

Driver's first name

 

DateOfBirth

Driver's date of birth

 

PlaceOfBirth

Driver's place of birth

 

DateOfBirthPlaceOfBirth

Driver's date and place of birth

 

DateOfIssue

License issue date

 

DateOfExpiry

License expiry date

 

IssuedBy

The authority that issued the license

 

DriverLicense_US_AL_TYPE1
DriverLicense_US_AZ_TYPE1
DriverLicense_US_CA_TYPE1
DriverLicense_US_DC_TYPE1
DriverLicense_US_DC_TYPE2
DriverLicense_US_FL_TYPE1
DriverLicense_US_MA_TYPE1
DriverLicense_US_ME_TYPE1
DriverLicense_US_MI_TYPE1
DriverLicense_US_NM_TYPE1
DriverLicense_US_TX_TYPE1
DriverLicense_US_WA_TYPE1

Number

License number

 

LastName

Driver's last name

Except the DriverLicense_US_DC_TYPE1 and DriverLicense_US_MI_TYPE1 schemes

FirstName

Driver's first name

Except the DriverLicense_US_DC_TYPE1 and DriverLicense_US_MI_TYPE1 schemes

FirstName_LINE2

Second line of the driver's first name

In the DriverLicense_US_DC_TYPE2 scheme only

FullName

Driver's full name

In the DriverLicense_US_DC_TYPE1 and DriverLicense_US_MI_TYPE1 schemes only

DateOfBirth

Driver's date of birth

 

DateOfIssue

License issue date

 

DateOfExpiry

License expiry date

 

HealthInsuranceCard_JP

SerialNumber

Insurance number

 

InsuranceType

Insurance type

 

InsurerNumber

Insurer number

 

OrganizationCode

Insurer code

 

GreenCard_US_TYPE1

LastName

Document holder's last name

 

FirstName

Document holder's first name

 

Number

Document number

 

Category

Category of residency

 

DateOfBirth

Document holder's birth date

 

Sex

Document holder's sex

 

DateOfExpiry

Document expiry date

 

ResidentSince

The residency start date

 

IBAN

IBAN

International bank account number

 

ID_AE_TYPE1

Number

Document number

 

ID_AM_TYPE1

LastName

Document holder's last name

 

LastName_EX

Document holder's last name in English

 

FirstName

Document holder's first name

 

FirstName_EX

Document holder's first name in English

 

MiddleName

Document holder's patronymic name

 

Sex

Document holder's sex

 

DateOfBirth

Document holder's date of birth

 

DateOfExpiry

Document expiry date

 

Number

Document number

 

ID_AT

Number

Document number

 

LastName

Document holder's last name

 

FirstName

Document holder's first name

 

Sex

Document holder's sex

 

DateOfBirth

Document holder's date of birth

 

ID_BE

Number

Document number

 

LastName

Document holder's last name

 

FirstName

Document holder's first name

 

Sex

Document holder's sex

 

Nationality

Nationality of the document holder

 

DateOfIssue

Document issue date

 

DateOfExpiry

Document expiry date

 

ID_BG_TYPE1
ID_BG_TYPE2

Number

Document number

 

PersonalCode

Document holder's personal code

 

LastName

Document holder's last name

 

FirstName

Document holder's first name

 

MiddleName

Document holder's patronymic name

 

Sex

Document holder's sex

 

DateOfBirth

Document holder's date of birth

 

Address

Document holder's address

 

DateOfIssue

Document issue date

 

DateOfExpiry

Document expiry date

 

City

The city where the document was issued

From the back side; in the ID_BG_TYPE2 scheme only

RegionOfResidence

Document holder's region of residence

From the back side

Municipality

Municipal district

From the back side; in the ID_BG_TYPE2 scheme only

MRZ

Full contents of the machine-readable zone

 

Number_MRZ

Document number from MRZ

 

PersonalCode_MRZ

Document holder's personal code from MRZ

 

LastName_MRZ

Document holder's last name from MRZ

 

FirstName_MRZ

Document holder's first name from MRZ

 

Sex_MRZ

Document holder's sex from MRZ

 

DateOfBirth_MRZ

Document holder's date of birth from MRZ

 

DateOfBirth_FORMATTED

Formatted document holder's date of birth from MRZ

 

DateOfExpiry_MRZ

Document expiry date from MRZ

 

DateOfExpiry_FORMATTED

Formatted document expiry date from MRZ

 

ID_BH_TYPE1

Number

Document number

 

FullName

Document holder's full name

 

DateOfExpiry

Document expiry date

 

ID_CH_TYPE1

Number

Document number

 

LastName

Document holder's last name

 

FirstName

Document holder's first name

 

DateOfBirth

Document holder's date of birth

 

ID_CL_TYPE1

LastName

Document holder's last name

 

LastName_LINE2

Second line of the Document holder's last name

 

FirstName

Document holder's first name

 

Nationality

Document holder's nationality

 

Sex

Document holder's sex

 

DateOfBirth

Document holder's date of birth

 

DateOfIssue

Document issue date

 

DateOfExpiry

Document expiry date

 

Number

Document number

 

ID_CZ

Number

Document number

 

LastName

Document holder's last name

 

FirstName

Document holder's first name

 

Sex

Document holder's sex

 

DateOfBirth

Document holder's date of birth

 

DateOfIssue

Document issue date

 

DateOfExpiry

Document expiry date

 

ID_DE_TYPE1
ID_DE_TYPE2

Number

Document number

 

LastName

Document holder's last name

 

LastName_LINE2

Second line of the Document holder's last name

 

FirstName

Document holder's first name

 

DateOfBirth

Document holder's date of birth

 

DateOfBirthNationality

Document holder's date of birth and nationality

In the ID_DE_TYPE1 scheme only

DateOfBirthPlaceOfBirth

Document holder's date and place of birth

In the ID_DE_TYPE2 scheme only

PlaceOfBirth

Document holder's place of birth

 

Address_LINE1

Document holder's address

 

Address_LINE2

Document holder's address, continued

 

Address_LINE3

Document holder's address, continued

 

Nationality

Nationality of the document holder

In the ID_DE_TYPE2 scheme only

Height

Document holder's height

In the ID_DE_TYPE1 scheme only

EyeColor

Document holder's eye color

In the ID_DE_TYPE1 scheme only

IssuedBy

The authority that issued the license

In the ID_DE_TYPE1 scheme only

DateOfIssue

Document issue date

In the ID_DE_TYPE1 scheme only

DateOfExpiry

Document expiry date

 

RFID

RFID number

In the ID_DE_TYPE1 scheme only

MRZ

Full contents of the machine-readable zone

 

Number_MRZ

Document number from MRZ

 

LastName_MRZ

Document holder's last name from MRZ

 

FirstName_MRZ

Document holder's first name from MRZ

 

DateOfBirth_MRZ

Document holder's date of birth from MRZ

 

DateOfBirth_FORMATTED

Formatted date of birth from MRZ

 

DateOfExpiry_MRZ

Document expiry date from MRZ

 

DateOfExpiry_FORMATTED

Formatted document expiry date from MRZ

 

ID_EE

Number

Document number

 

PersonalCode

Document holder's personal code

 

LastName

Document holder's last name

 

FirstName

Document holder's first name

 

FirstName_EX

Document holder's first name, continued

 

Sex

Document holder's sex

 

Nationality

Nationality of the document holder

 

DateOfBirth

Document holder's date of birth

 

DateOfExpiry

Document expiry date

 

ID_ES_TYPE1
ID_ES_TYPE2

Number

Document number

 

IDESP

Identity card serial number

 

LastName

Document holder's last name

 

LastName_LINE2

Second line of the Document holder's last name

 

FirstName

Document holder's first name

 

Sex

Document holder's sex

 

Nationality

Nationality of the document holder

 

DateOfBirth

Document holder's date of birth

 

DateOfExpiry

Document expiry date

 

ID_FI_TYPE1
ID_FI_TYPE2

LastName

Document holder's last name

 

FirstName

Document holder's first name

 

DateOfIssue

Document issue date

 

DateOfExpiry

Document expiry date

 

DateOfBirth

Document holder's date of birth

 

Number

Document number

 

Sex

Document holder's sex

In the ID_FI_TYPE2 scheme only

ID_FR_TYPE1

Number

Document number

 

LastName

Document holder's last name

 

FirstName

Document holder's first name

 

DateOfBirth

Document holder's date of birth

 

Sex

Document holder's sex

 

MRZ

Full contents of the machine-readable zone

 

FirstName_MRZ

Document holder's first name from MRZ

 

LastName_MRZ

Document holder's last name from MRZ

 

Number_MRZ

Document number from MRZ

 

Sex_MRZ

Document holder's sex from MRZ

 

DateOfBirth_MRZ

Document holder's date of birth from MRZ

 

DateOfBirth_FORMATTED

Formatted date of birth from MRZ

 

IssuingStateCode

Code of the country that issued the document

 

DocumentType_MRZ

Document type from MRZ

 

ID_GE_TYPE1

FirstName

Document holder's first name

 

FirstName_EX

Document holder's first name in English

 

LastName

Document holder's last name

 

LastName_EX

Document holder's last name in English

 

Number

Document number

 

PersonalCode

Document holder's personal code

 

DateOfBirth

Document holder's birth date

 

DateOfExpiry

Document expiry date

 

ID_HK_TYPE1

Number

Document number

 

Code

Document code

 

FullName

Document holder's full name

 

DateOfBirth

Document holder's birth date

 

DateOfIssue

Document issue date

 

ID_HR_TYPE1
ID_HR_TYPE2

LastName

Document holder's last name

 

FirstName

Document holder's first name

 

DateOfBirth

Document holder's birth date

 

DateOfExpiry

Document expiry date

 

Number

Document number

 

Sex

Document holder's sex

 

Nationality

Nationality of the document holder

 

ID_HU_TYPE1
ID_HU_TYPE2

FullName

Document holder's full name

 

Number

Document number

 

DateOfBirth

Document holder's birth date

In ID_HU_TYPE2 scheme only

DateOfExpiry

Document expiry date

In ID_HU_TYPE2 scheme only

Sex

Document holder's sex

In ID_HU_TYPE2 scheme only

CardAccessNumber

Card access number

In ID_HU_TYPE2 scheme only

ID_KG

Number

Document number

 

PersonalCode

Document holder's personal code

 

LastName

Document holder's last name

 

FirstName

Document holder's first name

 

MiddleName

Document holder's patronymic name

 

Sex

Document holder's sex

 

Nationality

Nationality of the document holder

 

DateOfBirth

Document holder's date of birth

 

PlaceOfBirth

Document holder's place of birth

 

MaritalStatus

Document holder's marital status

 

Address

Document holder's address

 

Address_LINE2

Second line of the Document holder's address

 

IssuedBy

The authority that issued the document

 

DateOfIssue

Document issue date

 

DateOfExpiry

Document expiry date

 

MRZ

Full contents of the machine-readable zone

 

Number_MRZ

Document number from MRZ

 

PersonalCode_MRZ

Document holder's personal code from MRZ

 

LastName_MRZ

Document holder's last name from MRZ

 

FirstName_MRZ

Document holder's first name from MRZ

 

Sex_MRZ

Document holder's sex from MRZ

 

DateOfBirth_MRZ

Document holder's date of birth from MRZ

 

DateOfBirth_FORMATTED

Formatted date of birth from MRZ

 

DateOfExpiry_MRZ

Document expiry date from MRZ

 

DateOfExpiry_FORMATTED

Formatted document expiry date from MRZ

 

ID_KW_TYPE1

Number

Document number

 

SerialNumber

Serial number

 

FullName

Document holder's full name

 

FullName_LINE2

Second line of the Document holder's full name

 

DateOfExpiry

Document expiry date

 

MRZ

Full contents of the machine-readable zone

 

ID_KZ_TYPE1
ID_KZ_TYPE2

Number

Document number

 

PIN

Personal PIN (VIZ)

 

LastName

Document holder's last name

 

FirstName

Document holder's first name

 

MiddleName

Document holder's patronymic name

 

DateOfBirth

Document holder's date of birth

 

MRZ

Full contents of the machine-readable zone

 

Number_MRZ

Document number from MRZ

 

PIN_MRZ

Personal PIN (VIZ) from MRZ

In the ID_KZ_TYPE2 scheme only

LastName_MRZ

Document holder's last name from MRZ

 

FirstName_MRZ

Document holder's first name from MRZ

 

Sex_MRZ

Document holder's sex from MRZ

 

DateOfBirth_MRZ

Document holder's date of birth from MRZ

 

DateOfBirth_FORMATTED

Formatted date of birth from MRZ

 

DateOfExpiry_MRZ

Document expiry date from MRZ

 

DateOfExpiry_FORMATTED

Formatted document expiry date from MRZ

 

ID_LT_TYPE1

LastName

Document holder's last name

 

FirstName

Document holder's first name

 

DateOfBirth

Document holder's birth date

 

PersonalCode

Document holder's personal number

 

Number

Document number

 

DateOfExpiry

Document expiry date

 

Sex

Document holder's sex

 

ID_LV

Number

Document number

 

PersonalCode

Document holder's personal code

 

LastName

Document holder's primary last name

 

LastName_EX

Document holder's secondary last name

 

FirstName

Document holder's first name

 

Nationality

Nationality of the document holder

 

DateOfBirth

Document holder's date of birth

 

DateOfExpiry

Document expiry date

 

ID_MY

Number

Document number

 

FullName

Document holder's full name

 

Sex

Document holder's sex

 

Nationality

Nationality of the document holder

 

Address_LINE1

Document holder's address

 

Address_LINE2

Document holder's address, continued

 

Address_LINE3

Document holder's address, continued

 

Address_LINE4

Document holder's address, continued

 

Address_LINE5

Document holder's address, continued

 

ID_NG_TYPE1

FirstName

Document holder's first name

 

LastName

Document holder's last name

 

Sex

Document holder's sex

 

DateOfBirth

Document holder's birth date

 

Height

Document holder's height

 

ID_NO_TYPE1

FirstName

Document holder's first name

 

LastName

Document holder's last name

 

Sex

Document holder's sex

 

Number

Document number

 

DateOfBirth

Document holder's birth date

 

DateOfIssue

Document issue date

 

DateOfExpiry

Document expiry date

 

ID_PL_TYPE1
ID_PL_TYPE2

Number

Document number

In the ID_PL_TYPE1 scheme only

PersonalNumber

PESEL number from the back side

In the ID_PL_TYPE1 scheme only

LastName

Document holder's last name

 

FirstName

Document holder's first name

 

FamilyName

Document holder's family name (last name at birth)

 

ParentsFirstNames

First names of document holder's parents

 

Sex

Document holder's sex

 

DateOfBirth

Document holder's date of birth

 

DateOfExpiry

Document expiry date

In the ID_PL_TYPE1 scheme only

MRZ

Full contents of the machine-readable zone

 

Number_MRZ

Document number from MRZ

 

PersonalNumber_MRZ

PESEL number from MRZ

In the ID_PL_TYPE2 scheme only

LastName_MRZ

Document holder's last name from MRZ

 

FirstName_MRZ

Document holder's first name from MRZ

 

Sex_MRZ

Document holder's sex from MRZ

 

DateOfBirth_MRZ

Document holder's date of birth from MRZ

 

DateOfBirth_FORMATTED

Formatted date of birth from MRZ

 

DateOfExpiry_MRZ

Document expiry date from MRZ

 

DateOfExpiry_FORMATTED

Formatted document expiry date from MRZ

 

ID_PT_TYPE1

Number

Document number

 

LastName

Document holder's last name

 

FirstName

Document holder's first name

 

Sex

Document holder's sex

 

DateOfBirth

Document holder's date of birth

 

DateOfExpiry

Document expiry date

 

ID_RO

CNP

CNP Number

 

LastName

Document holder's last name

 

FirstName

Document holder's first name

 

MRZ

Full contents of the machine-readable zone

 

Number_MRZ

Document number from MRZ

 

LastName_MRZ

Document holder's last name from MRZ

 

FirstName_MRZ

Document holder's first name from MRZ

 

Sex_MRZ

Document holder's sex from MRZ

 

DateOfBirth_MRZ

Document holder's date of birth from MRZ

 

DateOfBirth_FORMATTED

Formatted date of birth from MRZ

 

DateOfExpiry_MRZ

Document expiry date from MRZ

 

DateOfExpiry_FORMATTED

Formatted document expiry date from MRZ

 

ID_RS_TYPE1

LastName

Document holder's last name

 

FirstName

Document holder's first name

 

DateOfBirth

Document holder's birth date

 

Sex

Document holder's sex

 

Number

Document number

 

DateOfIssue

Document issue date

 

DateOfExpiry

Document expiry date

 

ID_SG

Number

Document number

 

FullName

Document holder's full name

 

FullName_EX

Document holder's full name, continued

 

FullName_EX2

Document holder's full name, continued

 

Sex

Document holder's sex

 

DateOfBirth

Document holder's date of birth

 

CountryOfBirth

Document holder's country of birth

 

Nationality

Nationality of the document holder

 

ID_SV_TYPE1

LastName

Document holder's last name

 

FirstName

Document holder's first name

 

Number

Document number

 

Sex

Document holder's sex

 

DateOfBirth

Document holder's birth date

 

ID_TR_TYPE1

Number

Document number

 

PersonalCode

Document holder's personal code

 

LastName

Document holder's last name

 

FirstName

Document holder's first name

 

Sex

Document holder's sex

 

DateOfBirth

Document holder's date of birth

 

DateOfExpiry

Document expiry date

 

ID_ZA_TYPE1

LastName

Document holder's last name

 

FirstName

Document holder's first name

 

DateOfBirth

Document holder's birth date

 

Sex

Document holder's sex

 

Number

Document number

 

Nationality

Document holder's nationality

 

InternationalPassport_AT

Number

Document number

 

LastName

Document holder's last name

 

FirstName

Document holder's first name

 

DateOfBirth

Document holder's date of birth

 

PlaceOfBirth

Document holder's place of birth

 

Height

Document holder's height

 

DateOfIssue

Document issue date

 

DateOfExpiry

Document expiry date

 

MRZ

Full contents of the machine-readable zone

 

Number_MRZ

Document number from MRZ

 

DVRNumber

DVR number

 

LastName_MRZ

Document holder's last name from MRZ

 

FirstName_MRZ

Document holder's first name from MRZ

 

DateOfBirth_MRZ

Document holder's date of birth from MRZ

 

DateOfBirth_FORMATTED

Formatted date of birth from MRZ

 

DateOfExpiry_MRZ

Document expiry date from MRZ

 

DateOfExpiry_FORMATTED

Formatted document expiry date from MRZ

 

InternationalPassport_CN_TYPE1
InternationalPassport_CN_TYPE2

Number

Document number

 

LastName

Document holder's last name

In the InternationalPassport_CN_TYPE1 scheme only

FirstName

Document holder's first name

In the InternationalPassport_CN_TYPE1 scheme only

LastNameFirstName

Document holder's full name

In the InternationalPassport_CN_TYPE2 scheme only

Sex

Document holder's sex

 

DateOfBirth

Document holder's date of birth

 

PlaceOfBirth

Document holder's place of birth

 

Nationality

Nationality of the document holder

In the InternationalPassport_CN_TYPE2 scheme only

PlaceOfIssue

Region where the document was issued

 

IssuingStateCode

Code of the authority that issued the document

 

DateOfIssue

Document issue date

 

DateOfExpiry

Document expiry date

 

MRZ

Full contents of the machine-readable zone

 

Number_MRZ

Document number from MRZ

 

FirstName_MRZ

Document holder's first name from MRZ

 

LastName_MRZ

Document holder's last name from MRZ

 

Sex_MRZ

Document holder's sex from MRZ

 

DateOfBirth_MRZ

Document holder's date of birth from MRZ

 

DateOfBirth_FORMATTED

Formatted date of birth from MRZ

 

Nationality_MRZ

Document holder's nationality from MRZ

 

DateOfExpiry_MRZ

Document expiry date from MRZ

 

DateOfExpiry_FORMATTED

Formatted document expiry date from MRZ

 

Optional_MRZ_LINE2

Optional second line of MRZ

 

InternationalPassport_DE_TYPE1
InternationalPassport_DE_TYPE2

Number

Document number

 

LastName

Document holder's last name

 

LastName_LINE2

Second line of the Document holder's last name

 

FirstName

Document holder's first name

 

FirstName_LINE2

Second line of the Document holder's first name

In the InternationalPassport_DE_TYPE2 scheme only

Sex

Document holder's sex

 

DateOfBirth

Document holder's date of birth

 

PlaceOfBirth

Document holder's place of birth

 

Nationality

Nationality of the document holder

 

DateOfIssue

Document issue date

 

DateOfExpiry

Document expiry date

 

IssuedBy

The authority that issued the document

 

MRZ

Full contents of the machine-readable zone

 

Number_MRZ

Document number from MRZ

 

LastName_MRZ

Document holder's last name from MRZ

 

FirstName_MRZ

Document holder's first name from MRZ

 

DateOfBirth_MRZ

Document holder's date of birth from MRZ

 

DateOfBirth_FORMATTED

Formatted date of birth from MRZ

 

DateOfExpiry_MRZ

Document expiry date from MRZ

 

DateOfExpiry_FORMATTED

Formatted document expiry date from MRZ

 

InternationalPassport_GE_TYPE1
InternationalPassport_GE_TYPE2

PersonalCode

Document holder's personal code

In the InternationalPassport_GE_TYPE1 scheme only

PersonalCode_MRZ

Document holder's personal code from MRZ

In the InternationalPassport_GE_TYPE2 scheme only

DateOfBirth_MRZ

Document holder's date of birth from MRZ

 

DateOfBirth_FORMATTED

Formatted date of birth from MRZ

 

DateOfExpiry_MRZ

Document expiry date from MRZ

 

DateOfExpiry_FORMATTED

Formatted document expiry date from MRZ

 

Sex_MRZ

Document holder's sex from MRZ

 

FirstName_MRZ

Document holder's first name from MRZ

 

LastName_MRZ

Document holder's last name from MRZ

 

Nationality_MRZ

Document holder's nationality from MRZ

 

Number_MRZ

Document number from MRZ

 

MRZ

Full contents of the machine-readable zone

 

InternationalPassport_IN

Number

Document number

 

LastName

Document holder's last name

 

FirstName

Document holder's first name

 

Sex

Document holder's sex

 

DateOfBirth

Document holder's date of birth

 

PlaceOfBirth

Document holder's place of birth

 

Nationality

Nationality of the document holder

 

PlaceOfIssue

The region where the document was issued

 

DateOfIssue

Document issue date

 

DateOfExpiry

Document expiry date

 

MRZ

Full contents of the machine-readable zone

 

Number_MRZ

Document number from MRZ

 

LastName_MRZ

Document holder's last name from MRZ

 

FirstName_MRZ

Document holder's first name from MRZ

 

Sex_MRZ

Document holder's sex from MRZ

 

DateOfBirth_MRZ

Document holder's date of birth from MRZ

 

DateOfBirth_FORMATTED

Formatted date of birth from MRZ

 

DateOfExpiry_MRZ

Document expiry date from MRZ

 

DateOfExpiry_FORMATTED

Formatted document expiry date from MRZ

 

InternationalPassport_IT

Number

Document number

 

LastName

Document holder's last name

 

FirstName

Document holder's first name

 

Sex

Document holder's sex

 

DateOfBirth

Document holder's date of birth

 

PlaceOfBirth

Document holder's place of birth

 

Nationality

Nationality of the document holder

 

DateOfIssue

Document issue date

 

DateOfExpiry

Document expiry date

 

MRZ

Full contents of the machine-readable zone

 

Number_MRZ

Document number from MRZ

 

FirstName_MRZ

Document holder's first name from MRZ

 

LastName_MRZ

Document holder's last name from MRZ

 

Sex_MRZ

Document holder's sex from MRZ

 

DateOfBirth_MRZ

Document holder's date of birth from MRZ

 

DateOfBirth_FORMATTED

Formatted date of birth from MRZ

 

DateOfExpiry_MRZ

Document expiry date from MRZ

 

DateOfExpiry_FORMATTED

Formatted document expiry date from MRZ

 

InternationalPassport_JP

Number

Document number

 

LastName

Document holder's last name

 

FirstName

Document holder's first name

 

Sex

Document holder's sex

 

DateOfBirth

Document holder's date of birth

 

PlaceOfBirth

Document holder's place of birth

 

Nationality

Nationality of the document holder

 

DateOfIssue

Document issue date

 

DateOfExpiry

Document expiry date

 

MRZ

Full contents of the machine-readable zone

 

Number_MRZ

Document number from MRZ

 

FirstName_MRZ

Document holder's first name from MRZ

 

LastName_MRZ

Document holder's last name from MRZ

 

Sex_MRZ

Document holder's sex from MRZ

 

DateOfBirth_MRZ

Document holder's date of birth from MRZ

 

DateOfBirth_FORMATTED

Formatted date of birth from MRZ

 

DateOfExpiry_MRZ

Document expiry date from MRZ

 

DateOfExpiry_FORMATTED

Formatted document expiry date from MRZ

 

InternationalPassport_PH_TYPE1
InternationalPassport_PH_TYPE2

Number

Document number

 

LastName

Document holder's last name

 

FirstName

Document holder's first name

 

MiddleName

Document holder's patronymic name

 

Sex

Document holder's sex

 

DateOfBirth

Document holder's date of birth

 

PlaceOfBirth

Document holder's place of birth

 

Nationality

Nationality of the document holder

In the InternationalPassport_PH_TYPE2 scheme only

DateOfIssue

Document issue date

 

DateOfExpiry

Document expiry date

 

MRZ

Full contents of the machine-readable zone

 

Number_MRZ

Document number from MRZ

 

LastName_MRZ

Document holder's last name from MRZ

 

FirstName_MRZ

Document holder's first name from MRZ

 

Sex_MRZ

Document holder's sex from MRZ

 

DateOfBirth_MRZ

Document holder's date of birth from MRZ

 

DateOfBirth_FORMATTED

Formatted date of birth from MRZ

 

Nationality_MRZ

Nationality of the document holder from MRZ

 

DateOfExpiry_MRZ

Document expiry date from MRZ

 

DateOfExpiry_FORMATTED

Formatted document expiry date from MRZ

 

InternationalPassport_RU

Number

Document number

 

LastName

Document holder's last name

 

FirstName

Document holder's first name

 

MiddleName

Document holder's patronymic name

 

FirstNameMiddleName

Document holder's first and patronymic names

 

Sex

Document holder's sex

 

DateOfBirth

Document holder's date of birth

 

PlaceOfBirth

Document holder's place of birth

 

IssuedBy

The authority that issued the document

 

DateOfIssue

Document issue date

 

DateOfExpiry

Document expiry date

 

MRZ

Full contents of the machine-readable zone

 

Number_MRZ

Document number from MRZ

 

LastName_MRZ

Document holder's last name from MRZ

 

FirstName_MRZ

Document holder's first name from MRZ

 

Sex_MRZ

Document holder's sex from MRZ

 

Nationality_MRZ

Nationality of the document holder from MRZ

 

DateOfBirth_MRZ

Document holder's date of birth from MRZ

 

DateOfBirth_FORMATTED

Formatted date of birth from MRZ

 

DateOfExpiry_MRZ

Document expiry date from MRZ

 

DateOfExpiry_FORMATTED

Formatted document expiry date from MRZ

 

InternationalPassport_SY

DateOfBirth

Document holder's date of birth

 

MRZ

Full contents of the machine-readable zone

 

Number_MRZ

Document number from MRZ

 

LastName_MRZ

Document holder's last name from MRZ

 

FirstName_MRZ

Document holder's first name from MRZ

 

Sex_MRZ

Document holder's sex from MRZ

 

DateOfBirth_MRZ

Document holder's date of birth from MRZ

 

DateOfBirth_FORMATTED

Formatted date of birth from MRZ

 

DateOfExpiry_MRZ

Document expiry date from MRZ

 

DateOfExpiry_FORMATTED

Formatted document expiry date from MRZ

 

InternationalPassport_TJ_TYPE1

LastName

Document holder's last name

 

FirstName

Document holder's first name

 

Nationality

Document holder's nationality

 

DateOfBirth

Document holder's birth date

 

Sex

Document holder's sex

 

DateOfIssue

Document issue date

 

DateOfExpiry

Document expiry date

 

Number

Document number

 

MRZ

Full contents of the machine-readable zone

 

FirstName_MRZ

Document holder's first name from MRZ

 

LastName_MRZ

Document holder's last name from MRZ

 

Number_MRZ

Document number from MRZ

 

Nationality_MRZ

Nationality of the document holder from MRZ

 

Sex_MRZ

Document holder's sex from MRZ

 

DateOfBirth_MRZ

Document holder's birth date from MRZ

 

DateOfBirth_FORMATTED

Formatted birth date from MRZ

 

DateOfExpiry_MRZ

Document expiry date from MRZ

 

DateOfExpiry_FORMATTED

Formatted document expiry date from MRZ

 

InternationalPassport_UK_TYPE1
InternationalPassport_UK_TYPE2

Number

Document number

 

LastName

Document holder's last name

 

FirstName

Document holder's first name

 

Sex

Document holder's sex

 

Nationality

Nationality of the document holder

 

DateOfBirth

Document holder's date of birth

 

PlaceOfBirth

Document holder's place of birth

 

IssuedBy

The authority that issued the document

 

DateOfIssue

Document issue date

 

DateOfExpiry

Document expiry date

 

MRZ

Full contents of the machine-readable zone

 

Number_MRZ

Document number from MRZ

 

LastName_MRZ

Document holder's last name from MRZ

 

FirstName_MRZ

Document holder's first name from MRZ

 

DateOfBirth_MRZ

Document holder's date of birth from MRZ

 

DateOfBirth_FORMATTED

Formatted date of birth from MRZ

 

DateOfExpiry_MRZ

Document expiry date from MRZ

 

DateOfExpiry_FORMATTED

Formatted document expiry date from MRZ

 

InternationalPassport_US_TYPE1
InternationalPassport_US_TYPE2

Number

Document number

 

LastName

Document holder's last name

 

FirstName

Document holder's first name

 

Sex

Document holder's sex

 

DateOfBirth

Document holder's date of birth

 

PlaceOfBirth

Document holder's place of birth

 

DateOfIssue

Document issue date

 

DateOfExpiry

Document expiry date

 

MRZ

Full contents of the machine-readable zone

 

Number_MRZ

Document number from MRZ

 

LastName_MRZ

Document holder's last name from MRZ

 

FirstName_MRZ

Document holder's first name from MRZ

 

Sex_MRZ

Document holder's sex from MRZ

 

DateOfBirth_MRZ

Document holder's date of birth from MRZ

 

DateOfBirth_FORMATTED

Formatted date of birth from MRZ

 

Nationality_MRZ

Nationality of the document holder from MRZ

 

DateOfExpiry_MRZ

Document expiry date from MRZ

 

DateOfExpiry_FORMATTED

Formatted document expiry date from MRZ

 

Optional_MRZ_LINE2

Optional second line of MRZ

 

InternationalPassport_UZ_TYPE1

Number

Document number

 

LastName

Document holder's last name

 

FirstName

Document holder's first name

 

DateOfBirth

Document holder's birth date

 

DateOfIssue

Document issue date

 

DateOfExpiry

Document expiry date

 

Sex

Document holder's sex

 

MRZ

Full contents of the machine-readable zone

 

FirstName_MRZ

Document holder's first name from MRZ

 

LastName_MRZ

Document holder's last name from MRZ

 

Number_MRZ

Document number from MRZ

 

Nationality_MRZ

Document holder's nationality from MRZ

 

Sex_MRZ

Document holder's sex from MRZ

 

DateOfBirth_MRZ

Document holder's birth date from MRZ

 

DateOfBirth_FORMATTED

Formatted birth date from MRZ

 

DateOfExpiry_MRZ

Document expiry date from MRZ

 

DateOfExpiry_FORMATTED

Formatted document expiry date from MRZ

 

MRZ

Number

Document number

 

DocumentType

Document type

 

DocumentSubtype

Document subtype

 

LastName

Document holder's last name

 

FirstName

Document holder's first name

 

DateOfBirth

Document holder's date of birth

 

Sex

Document holder's sex

 

Nationality

Nationality of the document holder

 

PersonalNumber

Document holder's personal number

 

IssuingCountry

The country where the document was issued

 

DateOfExpiry

Document expiry date

 

OptionalData

Optional MRZ data

 

MRZ_CH
MRZ_FR
MRZ_MRP
MRZ_MRV_A
MRZ_MRV_B
MRZ_MRV_RU
MRZ_RU
MRZ_TD1
MRZ_TD2

MRZ

Full contents of the MRZ

 

MRZ_LINE1

The first line of MRZ

 

MRZ_LINE2

The second line of MRZ

 

MRZ_LINE3

The third line of MRZ

In the MRZ_TD1 scheme only

Number

Document number

 

Number_FORMATTED

Formatted document number

 

DocumentType

Document type

 

LastName

Document holder's last name

 

FirstName

Document holder's first name

 

DateOfBirth

Document holder's date of birth

 

DateOfBirth_FORMATTED

Formatted date of birth from MRZ

 

Sex

Document holder's sex

Except the MRZ_CH scheme

Nationality

Nationality of the document holder

Except the MRZ_CH scheme

IssuingStateCode

Code of the country that issued the document

 

DepartmentCode

Code of the authority that issued the document

In the MRZ_RU scheme only

DateOfIssue

Document issue date

In the MRZ_RU scheme only

DateOfIssue_FORMATTED

Formatted document issue date

In the MRZ_RU scheme only

DateOfExpiry

Document expiry date

Except the MRZ_CH, MRZ_FR, MRZ_RU schemes

DateOfExpiry_FORMATTED

Formatted document expiry date

Except the MRZ_CH, MRZ_FR, MRZ_RU schemes

OptionalData_LINE1

Optional MRZ line

 

OptionalData_LINE2

Optional MRZ line

 

MRZ_BG

MRZ

Full contents of the MRZ

 

MRZ_LINE1

The first line of MRZ

 

MRZ_LINE2

The second line of MRZ

 

Number

Document number

 

Number_FORMATTED

Formatted document number

 

DocumentType

Document type

 

IssuingStateCode

Code of the country that issued the document

 

VehicleNumber

Vehicle license number

 

Owner

Vehicle owner's full name for personal vehicles, or a company name if the vehicle is owned by a legal entity

 

PersonalCode

Owner identification number

 

VIN

Vehicle identification number (VIN)

 

Passport_BY
Passport_BY_PAGE31

Number

Document number

In the Passport_BY scheme only

ID

Document holder's personal identifier

 

LastName

Document holder's last name

 

FirstName

Document holder's first name

 

Sex

Document holder's sex

In the Passport_BY scheme only

DateOfBirth

Document holder's date of birth

 

PlaceOfBirth

Document holder's place of birth

 

DateOfIssue

Document issue date

 

DateOfExpiry

Document expiry date

 

MRZ

Full contents of the machine-readable zone

In the Passport_BY scheme only

Number_MRZ

Document number from MRZ

In the Passport_BY scheme only

LastName_MRZ

Document holder's last name from MRZ

In the Passport_BY scheme only

FirstName_MRZ

Document holder's first name from MRZ

In the Passport_BY scheme only

Sex_MRZ

Document holder's sex from MRZ

In the Passport_BY scheme only

Nationality_MRZ

Nationality of the document holder from MRZ

In the Passport_BY scheme only

DateOfBirth_MRZ

Document holder's date of birth from MRZ

In the Passport_BY scheme only

DateOfBirth_FORMATTED

Formatted date of birth from MRZ

In the Passport_BY scheme only

DateOfExpiry_MRZ

Document expiry date from MRZ

In the Passport_BY scheme only

DateOfExpiry_FORMATTED

Formatted document expiry date from MRZ

In the Passport_BY scheme only

Passport_RU
Passport_RU_Top
Passport_RU_Bottom

Series

Document series

In the Passport_RU scheme only

Number

Document number

In Passport_RU_Top and Passport_RU_Bottom, this field contains both series and number

LastName

Document holder's last name

 

FirstName

Document holder's first name

 

MiddleName

Document holder's patronymic name

 

Sex

Document holder's sex

 

DateOfBirth

Document holder's date of birth

 

PlaceOfBirth

Document holder's place of birth

 

IssuedBy

The authority that issued the document

 

DepartmentCode

The code of the authority that issued the document

 

DateOfIssue

Document issue date

 

MRZ

Full contents of the machine-readable zone

In the Passport_RU scheme only

MRZ_LINE1

The first line of MRZ

In the Passport_RU scheme only

MRZ_LINE2

The second line of MRZ

In the Passport_RU scheme only

ResidencePermit_ES_TYPE1
ResidencePermit_ES_TYPE2

Number

Document number

 

NIENumber

NIE number

 

FullName

Document holder's full name

 

FullName_LINE2

Second line of the document holder's full name

 

DateOfBirth

Document holder's date of birth

 

Nationality

Nationality of the document holder

 

Address

Document holder's address

 

Address_LINE2

Second line of the document holder's address

 

DateOfRegistration

Date of resident registration

 

ProvinceOfIssue

Province of issue

 

PlaceOfIssue

Place of issue

 

SocialSecurityNumber_RU_TYPE1
SocialSecurityNumber_RU_TYPE2

Number

Document number

 

LastName

Document holder's last name

 

FirstName

Document holder's first name

 

MiddleName

Document holder's patronymic name

 

DateOfBirth

Document holder's date of birth

 

VehicleRegistration_RU_TYPE1
VehicleRegistration_RU_TYPE2

Number

Document number

 

LicensePlate

License plate number

 

VIN

VIN number

 

Visa_RU_TYPE1

DocumentType

Type of visa

 

Number

Visa number

 

PassportNumber

Document holder's passport number

 

FullName

Document holder's full name

 

FullName_EX

Document holder's full name in English

 

Sex

Document holder's sex

 

DateOfBirth

Document holder's date of birth

 

Nationality

Nationality of the document holder

 

InvitationNumber

The number of invitation

 

VisaId

Visa ID

 

FromTo

Duration

 

DateOfIssue

Visa issue date

 

EntryFromDate

Entry from date

 

StayUntilDate

Stay until date

 

Duration

Duration

 

MRZ

Full contents of the machine-readable zone

 

PassportNumber_MRZ

Document holder's passport number from MRZ

 

LastName_MRZ

Document holder's last name from MRZ

 

LastName_FORMATTED

Formatted Document holder's last name from MRZ

 

FirstName_MRZ

Document holder's first name from MRZ

 

FirstName_FORMATTED

Formatted Document holder's first name from MRZ

 

Sex_MRZ

Document holder's sex from MRZ

 

DateOfBirth_MRZ

Document holder's date of birth from MRZ

 

DateOfBirth_FORMATTED

Formatted date of birth from MRZ

 

Nationality_MRZ

Nationality of the document holder from MRZ

 

DocumentType_MRZ

Document type from MRZ

 

OptionalData_MRZ_LINE1

Optional MRZ line

 

OptionalData_MRZ_LINE2

Optional MRZ line

 

WorkPermit_SG_TYPE1

DocumentType

Type of permit

 

Number

Primary document number

 

Number_EX

Secondary document number

 

FullName

Document holder's full name

 

Sector

Occupation sector

 

Employer

Employer company name

 

Occupation

Occupational title

 

DateOfApplication

Work application date

 

DateOfIssue

Document issue date

 

DateOfExpiry

Document expiry date