BlinkID mobile SDK
BlinkID enables scanning of over 100 international identity documents including driving licenses, national identity cards, passports and others. Information is extracted by scanning the MRZ (machine-readable zone), barcodes or plain text from the documents. The SDK is available for integration in native and cross-platform environments.
Code, documentation, and integration guide are available in our Github repositories below. To get your free demo license key (no credit card required), register on our developer dashboard.
Get started with a demo SDK
Integration sample codes
Copy to clipboard
/**
* Set your license file. The recommended way is extending the Android Application class
* and setting the license file in its onCreate callback.
* Register on our dashboard to get the license key for your app.
*/
public class MyApplication extends Application {
@Override
public void onCreate() {
MicroblinkSDK.setLicenseFile("path/to/license/file/within/assets/dir", this);
}
}
public class MyActivity extends Activity {
// list of all available recognizers can be found here: https://bit.ly/2KrNWYu
private MrtdRecognizer mMrtdRecognizer;
private UsdlRecognizer mUsdlRecognizer;
private MyKadFrontRecognizer mMyKadFrontRecognizer;
private RecognizerBundle mRecognizerBundle;
@Override
protected void onCreate(Bundle bundle) {
super.onCreate(bundle);
// setup views, as you would normally do in onCreate callback
// create MrtdRecognizer for scanning Machine Readable Travel Document
// see https://bit.ly/2KLSdWc for options
mMrtdRecognizer = new MrtdRecognizer();
// create UsdlRecognizer for scanning US/Canada driver's license
// see https://bit.ly/2KFu6by for options
mUsdlRecognizer = new UsdlRecognizer();
// create MyKadFrontRecognizer for scanning front side of Malaysian MyKad document
// see https://bit.ly/2Kwz7DO for options
mMyKadFrontRecognizer = new MyKadFrontRecognizer();
// bundle recognizers into RecognizerBundle
mRecognizerBundle = new RecognizerBundle(mMrtdRecognizer, mUsdlRecognizer, mMyKadFrontRecognizer);
}
public void startScanning() {
// Settings for DocumentScanActivity activity
DocumentUISettings settings = new DocumentUISettings(mRecognizerBundle);
// tweak settings as you wish
// Start activity
ActivityRunner.startActivityForResult(this, MY_REQUEST_CODE, settings);
}
@Override
protected void onActivityResult(int requestCode, int resultCode, Intent data) {
super.onActivityResult(requestCode, resultCode, data);
if (requestCode == MY_REQUEST_CODE) {
if (resultCode == DocumentScanActivity.RESULT_OK && data != null) {
// load the data into all recognizers bundled within your RecognizerBundle
mRecognizerBundle.loadFromIntent(data);
// now every recognizer object that was bundled within RecognizerBundle
// has been updated with results obtained during the scanning session
// you can get the result by invoking getResult on recognizer
MrtdRecognizer.Result mrtdResult = mMrtdRecognizer.getResult();
if (mrtdResult.getResultState() == Recognizer.Result.State.Valid) {
// result is valid, you can use it however you wish
}
UsdlRecognizer.Result usdlResult = mUsdlRecognizer.getResult();
if (usdlResult.getResultState() == Recognizer.Result.State.Valid) {
// result is valid, you can use it however you wish
}
MyKadFrontRecognizer.Result myKadFrontResult = mMyKadFrontRecognizer.getResult();
if (myKadFrontResult.getResultState() == Recognizer.Result.State.Valid) {
// result is valid, you can use it however you wish
}
}
}
}
}
Copy to clipboard
class ViewController: UIViewController, MBDocumentOverlayViewControllerDelegate {
var mrtdRecognizer: MBMrtdRecognizer?
override func viewDidLoad() {
super.viewDidLoad()
}
@IBAction func didTapScan(_ sender: AnyObject) {
let settings = MBDocumentOverlaySettings()
mrtdRecognizer = MBMrtdRecognizer()
let recognizerList = [self.mrtdRecognizer!]
let recognizerCollection : MBRecognizerCollection = MBRecognizerCollection(recognizers: recognizerList)
/** Create your overlay view controller */
let documentOverlayViewController : MBDocumentOverlayViewController = MBDocumentOverlayViewController(settings: settings, recognizerCollection: recognizerCollection, delegate: self)
/** Create recognizer view controller with wanted overlay view controller */
let recognizerRunneViewController : UIViewController = MBViewControllerFactory.recognizerRunnerViewController(withOverlayViewController: documentOverlayViewController)
/** Present the recognizer runner view controller. You can use other presentation methods as well (instead of presentViewController) */
present(recognizerRunnerViewController!, animated: true, completion: nil)
}
func documentOverlayViewControllerDidFinishScanning(_ documentOverlayViewController: MBDocumentOverlayViewController, state: MBRecognizerResultState) {
// this is done on background thread
// check for valid state
if state == MBRecognizerResultState.valid {
// first, pause scanning until we process all the results
documentOverlayViewController.recognizerRunnerViewController?.pauseScanning()
DispatchQueue.main.async(execute: {() -> Void in
// All UI interaction needs to be done on main thread
})
}
}
func documentOverlayViewControllerDidTapClose(_ documentOverlayViewController: MBDocumentOverlayViewController) {
// Your action on cancel
}
}
Copy to clipboard
@interface ViewController () <MBDocumentOverlayViewControllerDelegate>
@property (nonatomic, strong) MBMrtdRecognizer *mrtdRecognizer;
@end
@implementation ViewController
- (void)viewDidLoad {
[super viewDidLoad];
}
- (IBAction)didTapScan:(id)sender {
MBDocumentOverlaySettings* settings = [[MBDocumentOverlaySettings alloc] init];
self.mrtdRecognizer = [[MBMrtdRecognizer alloc] init];
/** Create recognizer collection */
MBRecognizerCollection *recognizerCollection = [[MBRecognizerCollection alloc] initWithRecognizers:@[self.mrtdRecognizer]];
MBDocumentOverlayViewController *documentOverlayViewController = [[MBDocumentOverlayViewController alloc] initWithSettings:settings recognizerCollection:recognizerCollection delegate:self];
UIViewController<MBRecognizerRunnerViewController>* recognizerRunnerViewController = [MBViewControllerFactory recognizerRunnerViewControllerWithOverlayViewController:documentOverlayViewController];
/** Present the recognizer runner view controller. You can use other presentation methods as well (instead of presentViewController) */
[self presentViewController:recognizerRunnerViewController animated:YES completion:nil];
}
- (void)documentOverlayViewControllerDidFinishScanning:(MBDocumentOverlayViewController *)documentOverlayViewController state:(MBRecognizerResultState)state {
// this is done on background thread
// check for valid state
if (state == MBRecognizerResultStateValid) {
// first, pause scanning until we process all the results
[documentOverlayViewController.recognizerRunnerViewController pauseScanning];
dispatch_async(dispatch_get_main_queue(), ^{
// All UI interaction needs to be done on main thread
});
}
}
- (void)documentOverlayViewControllerDidTapClose:(MBDocumentOverlayViewController *)documentOverlayViewController {
// Your action on cancel
}
@end