Ionic Framework 4 is almost here. Preview the beta docs and try it out now! Try Ionic 4 Beta

Regula Document Readerβ

Improve this doc

This plugin is still in beta stage and may not work as expected. Please submit any issues to the plugin repo.

Plugin for reading and validation of identification documents.

Repo: https://github.com/regulaforensics/cordova-plugin-documentreader.git

Installation

  1. Install the Cordova and Ionic Native plugins:
    $ ionic plugin add cordova-plugin-documentreader --variable CAMERA_USAGE_DESCRIPTION="To take photo"
    $ npm install --save @ionic-native/regula-document-reader
    
  2. Add this plugin to your app's module

Supported platforms

Usage

import { RegulaDocumentReader } from '@ionic-native/regula-document-reader';

let license; // read regula.license file
RegulaDocumentReader.initReader(license); // initialize reader
RegulaDocumentReader.scanDocument().then((result) => {
        // read result
})

Instance Members

initReader(license)

Initialize the scanner

Param Type Details
license any

License data

scanDocument()

Run the scanner

Returns: Promise<string[]> Returns a promise that resolves when results was got, and fails when not

API

Native

General