Documentation / Getting started
On this page
MRZ Scanner 2 reads the machine readable zone (MRZ) of passports, ID cards and visas, and returns the MRZ text, the parsed fields and whether the check digits match. Every package is built from the same scanner core, version 2.5.0.
What it reads
- Passports (TD3: two lines of 44 characters)
- ID cards (TD1: three lines of 30; TD2: two lines of 36)
- Machine readable visas
You can limit a scan to some of these document types.
Where it runs
| Platform | Package | Needs |
|---|---|---|
| iOS | Swift package MRZScannerAR | iOS 15+ |
| Android | com.barkoder.mrzscanner:mrzscanner-ar | Android 7.0 (API 24)+ |
| React Native | @mrzscanner/react-native | React Native 0.76+ (New Architecture) |
| Flutter | mrzscanner (pub.dev) | Flutter 3.24+ |
| .NET MAUI | MRZScanner.Maui (NuGet) | .NET 10; Android, iOS, Windows |
| Capacitor | @mrzscanner/capacitor | Capacitor 8 |
| Cordova | @mrzscanner/cordova | cordova-android 13+, cordova-ios 7+ |
| Linux | mrzscanner-linux (C library) | x86_64 or aarch64, glibc 2.17+ |
| Windows | mrzscanner-windows (C library, DLL) | Windows 10+, x64 |
| Python | mrzscanner (PyPI) | Python 3.8+ on Linux or Windows |
| Web | WebAssembly (early access) | A current browser |
How it works
- On the device. Recognition runs in your app or on your server. No image and no document data is sent anywhere.
- Camera screen. On phones, the SDK opens a full-screen camera. In AR mode a box follows the MRZ and shows the read on it. A read is confirmed over agreeing frames before your app gets it.
- Photos. Every package can also read the MRZ in a photo or a scanned image.
- One API. The mobile plugins (React Native, Flutter, .NET MAUI, Capacitor, Cordova) all have the same three calls:
registerLicense,scanandscanImage. They pass through to the native iOS and Android SDKs.
First steps
- Get a free trial key under My licences in the portal.
- Install the package for your platform (see its page in this documentation).
- Register the key once when your app starts, then scan.
Updated Oct 24, 2026 ยท Questions? Ask us