MRZ Result
Defined under the namespace Scandit.Datacapture.Id
- MRZResult
class MRZResultAdded in version 6.6.0
This class represents data extracted from a Machine Readable Zone (MRZ). It consolidates information from MRZs that comply with the Machine Readable Travel Documents ICAO standard, as well as various MRZ-like formats supported by the library. Some properties may not apply to certain document types and will be set to nil if the corresponding data is not encoded in the MRZ. For a complete list of supported MRZ types, refer to supported documents.
- 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:
TD1 - ID cards (id cards)
TD2 - other official travel documents (other official travel documents)
TD3/MRP - passports (passports)
MRV (A & B type) - visas (visas)
In addition, the ID Capture mode supports the following non-ICAO standards:
SwissDL - Swiss driving license (Swiss driving license)
TD2/FrenchID - French ID (French identity card)
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
get documentCode(): string
Added in version 6.6.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
get namesAreTruncated(): boolean
Added in version 6.6.0
Indicates whether first or last name is truncated. For more information please refer to the official specification.
- optional
get optional(): string | null
Added in version 6.6.0
An optional field, for use of the issuing country or the organization.
- optional1
get optional1(): string | null
Added in version 6.6.0
An optional field, for use of the issuing country or the organization.
- capturedMrz
get capturedMrz(): string
Added in version 6.8.0
The full MRZ text as it appears on a document.
- passportIssuerIso
get passportIssuerIso(): string | null
Added in version 7.0.0
The ISO code of the issuing jurisdiction.
- passportNumber
get passportNumber(): string | null
Added in version 7.0.0
The passport number of the document holder.
- passportDateOfExpiry
get passportDateOfExpiry(): DateResult | null
Added in version 7.0.0
The expiry date of the holder’s passport.
- personalIdNumber
get personalIdNumber(): string | null
Added in version 7.0.0
The personal ID Number of the document holder.
- renewalTimes
get renewalTimes(): number | null
Added in version 7.0.0
The number of times the document has been renewed.
- fullNameSimplifiedChinese
get fullNameSimplifiedChinese(): string | null
Added in version 7.0.0
The holder’s name in Simplified Chinese characters.
- omittedCharacterCountInGbkName
get omittedCharacterCountInGbkName(): number | null
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.