PLATFORMS << CROSS-PLATFORM APPS

MRZ Scanner for Capacitor

A Capacitor 8 plugin for Android and iOS (SPM and CocoaPods).

  • Package@mrzscanner/capacitor
  • RequiresCapacitor 8, Android 7+, iOS 15+
  • Version2.5.0

How it starts

  1. 1npm install @mrzscanner/capacitor, then npx cap sync.
  2. 2Add a camera usage text to ios/App/App/Info.plist.
  3. 3Call MRZScanner.registerLicense once, then MRZScanner.scan() or MRZScanner.scanImage().

Install

Installbash
npm install @mrzscanner/capacitor
npx cap sync

Scan a document

Capacitortypescript
import { MRZScanner } from '@mrzscanner/capacitor';

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