FAQ

1. What is the Face Authenticator SDK and what is its main functionality?

Answer:

The Face Authenticator SDK provides a solution for verifying whether the face captured by a mobile device's camera is from a live person and not a photo, video, or other forms of spoofing. It’s widely used in scenarios where identity verification is crucial, such as KYC (Know Your Customer), fraud prevention, and secure access.

2. What are the system requirements for the Face Authenticator SDK on React Native?

Answer:

React Native: The SDK supports React Native versions that are 0.73.x or above.

Android: The SDK supports Android API 21 and above, ensuring compatibility with modern Android devices. Your Android project should use a minimum SDK version of 21.

iOS: The SDK supports iOS 13 and above, ensuring compatibility with modern iOS devices. Your iOS project should use a minimum deployment target of iOS 13.

For more requirement details, please refer to the Requirements section.

3. What permissions are required to use the SDK?

Answer:

The SDK requires the following permissions:

Android setup:
- Camera (android.permission.CAMERA)
- Internet (android.permission.INTERNET)

Ensure these are added to your AndroidManifest.xml and handle permission requests in your app appropriately for Android versions that require runtime permission requests.

iOS setup:
- Camera (Privacy - Camera Usage Description)

Ensure these are added to your Info.plist and handle permission requests in your app appropriately for iOS versions that require runtime permission requests.

4. How do I integrate the Face Authenticator SDK into my React Native project?

Answer:

To integrate the SDK:

Add the SDK package to your project by running:

npm intall @caf.io/react-native-face-authenticator

Configure the necessary permissions for camera and internet access in your app’s AndroidManifest.xml (for Android) and Info.plist (for iOS) files.
Complete any additional configuration in build.gradle (for Android) and Podfile (for iOS). For detailed instructions, please refer to the Installation section.

5. Is the Face Authenticator SDK compatible with Expo?

Answer:

Yes, the Face Authenticator SDK can be used with Expo, but only in the Bare Workflow, which allows for the necessary native configurations. Additionally, you must use a development build in Expo, as the SDK relies on native code that is not available in the managed workflow.

Android setup:

Add the following Maven repositories to android/build.gradle:

allprojects { 
    repositories { 
        ... 
        maven { url 'https://repo.combateafraude.com/android/release' }
        maven { url 'https://raw.githubusercontent.com/iProov/android/master/maven/' }
        maven { url 'https://maven.fpregistry.io/releases' }
        maven { url 'https://jitpack.io' }
    } 
}

Ensure Java 8 compatibility by configuring android/app/build.gradle.

android {
    ...
    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
}

iOS setup:

Add the following sources to your Podfile to access required dependencies.

source 'https://github.com/combateafraude/iOS.git'
source 'https://cdn.cocoapods.org'

These configurations enable the SDK to function effectively in an Expo environment with native support.

For detailed instructions, see the Installation section.

6. What is the current version of the SDK, and where can I find version-specific details?

Answer:

The current version of the SDK is regularly updated. You can find the latest version information, including changelogs and version-specific details, here.

7. How do I start the Face Authenticator verification process in my app?

Answer:

To start the authenticator check, follow these steps:

Import and use the startFaceAuthenticator function.
Start the authenticator activity.
Capture the result in the useFaceAuthenticator hook.

For more details on how to initiate the process, refer to the Start SDK section.

8. What are the typical errors or issues that could occur, and how can I troubleshoot them?

Answer:

Some common errors include:

Camera permission not granted: Ensure your app requests the necessary permissions at runtime.
SDK initialization failure: Check your Gradle setup and ensure the SDK is properly initialized in the app lifecycle.
Network errors: Ensure the device has an active internet connection for the authentication check to succeed.

For more troubleshooting details, refer to the Typescript References section.

Last updated 29 days ago