PLATFORMS << CROSS-PLATFORM APPS

MRZ Scanner for React Native

A TurboModule for the New Architecture, on Android and iOS.

  • Package@mrzscanner/react-native
  • RequiresReact Native 0.76+, Android 7+, iOS 15.1+
  • Version2.5.0

How it starts

  1. 1npm install @mrzscanner/react-native, then pod install in ios/.
  2. 2Add a camera usage text to ios/<App>/Info.plist.
  3. 3Call MRZScanner.registerLicense once, then MRZScanner.scan() or MRZScanner.scanImage().

Install

Installbash
npm install @mrzscanner/react-native
cd ios && pod install

Scan a document

React Nativetypescript
import { MRZScanner } from '@mrzscanner/react-native';

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({ path: photoUri });   // or { path }

Also available for