Upgrading from 1.x

MRZ Scanner 2 replaces the 1.x SDKs and plugins. The 1.x documentation is kept in the archive section of this documentation.

What changes

• New packages. The plugins have new names and one API:

  1.x	MRZ Scanner 2
  react-native-mrzscannerlib	@mrzscanner/react-native
  cordova-plugin-mrzscanner	@mrzscanner/cordova
  mrzscanner_flutter	mrzscanner
  Xamarin bindings	MRZScanner.Maui (.NET MAUI)
  (none)	@mrzscanner/capacitor, Linux, Windows, Python, WebAssembly

• One API. registerLicense, scan and scanImage, with the same settings and the same result on every platform.

• A new reader. Characters are read by a dedicated MRZ character classifier, and camera reads are confirmed over agreeing frames.

• New keys. MRZ Scanner 2 keys start with MRZ2.. One key covers every platform in your licence.

Your licence

• Apps on 1.x keep working with their 1.x keys.
• For MRZ Scanner 2 you need an MRZ2 key. Request a licence for the platforms you use under Licence requests, or ask us through a new issue to move an existing licence.

Steps

1. Remove the 1.x package from your app.
2. Install the MRZ Scanner 2 package for your platform (see its page).
3. Replace the 1.x calls with registerLicense / scan / scanImage, and read the fields from the new result (see Scan results).
4. Register your MRZ2 key.