flutter_mrz_scanner 0.7.1

  • Readme
  • Changelog
  • Example
  • Installing
  • 79

flutter_mrz_scanner #

Scan MRZ (Machine Readable Zone) from identity documents (passport, id, visa) using iOS and Android. Heavily insipred by QKMRZScanner.

Supported formats: #

  • TD1
  • TD2
  • TD3
  • MRV-A
  • MRV-B

Usage #

Import the package #

Add to pubspec.yaml

dependencies:
  flutter_mrz_scanner: ^0.7.0

For iOS #

The plugin use native view, which is not yet supported by default. To make it work add the following code to Info.plist:

    <key>io.flutter.embedded_views_preview</key>
    <string>YES</string>

The plugin uses the device camera, so do not forget to provide the NSCameraUsageDescription. You may specify it in Info.plist like that:

    <key>NSCameraUsageDescription</key>
    <string>May I scan a MRZ please?</string>

Set iOS deployment target to 12.

For Android #

Add

<uses-permission android:name="android.permission.CAMERA" />

to AndroidManifest.xml

Use the widget #

...
MRZScanner(
  onParsed: (result) {
    print(result.documentType);
    print(result.countryCode);
    print(result.surnames);
    print(result.givenNames);
    print(result.documentNumber);
    print(result.nationalityCountryCode);
    print(result.birthDate);
    print(result.sex);
    print(result.expiryDate);
    print(result.personalNumber);
    print(result.personalNumber2);
  },
  onError: (error) => print(error),
),
...

Refer to example project for the complete app sample.

Acknowledgements #

License #

flutter_mrz_scanner is released under a MIT License. See LICENSE for details.

0.7.1 #

  • Provide possibility to disable overlay

0.7.0 #

  • First public version with basic iOS and Android scanners

example/lib/main.dart

import 'package:flutter/material.dart';
import 'package:flutter/widgets.dart';
import 'package:flutter_mrz_scanner_example/camera_page.dart';
import 'package:permission_handler/permission_handler.dart';

void main() => runApp(MyApp());

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: FutureBuilder<Map<PermissionGroup, PermissionStatus>>(
        future:
            PermissionHandler().requestPermissions([PermissionGroup.camera]),
        builder: (context, snapshot) {
          if (snapshot.hasData &&
              snapshot.data[PermissionGroup.camera] ==
                  PermissionStatus.granted) {
            return CameraPage();
          }
          return Scaffold(
            body: Center(
              child: Column(
                children: const [
                  CircularProgressIndicator(),
                  Text('Awaiting for permissions')
                ],
              ),
            ),
          );
        },
      ),
    );
  }
}

Use this package as a library

1. Depend on it

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


dependencies:
  flutter_mrz_scanner: ^0.7.1

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter pub get

Alternatively, your editor might support flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:flutter_mrz_scanner/flutter_mrz_scanner.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
57
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
100
Overall:
Weighted score of the above. [more]
79
Learn more about scoring.

We analyzed this package on Apr 3, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.7.1
  • pana: 0.13.6
  • Flutter: 1.12.13+hotfix.8

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.1.0 <3.0.0
flutter 0.0.0
mrz_parser ^1.0.0 1.0.0
Transitive dependencies
collection 1.14.11 1.14.12
meta 1.1.8
sky_engine 0.0.99
typed_data 1.1.6
vector_math 2.0.8
Dev dependencies
flutter_test