Configuration for MRZ scanner.

Constructors

Properties

enableDetection: boolean

Enable MRZ detection. If disabled, the scanner skips the detection step and assumes that the input image is a crop of the MRZ area.

Default Value

true;
frameAccumulationConfiguration: AccumulatedResultsVerifierConfiguration

Configure the frame accumulation process.

Default Value

new AccumulatedResultsVerifierConfiguration({});
incompleteResultHandling: MrzIncompleteResultHandling

Defines how to handle incomplete MRZ results (e.g. caused by failed validation).

Default Value

"REJECT";
processingMode: ProcessingMode

Scanners typically can produce better results from a single image if they are allowed to spend a longer time analyzing it.

On the other hand, scanners can produce even better results if they can analyze multiple images of the same subject and cross-check and combine the results. The processing mode tells the scanner whether to optimize for single or multiple images of a subject.

Default Value

"AUTO";
returnCrops: boolean

If true, crops of the detected MRZ and its fields will be returned in the result.

Default Value

false;

Generated using TypeDoc