Getting started

This page introduces the first steps to using our iOS SDKs.

Privacy Policy and Terms & Conditions of Use

When using our SDKs, please make sure that you agree with our Privacy Policy and our Terms and Conditions of Use.


pod 'DocumentDetector', '~> 8.0.3'
pod 'PassiveFaceLiveness', '~> 5.25.0'
pod 'FaceAuthenticator', '~> 5.11.0'
pod 'DeviceAnalyser', '~> 1.0.0'
pod 'FaceAuth', '~> 3.1.2'
pod 'FaceLiveness', '~> 3.1.2'

Release Candidate

pod 'PassiveFaceLiveness', '6.0.0-rc02'


Deployment Info
iOS 12.0 +
13.4.1 +

Installation via CocoaPods

To integrate our SDK into your project using CocoaPods, follow these steps:
Install CocoaPods:
If you don't have CocoaPods installed, you need to install it first. Open your terminal and execute the following command:
sudo gem install cocoapods
Once CocoaPods is installed, you'll need to create a Podfile for your project. If you don't already have a Podfile, create one using the following command:
pod init
In your Podfile, you need to specify the reference to our framework. If you're adding our SDK for the first time, add the following line, replacing <framework_name> with the actual name of the framework and <version> with the desired version:
pod '<framework_name>', '~> <version>'
Make sure to include the repository source in your Podfile. Add the following lines to your Podfile:
source ''
source '' # or '' if the CDN is down
This will download and set up the specified framework and its dependencies in your project.


source ''
target 'TestApp' do
pod '<Framework Name>', '~> <version>'
After editing your Podfile, save it and install the SDK along with its dependencies by running the following command:
pod install

Post Install

In case of issues with dependency versions, you can use the following code in the Podfile to create compatibility with those versions:
post_install do |installer|
installer.pods_project.targets.each do |target|
if ['iProov', 'Starscream'].include?
target.build_configurations.each do |config|
config.build_settings['BUILD_LIBRARY_FOR_DISTRIBUTION'] = 'YES'
if config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'].to_f < 10.0
config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = '11.0'

Installation via Swift Package Manager (SPM)

To integrate our SDK into your project using Swift Package Manager (SPM), follow these steps:
Step 1 - Open your Project in Xcode: Open your Xcode project or workspace that you want to integrate the SDK into.
Step 2 - Add Package Dependency: In Xcode, navigate to your project settings, select your project, and then choose the Swift Packages tab. Click the + button to add a package dependency.
Step 3 - Enter Package Repository URL: In the "Choose Package Repository" dialog, enter the URL of our SDK's repository:
Note: Currently, Swift Package Manager (SPM) supports integration with a limited set of SDKs. As of now, the only SDKs available for integration via SPM are FaceLiveness and FaceAuth. If you intend to use any other SDK, you might need to explore alternative integration methods.
Step 4 - Add SDK to Target: Once you've selected the version, Xcode will present you with a list of targets to which you can add the SDK. Check the box next to the target you want to integrate the SDK with and click the "Add Package" button. Import the necessary modules using:
import FaceLiveness
import FaceAuth

Language Setting

To enable text and voice in Portuguese, add in Project > Info > Localizations the language Portuguese (Brazil).
Last modified 4d ago