SDK for scanning and OCR of various identity documents. Contains Cordova/Phonegap plugin, sample code and documentation.
Clone or download
Latest commit 397d7e7 Nov 27, 2018

README.md

BlinkID SDK wrapper for PhoneGap

This repository contains example wrapper for BlinkID native SDKs (iOS and Android). Not all features of native SDKs are available in PhoneGap wrapper. However, the wrapper is open source, so you can easily add features that you need. For 100% of features and maximum control, consider using native SDKs.

Cordova version

BlinkID PhoneGap requires Cordova v7.0.0 or later and cordova-android plugin v7.0.0 or later.

Ionic version

Latest version has been tested using Ionic 3.19.0 version.

Adding blinkid-phonegap to your application

You can add blinkid-phonegap by cloning the repository and following instructions below or by running

cordova plugin add blinkid-cordova

The shown instructions are for Cordova, the instructions for Ionic and PhoneGap are practically the same, except for some slight command line argument differences.

In the repository you will find scripts to create sample applications.

Clone or Download repository

Downloading a repository just downloads the files from the most recent commit of the default branch but without all the dependencies which are in submodules. We recommend that you clone directory. With a clone option you will get a copy of the history and it’s functional git repository.

To clone repository:

How to get started

Cordova

Sample Cordova app is generated with a script

./initCordovaDemoApp.sh

To run iOS demo application open Xcode project BlinkIdDemo.xcodeproj

To run Android demo application type

cordova run android

Ionic

Sample Ionic app is generated with a script

./initIonicDemoApp.sh

When Ionic asks the following question Would you like to integrate your new app with Cordova to target native iOS and Android? answer with y.

To run iOS demo application open Xcode project BlinkIdDemo.xcodeproj

To run Android demo application type

ionic run android

Licensing

  • Generate a free demo license key to start using the SDK in your app (registration required)

  • Get information about pricing and licensing of BlinkID

Video tutorial

Cordova

Step by step guide how to start blinkid-phonegap using Cordova. A tutorial flows from cloning repository via git clone to successfully deployed demo application on Android and iOS device with real-time screen mirroring. Application demo contains simple use of USDL recognizer with Ontario drivers license card.

Video tutorial Watch on Vimeo Watch on Youtube

Using documentVerificationOverlay and CombinedRecognizer

This video tutorial describes how to use documentVerificationOverlay with UsdlCombinedRecognizer. DocumentVerificationOverlay is overlay for RecognizerRunnerFragment best suited for combined recognizers because it manages scanning of multiple document sides in the single camera opening and guides the user through the scanning process. It can also be used for single side scanning of ID cards, passports, driver’s licenses, etc

Video tutorial Watch on Vimeo Watch on Youtube

Installation

First generate a empty project if needed:

cordova create <path> <package> <name>

The shown instructions are for Cordova, the instructions for Ionic and PhoneGap are practically the same, except for some slight command line argument differences.

Initialize the iOS framework:

cd BlinkID
./initIOSFramework.sh
cd ..

Add the BlinkID plugin to your project:

cd <path_to_your_project>
cordova plugin add <blinkID_plugin_path> # or blinkid-cordova if you don't have blinkid-phonegap locally

Ionic specific:

Copy the BlinkID plugin's JavaScript files to your project:

cp  -f -r <blinkID_plugin_path>/www/js ./www/

Android

Add Android platform support to the project:

cordova platform add android@7

iOS

If you want to add iOS as a platform for your application, you will need to install unzip and wget.

Add iOS plaform support to the project:

cordova platform add ios

Sample

Here's a complete example of how to create and build a project for Android and iOS using cordova (you can substitute equivalent commands for phonegap):

# pull the plugin and sample application from Github
git clone https://github.com/BlinkID/blinkid-phonegap.git

# create a empty application
cordova create testcordova

cd testcordova

# add the blinkID plugin
cordova plugin add ../blinkid-phonegap/BlinkID # or just 'blinkid-cordova' if you don't have blinkid-phonegap locally

# add android support to the project
cordova platform add android@7

# build the project, the binary will appear in the bin/ folder
cordova build android

# add ios support to the project
cordova platform add ios

# build the project
cordova build ios

In phonegap CLI instead of platform add just request a build for the platform using build android or build ios. You will have to do the manual steps described above to be able to do a successfull build.

You can also use provided initDemoApp.sh script that will generate a demo app that uses the plugin:

./initCordovaDemoApp.sh

To run the script, you'll need BASH environment on Windows (Linux and MacOS use BASH by default).

Usage

To use the plugin you call it in your Javascript code like the demo application.

Documentation for all features and JS API is available in blinkIdScanner.js JS API file.

Changing scanner settings

To change scanner settings you need to modify Phonegap plugin classes for iOS and Android. Plugin classes are located in ./BlinkID/src. All necessary settings documentation is located in those source files.

For platform specific implementation details refer to the BlinkID-iOS and BlinkID-android documentation.