Skip to content


How to install Document Reader SDK.


graph LR
  A(Document Reader SDK) --> B(Ionic wrapper);
  A --> C(API);
  A --> D(Core);
  C --> E(Common);
  A -.- F[(Database)];

Document Reader SDK consists of three plugins: Ionic wrapper, API, and Core.

Ionic wrapper provides the interface to access the Document Reader Cordova API.

API framework provides the external interface for controlling the process and getting the result. It depens on the Common framework that is an interface for working with the camera and other modules that are used in other Regula SDKs.

Core framework provides the recognition functionality where all the processing happens. This is the internal framework, it is used by the API framework only and is not accessible for developers. However, it should be referenced in the project.

Database contains the documents' data. It's mandatory to have it if you use the Core type that supports document type recognition.



To the latest release version, run the following commands in Terminal:

npm install --save @regulaforensics/ionic-native-document-reader
ionic cordova plugin add @regulaforensics/cordova-plugin-document-reader-api
ionic cordova plugin add @regulaforensics/cordova-plugin-document-reader-core-fullrfid

Alternatively, you can indicate a specific version (e.g. 1.0.0):

npm install --save @regulaforensics/ionic-native-document-reader@1.0.0
ionic cordova plugin add @regulaforensics/cordova-plugin-document-reader-api@1.0.0
ionic cordova plugin add @regulaforensics/cordova-plugin-document-reader-core-fullrfid@1.0.0

Now, you can import the SDK in your code.

Next Steps