Documentation / Getting started
On this page
An MRZ Scanner 2 licence key starts with MRZ2.. You find it under My licences in the portal: open the licence and press Copy key.
Register the key once
Register the key when your app starts, before the first scan. It applies to the whole process.
| Platform | Call |
|---|---|
| iOS | MRZScan.registerLicense(key) |
| Android | MrzScan.registerLicense(context, key) |
| React Native, Capacitor, Cordova | await MRZScanner.registerLicense(key) |
| Flutter | await MRZScanner.registerLicense(key) |
| .NET MAUI | await MrzScanner.RegisterLicenseAsync(key) |
| Python | mrzscanner.register_license(key, app_id="com.example.app") |
| C (Linux, Windows) | mrz_register_license(key, app_id, "", 4) |
What the key checks
The key is checked on the device, with no network. It is signed by us and lists:
- the apps it is for: bundle IDs and package names, or your web site's host name;
- the platforms: iOS, Android, desktop and server, web;
- the document types, and the day the key expires.
One key covers every platform in your licence.
When a key expires
- A trial key ends with the trial.
- A paid key works until the last paid day of the licence plus a grace period (90 days unless agreed otherwise).
- Each renewal issues a new key, which we e-mail to you. Ship it in your next release before the old key ends; the portal always shows the current key.
When the key is refused
The mobile plugins return a result with a status, and a reason you can show:
| status | Meaning |
|---|---|
| 0 | Accepted |
| -2 | Not a valid key |
| -3 | The key is for another app |
| -4 | The key is for another device |
| -5 | The key has expired |
| -6 | The key is for another platform |
Without an accepted key the scanner still reads, but some fields come back masked. A camera scan with an inactive licence ends with the status licenseInactive.
Trial keys
A trial key covers the platforms and app IDs you list, and works for a limited number of days. Get one under My licences > Get a trial licence. For production, request a licence for all your platforms under Licence requests.
Keys from MRZ Scanner 1.x
Keys from the 1.x SDKs do not work with MRZ Scanner 2, and MRZ2 keys do not work with 1.x. Apps on 1.x keep working with their keys. See Upgrading from 1.x.
Updated Oct 28, 2026 ยท Questions? Ask us