Skip to content

Installation

How to install Document Reader SDK.

Overview

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

Document Reader SDK consists of two frameworks: API and Core.

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.

Requirements

  • The latest stable version of Xcode.

  • Minimum target: iOS 11.0.

Installation

CocoaPods

To always use the latest release, add the following to your Podfile:

Podfile
1
2
pod 'DocumentReader'
pod 'DocumentReaderFullRFID'

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

Podfile
1
2
pod 'DocumentReader', '1.0.0'
pod 'DocumentReaderFullRFID', '1.0.0'

And then run in Terminal the command below to install pods in your project:

pod install

Manual Integration

1. Download the latest API framework.

2. Download the latest Common framework.

3. Download one of the Core frameworks depending on the functionality you need and the license capabilities.

4. Drag DocumentReader.xcframework, DocumentReaderCore.xcframework, and RegulaCommon.xcframework frameworks into the Frameworks, Libraries, and Embedded Content section of your target:

5. Build and run the project.

Compatibility

The following table lists which version of Common framework is required for each version of the API framework.

API version Common version
< 5.7.* Not required
5.8.* 5.8.*
6.1.* 6.1.*
6.2.* 6.2.*
6.3.* 6.3.*
6.4.* 6.4.*

Next Steps