the-mars-rover/rsa_scan

Scan identity documents such as South African ID Cards, ID Books and Driver's Licenses. --- ## Table of Contents * About the Project * Getting Started * Usage * Roadmap * Contributing * License * Contact * Acknowledgements ## About The Project This project provides a Flutter package for scanning South African identification documents. Supported documents include: * [x] South African ID Cards * [x] South African ID Books * [X] South African Driver's Licenses ### Built With * Flutter * ML Kit ## Getting Started ### Prerequisites Since this is a Flutter package, you will need to use it from within a Flutter App. A few resources to get you started with your first Flutter project: - Lab: Write your first Flutter app - Cookbook: Useful Flutter samples ### Installation Add `rsa_scan` as a dependency in your pubspec.yaml file. #### iOS iOS 10.0 of higher is needed to use the camera plugin. If compiling for any version lower than 10.0 make sure to check the iOS version before using the camera plugin. For example, using the device_info plugin. Also, add one row to the `ios/Runner/Info.plist` with the key `Privacy - Camera Usage Description` and a usage description. Or in text format add the key: ```xml NSCameraUsageDescription Can I use the camera please? ``` #### Android Change the minimum Android sdk version to 21 (or higher) in your `android/app/build.gradle` file. ``` minSdkVersion 21 ``` ## Usage The package exposes 3 functions, namely `scanIdCard`, `scanIdBook` and `scanDrivers`. A simple usage example of `scanIdCard`: ```dart import 'package:rsa_scan/rsa_scan.dart'; RsaIdCard idCard = await scanIdCard(context); print(idCard.idNumber); print(idCard.firstNames); print(idCard.surname); print(idCard.gender); // See the API reference for the full set of available properties ``` A simple usage example of `scanIdBook`: ```dart import 'package:rsa_scan/rsa_scan.dart'; RsaIdBook idBook = await scanIdBook(context); print(idBook.idNumber); print(idBook.birthDate); print(idBook.gender); print(idBook.citizenshipStatus); // See the …