MRZ Scanner Plus

A Flutter plugin for scanning and parsing Machine Readable Zone (MRZ) from travel documents. When scanning or photographing a document, it will automatically detect the MRZ area and return only the document image within the mask.

English | 中文 | 日本語 | 한국어 | Deutsch

Features

• Real-time MRZ scanning and parsing
• Automatic document area detection
• Support for both scanning and photo modes
• Customizable UI overlay
• Built-in document cropping
• Support for multiple MRZ document types

Screenshots

Scanning Mode

MRZ scanning interface	Scan result	Document image

Photo Mode

Photo capture interface	Processing result

Installation

Add this to your package's pubspec.yaml file:

dependencies:
  mrz_scanner_plus: ^0.0.1

Or install via command line:

flutter pub add mrz_scanner_plus

Usage

Basic Implementation

import 'package:mrz_scanner_plus/mrz_scanner_plus.dart';

class CameraScanPage extends StatefulWidget {
  @override
  State<CameraScanPage> createState() => _CameraScanPageState();
}

class _CameraScanPageState extends State<CameraScanPage> {
  void _onMRZDetected(String imagePath, MRZResult mrzResult) {
    print('MRZ Result: ${mrzResult.toJson()}');
    print('Image Path: $imagePath');
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      body: CameraView(
        mode: CameraMode.scan,
        onMRZDetected: _onMRZDetected,
      ),
    );
  }
}

Photo Mode

CameraView(
  mode: CameraMode.photo,
  onPhotoTaken: (String imagePath) {
    print('Photo saved at: $imagePath');
  },
)

Customization

CameraView(
  mode: CameraMode.scan,
  indicatorColor: Colors.blue, // Custom overlay color
  customOverlay: YourCustomWidget(), // Custom overlay widget
  onMRZDetected: _onMRZDetected,
  onDetected: (String text) {
    print('OCR Text: $text');
  },
)

API Reference

CameraView

Property	Type	Description
mode	CameraMode	Camera mode (scan/photo)
indicatorColor	Color?	Color of the scanning overlay
onMRZDetected	Function(String, MRZResult)?	Callback when MRZ is detected
onPhotoTaken	Function(String)?	Callback when photo is taken
onDetected	Function(String)?	Callback for raw OCR text
customOverlay	Widget?	Custom overlay widget
controller	CameraController?	Custom camera controller
photoButton	Widget?	Custom photo button widget

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.