PLATFORMS << CROSS-PLATFORM APPS

MRZ Scanner for Cordova

A Cordova plugin for Android and iOS, also for Ionic.

  • Package@mrzscanner/cordova
  • Requirescordova-android 13+, cordova-ios 7+
  • Version2.5.0

How it starts

  1. 1cordova plugin add @mrzscanner/cordova.
  2. 2For iOS, set the deployment target to 15.0 in config.xml (the camera text is set for you).
  3. 3After deviceready, call MRZScanner.registerLicense once, then MRZScanner.scan() or MRZScanner.scanImage().

Install

Installbash
cordova plugin add @mrzscanner/cordova

Scan a document

Cordovajavascript
// after deviceready, the plugin is window.MRZScanner
await MRZScanner.registerLicense('MRZ2...');      // once; without it some fields are masked

const result = await MRZScanner.scan({ documentTypes: ['passport', 'id'] });
if (result.status === 'read') {
  const read = result.reads[0];
  console.log(read.text, read.fields.document_number, read.checkDigitsValid);
}

const fromPhoto = await MRZScanner.scanImage({ base64: jpegBase64 });   // or { path }

Also available for