iOS Framework for reading and validation of identification documents
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
Samples
.gitignore
DocumentReaderDemo_main.png
DocumentReaderDemo_process.png
DocumentReaderDemo_result.png
README.md Readme updated Jun 27, 2018
target_image.tiff

README.md

Version License Platform

Regula Document Reader (iOS 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 DocumentReader Library. Just take me to the notes!

How to build demo application

You could easily use framework in both languages Swift or Objective C.

  1. Get trial license for demo application at licensing.regulaforensics.com (regula.license file).
  2. Download or clone current repository using command git clone https://github.com/regulaforensics/DocumentReader-iOS.git.
  3. Download and install latest Xcode.
  4. Copy file regula.license to Samples/DocumentReaderSwift-sample/DocumentReaderSwift-sample folder or Samples/DocumentReaderObjectiveC-sample/DocumentReaderObjectiveC-sample for Objective C example.
  5. Open workspace Samples/DocumentReaderSwift-sample/DocumentReaderSwift-sample.xcworkspace in Xcode or Samples/DocumentReaderObjectiveC-sample/DocumentReaderObjectiveC-sample.xcworkspace for Objective C sample.
  6. Change bundle ID to specified during registration of your license key at licensing.regulaforensics.com (regula.DocumentReader by default).
  7. Select target Pod install and run it. Optionally you may install pods manually by running pod install in Samples/DocumentReaderSwift-sample directory

How to add DocumentReader to your project

DocumentReader is available via CocoaPods. To install it, simply add the following lines to your Podfile:

pod 'DocumentReader'

And one of library depend on functionality which you want and license abilities:

  • Install Full library edition:

pod 'DocumentReaderFull'

  • Install Core library edition:

pod 'DocumentReaderCore'

  • Install Bounds library edition:

pod 'DocumentReaderBounds'

  • Install Barcode library edition:

pod 'DocumentReaderBarcode'

  • Install MRZ library edition:

pod 'DocumentReaderMRZ'

  • Install MRZ-Barcode library edition:

pod 'DocumentReaderMRZBarcode'

  • Install OCR library edition:

pod 'DocumentReaderOCR'

  • Install Bank Card library edition:

pod 'DocumentReaderBankCard'

Troubleshooting license issues

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

  1. OS you are using is the same as in the license you received (iOS).
  2. Bundle ID is the same that you specified for license.
  3. Date and time on the device you are trying to run the application is correct and inside the license validity period.
  4. You are using the latest release of the SDK.
  5. You placed the license into the correct folder as described here How to build demo application (DocumentReaderSwift-sample/DocumentReaderSwift-sample).

Additional information

Use Wiki to get more details. If you have any technical questions, feel free to contact us or create issue here.

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