rsa_identification 2.0.0 rsa_identification: ^2.0.0 copied to clipboard
A Dart Library for decoding and providing South African identification details from documents such as Driver's licenses and Smart ID's.
Table of Contents #
About The Project #
South African Identification documents have barcodes which provide specific data about their owners. This project provides a Dart Library for decoding and working with the details from these barcodes. Supported documents include:
- ✅ Driver's Licenses
- ✅ Smart ID Documents
- ✅ Old ID Books
Built With #
Getting Started #
Prerequisites #
This package can only be used by other dart projects. If this is your first dart project, see the following pages to help you get started:
Installation #
Add rsa_identification
as a dependency in your pubspec.yaml file.
Usage #
A simple usage example:
import 'dart:convert';
import 'package:rsa_identification/rsa_identification.dart';
void main() {
final idCardBarcode =
'SURNAME|NAME|GENDER|NATIONALITY|ID NUMBER|29 Jul 2000|COUNTRY OF BIRTH|CITIZENSHIP STATUS|26 Jan 2017|23370|SMART ID NUMBER|1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890';
final idCard = IdCard.fromBarcodeString(idCardBarcode);
print('ID Card - First Names: ${idCard.firstNames}');
print('ID Card - Last Name: ${idCard.surname}');
print('ID Card - ID Number: ${idCard.idNumber}');
final idBookBarcode = '7310095800088';
final idBook = IdBook.fromIdNumber(idBookBarcode);
print('ID Book - Date of Birth: ${idBook.birthDate}');
print('ID Book - Gender: ${idBook.gender}');
print('ID Book - Citizenship: ${idBook.citizenshipStatus}');
}
Roadmap #
See the open issues for a list of proposed features (and known issues).
Contributing #
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
License #
Distributed under the MIT License. See LICENSE for more information.
Contact #
BornIdeas - born.dev - info@born.dev
Project Link: https://github.com/born-ideas/rsa_identification