Skip to content
master
Switch branches/tags
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 

README.md

Version License Platform

Regula Document Reader SDK (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 sample projects that demonstrate the API calls you can use to interact with the Document Reader library.

Content

How to build demo application

  1. Get the trial license at licensing.regulaforensics.com (regula.license file).
  2. Download or clone the current repository using the command git clone https://github.com/regulaforensics/DocumentReader-iOS.git.
  3. Repository structure and steps to build the projects:
    1. Advanced folder contains the advanced sample project with almost all available features. To build it, do the following steps:

      1. Go to the Advanced folder. There you will find the project written in Swift.
      2. Go to the project folder.
      3. Install Pods: open Terminal within the root project folder and run pod install command.
      4. Copy the license file to the project: Advanced/DocumentReader-Swift/DocumentReader-Swift.
      5. Open the project in Xcode (DocumentReader-Swift.xcworkspace file).
      6. Change the Bundle Identifier to that you specified in your license file.
      7. Run the project.
    2. Basic folder contains the basic sample project with only main features. To build it, do the following steps:

      1. Go to the Basic folder. There you will two projects: one is written in Swift, another in Objective-C.
      2. Go to the project folder: DocumentReaderObjectiveC-sample or DocumentReaderSwift-sample.
      3. Install Pods: open Terminal within the root project folder and run pod install command.
      4. Copy the license file to the project: Basic/DocumentReaderObjectiveC-sample/DocumentReaderObjectiveC-sample or Basic/DocumentReaderSwift-sample/DocumentReaderSwift-sample.
      5. Open the project in Xcode (DocumentReaderObjectiveC-sample.xcworkspace or DocumentReaderSwift-sample.xcworkspace file).
      6. Change the Bundle Identifier to that you specified in your license file.
      7. Run the project.

Troubleshooting license issues

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

  • The OS, which you use, is specified in the license (iOS).
  • The Bundle Identifier, which you use, is specified in the license.
  • The license is valid (not expired).
  • The date and time on the device, where you run the application, are valid.
  • You use the latest release version of the Document Reader SDK.
  • You placed the license into the correct 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.