{"id":13550250,"url":"https://github.com/BlinkID/blinkid-flutter","last_synced_at":"2025-04-03T00:33:22.098Z","repository":{"id":38794081,"uuid":"257288620","full_name":"BlinkID/blinkid-flutter","owner":"BlinkID","description":"ID scanning plugins for cross-platform apps built with Flutter.","archived":false,"fork":false,"pushed_at":"2025-03-28T12:01:54.000Z","size":610,"stargazers_count":81,"open_issues_count":21,"forks_count":24,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-03-28T12:35:38.727Z","etag":null,"topics":["android","cross-platform","dart","flutter","id-card-camera","id-scanning","ios","kyc","machine-learning","onboarding","scanning-id-cards"],"latest_commit_sha":null,"homepage":"","language":"Dart","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/BlinkID.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-04-20T13:24:50.000Z","updated_at":"2025-01-26T13:17:23.000Z","dependencies_parsed_at":"2024-01-16T18:57:28.633Z","dependency_job_id":"6dca970f-9788-49e1-8200-881769be0143","html_url":"https://github.com/BlinkID/blinkid-flutter","commit_stats":null,"previous_names":[],"tags_count":29,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BlinkID%2Fblinkid-flutter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BlinkID%2Fblinkid-flutter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BlinkID%2Fblinkid-flutter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BlinkID%2Fblinkid-flutter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BlinkID","download_url":"https://codeload.github.com/BlinkID/blinkid-flutter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246916733,"owners_count":20854511,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["android","cross-platform","dart","flutter","id-card-camera","id-scanning","ios","kyc","machine-learning","onboarding","scanning-id-cards"],"created_at":"2024-08-01T12:01:30.697Z","updated_at":"2025-04-03T00:33:18.449Z","avatar_url":"https://github.com/BlinkID.png","language":"Dart","funding_links":[],"categories":["Dart"],"sub_categories":[],"readme":"# BlinkID SDK Flutter plugin\n\nAI-driven identity document scanning for Flutter apps. \n\nWe made it quick and easy to create a sample application or install the plugin into your existing iOS or Android app.\n\nPlease 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)).\n\nHowever, since the wrapper is open source, you can add the features you need on your own.\n\n\n## Requirements\nBlinkID plugin is developed with Flutter SDK version 1.17.5.\nFor help with Flutter, view official [documentation](https://flutter.dev/docs).\n\n## Getting Started\n\nTo get started, first create empty project if needed:\n```shell\nflutter create project_name\n```\n\nAdd the blinkid_flutter dependency to your `pubspec.yaml` file:\n```yaml\ndependencies:\n  ...\n  blinkid_flutter:\n```\n\n### Quick start with sample app\nTo try BlinkID plugin, you can generate a minimal sample application. To do so run `./initFlutterSample.sh` script.\n\nTo run sample application, use the following commands:\n```shell\ncd sample/\nflutter run\n```\nIf there are problems with running the application, please make sure you have\nproperly configured tools by running `flutter doctor`. You can also try running\nthe application from VSCode, Android Studio or Xcode.\n\n### Plugin usage\n1. 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\n [here](#licensing).\n```dart\nFuture\u003cvoid\u003e scan() async {\n    List\u003cRecognizerResult\u003e results;\n    \n    Recognizer recognizer = BlinkIdMultiSideRecognizer();\n    OverlaySettings settings = BlinkIdOverlaySettings();\n\n    // set your license\n    if (Theme.of(context).platform == TargetPlatform.iOS) {\n      license = \"\";\n    } else if (Theme.of(context).platform == TargetPlatform.android) {\n      license = \"\";\n    }\n\n    try {\n      // perform scan and gather results\n      results = await MicroblinkScanner.scanWithCamera(RecognizerCollection([recognizer]), settings, license);\n\n    } on PlatformException {\n      // handle exception\n    }\n```\n\n2. 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.\n\nFor more information please refer to our sample application source code.\n\n### Available API\nAll available recognizers can be found inside `BlinkID/lib/recognizers`.\n\nAll available overlays can be found inside `BlinkID/lib/overlays`.\n\nFor 100% of features and maximum control, consider using native SDK.\n\n### Platform specifics\nPlugin implementation is in folder `lib`, while platform specific implementations are in `android` and `ios` folders.\n\n#### Android\nAndroid folder is fully initialized after running `./initFlutterSample.sh`.\n\n#### iOS\nTo 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`.\nOur `blinkid_flutter` depends on the latest PPBlinkID pod so it will be installed automatically.\n\nTo set camera permission usage message, open `NameOfYourProject/ios/Runner.xcworkspace` and under `Runner/Runner/Info.plist` set\n`Privacy - Camera Usage Description`.\n\n## Licensing\n- 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)\n- Get information about pricing and licensing of [BlinkID](https://microblink.com/blinkid)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FBlinkID%2Fblinkid-flutter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FBlinkID%2Fblinkid-flutter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FBlinkID%2Fblinkid-flutter/lists"}