MRZ Result

Defined in library scandit_datacapture_id

MrzResult
class MrzResult

Added in version 6.11.0

The ID Capture mode supports all versions of Machine Readable Travel Documents (MRTD) specified by the International Civil Aviation Organization (ICAO). The ICAO specifies four types of MRTDs:

In addition, the ID Capture mode supports the following non-ICAO standards:

Use the following regex pattern to filter out MRTD codes:

Type

Regex

TD1 Regex Pattern

([A-Z0-9<]{30}\n?){3}

TD2 Regex Pattern

([A-Z0-9<]{36}\n?){2}

TD2 French Regex Pattern

Same as TD2 Regex Pattern

TD3 Regex Pattern

([A-Z0-9<]{44}\n?){2}

MRV_A Regex Pattern

Same as TD2 Regex Pattern

MRV_B Regex Pattern

Same as TD3 Regex Pattern

Swiss Driving License Regex Pattern

[A-Z0-9<]{9}\n([A-Z0-9<]{30}\n?){2}

documentCode
String get documentCode

Added in version 6.11.0

The document type code. One of the following values:

  • P[passport type id] - indicates a passport,

  • ID - indicates an id card,

  • CA - indicates a Canada permanent resident card.

  • CP - indicates a Asia-Pacific Economic Cooperation Business Travel Card

  • CS - indicates an Exit-Entry Permit for Travelling to and from Hong Kong and Macau (往来港澳通行证);

  • CD - indicates an Exit-Entry Permit for Travelling to and from Taiwan (往来台灣通行证).

  • CR - indicates a Mainland Travel Permit for Hong Kong & Macau Residents.

  • CT - indicates a Mainland Travel Permit for Taiwan Residents.

namesAreTruncated
bool get namesAreTruncated

Added in version 6.11.0

Indicates whether first or last name is truncated. For more information please refer to the official specification.

optional
String? get optional

Added in version 6.11.0

An optional field, for use of the issuing country or the organization.

optional1
String? get optional1

Added in version 6.11.0

An optional field, for use of the issuing country or the organization.

If IdCaptureSettings.anonymizationMode is enabled for the field results, the returned value might be null for certain documents.

capturedMrz
String get capturedMrz

Added in version 6.11.0

The full MRZ text as it appears on a document.

If IdCaptureSettings.anonymizationMode is enabled for the field results, the returned value might be null for certain documents.

passportIssuerIso
String? get passportIssuerIso

Added in version 7.0.0

The ISO code of the issuing jurisdiction.

passportNumber
String? get passportNumber

Added in version 7.0.0

The passport number of the document holder.

passportDateOfExpiry
DateResult? get passportDateOfExpiry

Added in version 7.0.0

The expiry date of the holder’s passport.

personalIdNumber
String? get personalIdNumber

Added in version 7.0.0

The personal ID Number of the document holder.

renewalTimes
int? get renewalTimes

Added in version 7.0.0

The number of times the document has been renewed.

fullNameSimplifiedChinese
String? get fullNameSimplifiedChinese

Added in version 7.0.0

The holder’s name in Simplified Chinese characters.

omittedCharacterCountInGbkName
int? get omittedCharacterCountInGbkName

Added in version 7.0.0

The number of Chinese characters omitted in in GBK (a character encoding for Simplified Chinese characters used in the People’s Republic of China) name.

omittedNameCount
int? get omittedNameCount

Added in version 7.0.0

The number of names that couldn’t be displayed in the MRZ.

issuingAuthorityCode
String? get issuingAuthorityCode

Added in version 7.0.0

The code of the authority that issued this document.