Regula Document Reader (React Native version)

Regula Document Reader SDK allows you to read various kinds of identification documents, passports, driving licenses, ID cards, etc. All processing is performed completely offline on your device. No any data leaving your device.

You can use native camera to scan the documents or image from gallery for extract all data from it.

We have provided a simple application that demonstrates the API calls you can use to interact with the Document Reader Library.

Content

• How to build demo application
• How to add Document Reader library to your project
• Troubleshooting license issues
• Documentation
• Additional information

How to build demo application

1. Get a trial license for demo application at licensing.regulaforensics.com (regula.license file).
2. Download or clone current repository using the command git clone https://github.com/regulaforensics/React-Native-DocumentReader.git.
3. Run the following commands in Terminal:

$ cd DocumentReader
$ npm install
$ cd ios
$ pod install

Note: make sure that Metro Bundler is running when you run your app. Otherwise, run npx react-native start command. If it fails to start, run git init from Project root, then npx react-native start.

4. Android:

• Copy the regula.license file to the DocumentReader/android/app/src/main/assets folder.
• Run npx react-native run-android inside DocumentReader folder - this is just one way to run the app. You can also run it directly from within Android Studio. Note: npx react-native log-android is used to view logs.

5. iOS:

• Copy the regula.license file to the DocumentReader/ios/DocumentReader folder.
• Run react-native run-ios inside DocumentReader folder - this is just one way to run the app. You can also run it directly from within Xcode.

How to add Document Reader to your project

Document Reader libraries are available on npm. First of all, install API library, simply running the following command:

$ npm install react-native-document-reader-api

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

• Install bounds library edition:

$ npm install react-native-document-reader-core-bounds

• Install mrz library edition:

$ npm install react-native-document-reader-core-mrz

• Install mrzrfid library edition:

$ npm install react-native-document-reader-core-mrzrfid

• Install barcode library edition:

$ npm install react-native-document-reader-core-barcode

• Install barcodemrz library edition:

$ npm install react-native-document-reader-core-barcodemrz

• Install doctype library edition:

$ npm install react-native-document-reader-core-doctype

• Install ocrandmrz library edition:

$ npm install react-native-document-reader-core-ocrandmrz

• Install full library edition:

$ npm install react-native-document-reader-core-full

• Install fullrfid library edition:

$ npm install react-native-document-reader-core-fullrfid

Troubleshooting license issues

If you have issues with license verification when running the application, please verify that next is true:

1. The OS, which you use, is specified in the license (e.g., Android and/or iOS).
2. The application (Bundle) ID, which you use, is specified in the license.
3. The license is valid (not expired).
4. The date and time on the device, where you run the application, are valid.
5. You use the latest release version of the Document Reader SDK.
6. You placed the license into the correct folder as described here How to build demo application (DocumentReader/android/app/src/main/assets or DocumentReader/ios/DocumentReader folder).

Documentation

You can find documentation on API here.

Additional information

If you have any technical questions, feel free to contact us or create issue here.

To use our SDK in your own app you need to purchase a commercial license.