Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/BlinkID/blinkid-flutter
ID scanning plugins for cross-platform apps built with Flutter.
https://github.com/BlinkID/blinkid-flutter
android cross-platform dart flutter id-card-camera id-scanning ios kyc machine-learning onboarding scanning-id-cards
Last synced: 7 days ago
JSON representation
ID scanning plugins for cross-platform apps built with Flutter.
- Host: GitHub
- URL: https://github.com/BlinkID/blinkid-flutter
- Owner: BlinkID
- Created: 2020-04-20T13:24:50.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-09-13T13:27:12.000Z (about 2 months ago)
- Last Synced: 2024-09-15T01:52:17.496Z (about 2 months ago)
- Topics: android, cross-platform, dart, flutter, id-card-camera, id-scanning, ios, kyc, machine-learning, onboarding, scanning-id-cards
- Language: Dart
- Homepage:
- Size: 568 KB
- Stars: 78
- Watchers: 8
- Forks: 23
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# BlinkID SDK Flutter plugin
AI-driven identity document scanning for Flutter apps.
We made it quick and easy to create a sample application or install the plugin into your existing iOS or Android app.
Please note that, for maximum performance and full access to all features, it’s best to go with one of our native SDKs (for [iOS](https://github.com/BlinkID/blinkid-ios) or [Android](https://github.com/BlinkID/blinkid-android)).
However, since the wrapper is open source, you can add the features you need on your own.
## Requirements
BlinkID plugin is developed with Flutter SDK version 1.17.5.
For help with Flutter, view official [documentation](https://flutter.dev/docs).
## Getting Started
To get started, first create empty project if needed:
```shell
flutter create project_name
```
Add the blinkid_flutter dependency to your `pubspec.yaml` file:
```yaml
dependencies:
...
blinkid_flutter:
```
### Quick start with sample app
To try BlinkID plugin, you can generate a minimal sample application. To do so run `./initFlutterSample.sh` script.
To run sample application, use the following commands:
```shell
cd sample/
flutter run
```
If there are problems with running the application, please make sure you have
properly configured tools by running `flutter doctor`. You can also try running
the application from VSCode, Android Studio or Xcode.
### Plugin usage
1. Perform scanning by calling the method `MicroblinkScanner.scanWithCamera()` and passing it the `RecognizerCollection` and `OverlaySettings` you wish to use, along with your license key. To find out more about licensing, click
[here](#licensing).
```dart
Future scan() async {
List results;
Recognizer recognizer = BlinkIdMultiSideRecognizer();
OverlaySettings settings = BlinkIdOverlaySettings();
// set your license
if (Theme.of(context).platform == TargetPlatform.iOS) {
license = "";
} else if (Theme.of(context).platform == TargetPlatform.android) {
license = "";
}
try {
// perform scan and gather results
results = await MicroblinkScanner.scanWithCamera(RecognizerCollection([recognizer]), settings, license);
} on PlatformException {
// handle exception
}
```
2. When scanning is completed, variable `results` will contain a list of non-empty `RecognizerResults` from recognizers set in `RecognizerCollection`. You can then access each result individually. If the scanning is manually closed, the method will return an empty list.
For more information please refer to our sample application source code.
### Available API
All available recognizers can be found inside `BlinkID/lib/recognizers`.
All available overlays can be found inside `BlinkID/lib/overlays`.
For 100% of features and maximum control, consider using native SDK.
### Platform specifics
Plugin implementation is in folder `lib`, while platform specific implementations are in `android` and `ios` folders.
#### Android
Android folder is fully initialized after running `./initFlutterSample.sh`.
#### iOS
To initialize BlinkID framework for use with iOS, after you've added the dependency to `blinkid_flutter` to your `pubspec.yaml`, go to `NameOfYourProject/ios`and run `pod install`.
Our `blinkid_flutter` depends on the latest PPBlinkID pod so it will be installed automatically.
To set camera permission usage message, open `NameOfYourProject/ios/Runner.xcworkspace` and under `Runner/Runner/Info.plist` set
`Privacy - Camera Usage Description`.
## Licensing
- A valid license key is required to initialize scanning. You can request a **free trial license key**, after you register, at [Microblink Developer Hub](https://account.microblink.com/signin)
- Get information about pricing and licensing of [BlinkID](https://microblink.com/blinkid)