Skip to content

Installation

Requirements

Android

The following tools should be installed:

The minimum API Level is 16 for the following Core types:

  • barcode
  • barcodemrz
  • bounds
  • doctype
  • full
  • mrz
  • ocrandmrz

The minimum API Level is 19 for the following Core types:

  • mrzrfid
  • barcodemrzrfid
  • ocrandmrzrfid
  • fullrfid

iOS

  • The following IDE should be installed: Xcode.
  • The minimum iOS version is 9.0.

Installation

Document Reader libraries are available on npm.

First of all, install API library, simply running the following command:

$ cordova plugin add @regulaforensics/cordova-plugin-document-reader-api --variable CAMERA_USAGE_DESCRIPTION="To take photo" --variable READ_EXTERNAL_STORAGE="To choose photo"

And then add one of the Core libraries depend on the functionality that you wish and the license capabilities:

  • Install bounds library edition:
$ cordova plugin add @regulaforensics/cordova-plugin-document-reader-core-bounds
  • Install mrz library edition:
$ cordova plugin add @regulaforensics/cordova-plugin-document-reader-core-mrz
  • Install mrzrfid library edition:
$ cordova plugin add @regulaforensics/cordova-plugin-document-reader-core-mrzrfid
  • Install barcode library edition:
$ cordova plugin add @regulaforensics/cordova-plugin-document-reader-core-barcode
  • Install barcodemrz library edition:
$ cordova plugin add @regulaforensics/cordova-plugin-document-reader-core-barcodemrz
  • Install barcodemrzrfid library edition:
$ cordova plugin add @regulaforensics/cordova-plugin-document-reader-core-barcodemrzrfid
  • Install doctype library edition:
$ cordova plugin add @regulaforensics/cordova-plugin-document-reader-core-doctype
  • Install ocrandmrz library edition:
$ cordova plugin add @regulaforensics/cordova-plugin-document-reader-core-ocrandmrz
  • Install ocrandmrzrfid library edition:
$ cordova plugin add @regulaforensics/cordova-plugin-document-reader-core-ocrandmrzrfid
  • Install full library edition:
$ cordova plugin add @regulaforensics/cordova-plugin-document-reader-core-full
  • Install fullrfid library edition:
$ cordova plugin add @regulaforensics/cordova-plugin-document-reader-core-fullrfid
Back to top