> For the complete documentation index, see [llms.txt](https://docs.caf.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.caf.io/caf-sdk/ios/standalone-modules/caffacelivenesslite/release-notes.md).

# Release Notes

Quick links: [Overview](https://docs.caf.io/caf-sdk/ios/standalone-modules/caffacelivenesslite.md) | [Building the SDK](https://docs.caf.io/caf-sdk/ios/standalone-modules/caffacelivenesslite/builder.md) | [Start Liveness Verification](https://docs.caf.io/caf-sdk/ios/standalone-modules/caffacelivenesslite/start-sdk.md) | [UI Customization](https://docs.caf.io/caf-sdk/ios/standalone-modules/caffacelivenesslite/ui-customization.md) | [Installation](https://docs.caf.io/caf-sdk/ios/standalone-modules/caffacelivenesslite/installation.md) | [Current Version](https://docs.caf.io/caf-sdk/ios/standalone-modules/caffacelivenesslite/current-version.md) | [Requirements](https://docs.caf.io/caf-sdk/ios/standalone-modules/caffacelivenesslite/requirements.md) | [Source Code](https://docs.caf.io/caf-sdk/ios/standalone-modules/caffacelivenesslite/source-code.md) | [Result Reference](https://docs.caf.io/caf-sdk/ios/standalone-modules/caffacelivenesslite/result-reference.md) | [Release Notes](https://docs.caf.io/caf-sdk/ios/standalone-modules/caffacelivenesslite/release-notes.md) | [FAQ](https://docs.caf.io/caf-sdk/ios/standalone-modules/caffacelivenesslite/faq_caf_face_liveness_sdk.md)

## v7.8.0

Distributed in **CafSDKiOS 7.8.0**.

### Versioning

* From this release, the CafFaceLivenessLite version matches the CafSDKiOS version. The previous Lite release was 3.1.0.

### New Features

* **`getVersion()`:** new static method `CafFaceLivenessLiteSDK.getVersion()` returns the SDK version as a `String` (for example `"7.8.0"`). It needs no instance and no `setup`. See [Building the SDK](https://docs.caf.io/caf-sdk/ios/standalone-modules/caffacelivenesslite/builder.md).

### Improvements

* **Result delivered before the capture screen closes:** `didFinishWithSuccess`, `didFinishWithFailure`, `didFinishWithError` and `cancelled()` returns while the capture screen is still visible.
* **Regional routing:** the SDK sends its requests to the region defined in your token. The region is set server-side when the token is issued; if the token carries none, the environment default is used. No integration changes required.

### Distribution

* CocoaPods: `pod 'CafSDKiOS/CafFaceLivenessLite', '7.8.0'`
* CAF repository (new): the xcframework, podspec, `Package.swift` and SHA256 checksum are published at `https://repo.combateafraude.com/ios/release/CafFaceLivenessLite/7.8.0/`, as they are for Android. See [Installation](https://docs.caf.io/caf-sdk/ios/standalone-modules/caffacelivenesslite/installation.md#caf-repository-binary-distribution).

***

## v3.1.0

Distributed in **CafSDKiOS 7.7.0**.

### Improvements

* **Result delivered as soon as the capture ends:** `didFinishWithSuccess` / `didFinishWithFailure` now fire the moment the capture completes, with no network round trip in between.

### Updates

* **Error mapping:** a session rejected because the account is not enabled for the asynchronous flow now reports `didFinishWithError(type: .tokenException, description:)`. A session that arrives without the data needed to complete the flow reports `.tokenException` or `.invalidResponseException`. See [Result Reference](https://docs.caf.io/caf-sdk/ios/standalone-modules/caffacelivenesslite/result-reference.md).

### Distribution

* CocoaPods: `pod 'CafSDKiOS/CafFaceLivenessLite', '7.7.0'`

***

## v3.0.0

Distributed in **CafSDKiOS 7.6.0**.

### Breaking changes

* **`startSDK` split into `setup` + `startSDK`:** configuration no longer travels with the start call. Call `setup(...)` once with your credentials and options, then `startSDK(viewController:)` to present the capture screen. The previous `startSDK(viewController:mobileToken:personId:…)` overload was **removed, not deprecated** — existing calls will fail to compile.
* **`startSDK` before `setup` is an error:** calling `startSDK(viewController:)` without a prior `setup(...)` reports `didFinishWithError(type: .invalidOptionsException, description:)` and does not open a session.

### Migration

Every argument of the old `startSDK` except `viewController:` moves to `setup(...)`, with the same labels, types and defaults.

```swift
// Before (2.1.0)
sdk.startSDK(
    viewController: self,
    mobileToken: "your_mobile_token",
    personId: "your_person_id",
    customLocalization: nil,
    customLocalizationBundle: nil,
    uiCustomization: nil,
    environment: .prod,
    loading: true
)

// After (3.0.0)
sdk.setup(
    mobileToken: "your_mobile_token",
    personId: "your_person_id",
    customLocalization: nil,
    customLocalizationBundle: nil,
    uiCustomization: nil,
    environment: .prod,
    loading: true
)
sdk.prewarm()                       // optional — see below
sdk.startSDK(viewController: self)
```

Adopting `setup` alone is enough to migrate: if you never call `prewarm()`, the flow behaves exactly as it did in 2.1.0.

### New Features

* **Session prewarming:** new optional `prewarm()` method that performs the session request ahead of time — for example while the user reads an instructions screen — so `startSDK` can open the camera without waiting on the network. The prewarmed session is valid for **90 seconds** and is consumed by the next `startSDK`. If it is missing, stale or was created with different credentials, `startSDK` silently falls back to the regular flow, so prewarming can never break a capture. See [Start Liveness Verification](https://docs.caf.io/caf-sdk/ios/standalone-modules/caffacelivenesslite/start-sdk.md).

### Distribution

* CocoaPods: `pod 'CafSDKiOS/CafFaceLivenessLite', '7.6.0'`

***

## v2.1.0

Distributed in **CafSDKiOS 7.5.0**.

### New Features

* **UI customization:** new optional `uiCustomization: CerttaUiCustomization?` parameter on `startSDK` to brand the liveness screen — header bar (title, colors, close button, logo), guidance prompt (colors, rounded corners), area around the face oval (color, blur) and font. Fully optional and backward compatible: omitting it, or leaving individual fields `nil`, keeps the current appearance. See [UI Customization](https://docs.caf.io/caf-sdk/ios/standalone-modules/caffacelivenesslite/ui-customization.md).

### Distribution

* CocoaPods: `pod 'CafSDKiOS/CafFaceLivenessLite', '7.5.0'`

***

## v2.0.2

Distributed in **CafSDKiOS 7.4.1**.

### Improvements

* **Analytics:** Improving observability and troubleshooting.

### Updates

* Updated iProov dependency to **13.2.0**.
* **iProov SP change:** The SDK now follows the iProov SP provided by the backend. Server-side change — no integration changes required.

### Distribution

* CocoaPods: `pod 'CafSDKiOS/CafFaceLivenessLite', '7.4.1'`

***

## v2.0.1

Distributed in **CafSDKiOS 7.3.2**.

### Bug Fixes

* **`cancelled()` delivery timing:** `CafFaceLivenessLiteDelegate.cancelled()` is now delivered only after iProov's camera view controller has finished dismissing.

### Distribution

* CocoaPods: `pod 'CafSDKiOS/CafFaceLivenessLite', '7.3.2'`

***

## v2.0.0

Distributed in **CafSDKiOS 7.3.1**.

### Breaking changes

* **Async-only transaction start:** After capture, the SDK now calls the async route. The response contains only an opaque `signedResponse` JWT. The final liveness result (`isAlive`, images) must be retrieved by your backend out-of-band — the SDK does not poll.
* **`executeFaceAuth` removed:** Face Auth is no longer supported by `CafFaceLivenessLite`. Calls that pass `executeFaceAuth` will fail to compile. Use the full Face Liveness / Face Auth products if you need that flow.

### Migration

```swift
// Before (1.x)
sdk.startSDK(
    viewController: self,
    mobileToken: token,
    personId: personId,
    customLocalization: nil,
    environment: .prod,
    loading: true,
    executeFaceAuth: false
)

// After (2.0.0)
sdk.startSDK(
    viewController: self,
    mobileToken: token,
    personId: personId,
    customLocalization: nil,
    customLocalizationBundle: nil,
    environment: .prod,
    loading: true
)
```

### New Features

* **`customLocalizationBundle`:** Optional `Bundle?` parameter on `startSDK` that maps to iProov `options.stringsBundle`. Use it together with `customLocalization` (strings table name) when your `Localizable.strings` live in a framework or host bundle other than the main app bundle — for example `Bundle(for: CafFaceLivenessLiteSDK.self)`.

### Distribution

* CocoaPods: `pod 'CafSDKiOS/CafFaceLivenessLite', '7.3.1'`

***

## v1.2.1

### New Features

* **Security Monitoring:** Added `enableSecurity: Bool = true` constructor parameter to `CafFaceLivenessLiteSDK`. When enabled, the SDK performs jailbreak detection, dylib monitoring, and instrumentation detection. Disable only in automated testing environments.
* **New Error Types:** Added four new cases to `CafErrorType`:
  * `cameraException`: Camera hardware error
  * `certificateException`: Certificate validation failed
  * `invalidOptionsException`: Invalid SDK configuration options provided
  * `securityException`: Security violation detected (raised when `enableSecurity: true` and instrumentation or hooking is detected)

### Distribution

* CocoaPods: `pod 'CafSDKiOS/CafFaceLivenessLite', '6.4.2'`

***

## v1.2.0

### Updates

* Minimum supported iOS version updated to **15.0+**.
* Updated iProov dependency to **13.1.0**.
* **New Failure Options:** Added new failure cases to `CafFailureType`: `eyewear`, `faceNotFound`, `framesBlurry`, `lightingIssues`, `motionIssue`, `backgroundIssue`, `deviceIssue`, `deviceRestart`, `systemError`, `rejected`, `timeout`, `userNotFound`, `processingFault`.

### Important Notice

* Reverse proxy support will be discontinued in a future release. A necessary iProov-related update is required to keep iProov working and prevent certificate issues. **After March 15, 2026, Faceliveness and Faceauth services could be unavailable.**

## v1.1.0

### New Features

* **Face Authentication Error Handling:** Added a new `faceAuthentication` case to `CafErrorType` to specifically handle backend errors when `executeFaceAuth` is enabled.

## v1.0.0

Initial release of the lightweight face liveness SDK.

### Highlights

* Smaller footprint with streamlined integration
* Delegate-based lifecycle with success, failure, and error callbacks
* Optional FaceAuth execution after liveness
* Basic localization override via `customLocalization`


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.caf.io/caf-sdk/ios/standalone-modules/caffacelivenesslite/release-notes.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
