MRZ Result

Defined under the namespace Scandit.Datacapture.Id

MRZResult
class MRZResult

Added in version 6.13.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
get documentCode(): string

Added in version 6.13.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.

namesAreTruncated
get namesAreTruncated(): boolean

Added in version 6.13.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.13.0

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

optional1
get optional1(): string | null

Added in version 6.13.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
get capturedMrz(): string

Added in version 6.13.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.