Cordova

Package: @mrzscanner/cordova, also for Ionic apps on Cordova.

Needs: cordova-android 13 or later (Android 7.0, API 24) and cordova-ios 7 or later (iOS 15).

Install

cordova plugin add @mrzscanner/cordova

iOS needs <preference name="deployment-target" value="15.0" /> in config.xml. The camera usage text is set for you; to change it:

cordova plugin add @mrzscanner/cordova --variable CAMERA_USAGE_DESCRIPTION="..."

Use

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 }

See Scan settings and Scan results. TypeScript: www/mrzscanner.d.ts declares MRZScanner and the types.