Skip to content

iOS

This guide provides step-by-step instructions on installing the IDV SDK into an iOS application.

Prerequisites

Before integrating the SDK, ensure the following:

  • Minimum Deployment Target: iOS 14+
  • Camera permission enabled
  • NFC permission enabled
  • Internet permission enabled

The Regula IDV SDK installed via CocoaPods or Swift Package Manager.

The SDK includes multiple modules (Document Reader SDK, Face SDK). Include only the modules required for your workflow and follow their specific setup instructions.

Add Regula SDK to Your Project

CocoaPods

1. Add the base dependency into your Podfile:

target 'YourAppTarget' do
  use_frameworks!

  pod 'IDVSDK'
end

2. Run installation:

pod install

Optional modules installation guides

Swift Package Manager (SPM)

Swift Package Collection

You can add all Regula products in one place:

swift package-collection add https://pods-master.regulaforensics.com/SPM/PodsCollection-signed.json

Or in Xcode:

1. Navigate to File -> Add Package Dependencies

2. Click + and select Add Package Collection

3. Enter the collection URL:

https://pods-master.regulaforensics.com/SPM/PodsCollection-signed.json

4. Click Load -> Add Collection.

5. Select package(s), version, and project and click Add Package. For new projects, we recommend using the latest version.

Once you're finished, Xcode will begin downloading and resolving dependencies.

Add Packages Separately

You can add each package individually instead of using the collection.

1. In Xcode, navigate to File -> Add Package Dependencies.

2. Enter the package URL:

https://github.com/regulaforensics/IDVSDK-Swift-Package

3. Select package(s), version, and project and click Add Package. For new projects, we recommend using the latest version.

4. If needed, install additional modules:

Once you're finished, Xcode will begin downloading and resolving dependencies.