Table of contents

MRZScanner API References

MRZScanner is a ready-to-use component that enables developers to quickly set up an app for scanning MRZ codes on passports and ID cards. With the built-in MRZScannerViewController, it simplifies the integration of MRZ scanning functionality into any application, making it easy to extract and process information from travel and identity documents.

New to the SDK? The MRZ Scanner User Guide builds a working scanner from an empty project, and Customizing the MRZ Scanner covers the configuration options in context.

Classes

Class Description
MRZScannerViewController The main class of MRZScanner. It is an ViewController class that implements MRZ scanning features.
MRZScannerConfig The class that provides MRZ scanning configurations.
MRZScanResult The result class.
MRZData The class that contains the parsed MRZ information.
ResultStatus A enumeration class that describes the result status.
DocumentType A enumeration class that defines the type of document to scan, such as ID cards or passports.
DocumentSide An enumeration class that defines which side of a document is referenced when retrieving images from a scan result.
ErrorCode An enumeration class that defines the error codes owned by the MRZ Scanner bundle.

This page is compatible for: