Ctrlk
Useful links
For the complete documentation index, see llms.txt. This page is also available as Markdown.

FAQ

1. What is CafFaceAuth and what is its main functionality?

Answer:

CafFaceAuth is a comprehensive authentication SDK designed to enhance security in iOS applications. Its primary functionalities include facial authentication with proof of life (liveness) verification and fingerprint authentication. These features enable secure and seamless login experiences and safeguard sensitive actions such as financial transactions.

2. What are the system requirements for CafFaceAuth on iOS?

Answer:

The SDK requires the following iOS configurations:

Deployment Info
Version

iOS Target

15.0+

Xcode

15.4+

Swift

5.5+

Ensure your project is configured to meet these requirements before integrating the SDK.

3. What permissions are required to use the SDK?

Answer:

The SDK requires specific permissions in your app's info.plist file:

Permission

Reason

Required?

Privacy - Camera Usage Description

Capturing the selfie in live facial verification policies.

Yes.

Make sure to provide appropriate descriptions for these permissions to comply with App Store guidelines.

4. How do I integrate CafFaceAuth into my iOS project?

Answer:

To integrate the SDK:

  1. Install the SDK using Swift Package Manager or another dependency manager.

  2. Add the required permissions in your info.plist file.

  3. Import the SDK into your code and initialize it in the app lifecycle, typically within the AppDelegate or SceneDelegate.

For step-by-step integration details, refer to the Installation Guide.

5. How do I start the face authentication process in my app?

Answer:

To initiate the face authentication process:

  1. Configure the SDK capture session using its builder.

  2. Launch the capture view controller using your preferred navigation method.

  3. Handle the result callback with the face authentication data.

For more implementation details, see the Face Authentication Guide.

6. What are the common issues or errors, and how can I troubleshoot them?

Answer:

Some common issues include:

  • Permission Denied: Ensure required permissions (Camera) are included in the info.plist file and granted by the user.

  • SDK Initialization Failure: Check that the SDK is initialized correctly and dependencies meet the required versions.

  • App Crashes During Capture: Verify the view controller integration and test on supported iOS devices.

For a complete list of errors and troubleshooting steps, refer to the Troubleshooting Guide.

7. What is the current version of the SDK, and where can I find updates?

Answer:

The SDK version is updated regularly to include new features and improvements. You can find the latest version details, release notes, and updates in the SDK Release Notes.

Last updated