Building the SDK

Quick links: Overview | Building the SDK | Start Liveness Verification | UI Customization | Installation | Current Version | Requirements | Source Code | Result Reference | Release Notes | FAQ

Creating a Liveness SDK instance

Instantiate CafFaceLivenessLiteSDK directly and configure behavior via the constructor and startSDK parameters.

Constructor

CafFaceLivenessLiteSDK(enableSecurity: Bool = true)

Parameter	Type	Required	Description
enableSecurity	Bool	No	Enables security monitoring: jailbreak detection, instrumentation detection, and dylib monitoring. Default: true. Disable only in automated testing environments.

startSDK Parameters

Parameter	Type	Required	Description
mobileToken	String	Yes	Mobile authentication token
personId	String	Yes	Person ID for liveness
environment	CafEnvironment (enum)	No	.prod (default), .beta, .dev
loading	Bool	No	Shows SDK loading screen (default: true)
customLocalization	String?	No	Use a custom strings table/bundle prefix (e.g., "stringsBundle")
customLocalizationBundle	Bundle?	No	Bundle that contains the custom strings table (maps to iProov options.stringsBundle)
uiCustomization	CerttaUiCustomization?	No	Optional visual branding for the liveness screen: header bar, prompt, mask area and font. See UI Customization

Note: customLocalization maps to the iProov strings table name (omit the .strings extension). When strings live outside the main app bundle (for example inside a redistributed framework), also pass customLocalizationBundle. See the iProov localization guide: iProov Localization.

From 2.0.0, Face Auth (executeFaceAuth) is no longer available on Lite. After a successful capture the SDK starts an async transaction and returns only signedResponse; your backend retrieves the final liveness result out-of-band.

Example

import CafFaceLivenessLite

final class YourViewController: UIViewController {
    private let sdk = CafFaceLivenessLiteSDK(enableSecurity: true)

    override func viewDidLoad() {
        super.viewDidLoad()
        sdk.delegate = self
    }

    private func start() {
        sdk.startSDK(
            viewController: self,
            mobileToken: "your_mobile_token",
            personId: "your_person_id",
            customLocalization: nil,
            customLocalizationBundle: nil,
            environment: .prod,
            loading: true
        )
    }
}