Getting started

Terms & Policies

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

Current versions

Library	Version	npm
DocumentDetector	1.0.0	@caf.io/react-native-document-detector
FaceLiveness	1.4.0	@caf.io/react-native-face-liveness
FaceAuthenticator	1.3.0	@caf.io/react-native-face-authenticator

Requirements

The libraries are compatible only with React Native versions that are 0.66.5 or later.

Android

Settings	Minimum version
minSdkVersion	21
compileSdkVersion	34
Java version	8

iOS

Settings	Minimum version
Target	12
Xcode	14.3.1
Swift	5.5

ProGuard settings

If you use ProGuard or a similar tool that includes shrink or obfuscation rules in your project, you may need to add these exceptions for our SDKs to work properly.

# With R8 full mode generic signatures are stripped for classes that are not
# kept. Suspend functions are wrapped in continuations where the type argument
# is used.
-keep,allowobfuscation,allowshrinking class kotlin.coroutines.Continuation

# R8 full mode strips generic signatures from return types if not kept.
-if interface * { @retrofit2.http.* public *** *(...); }
-keep,allowoptimization,allowshrinking,allowobfuscation class <3>

# With R8 full mode generic signatures are stripped for classes that are not kept.
-keep,allowobfuscation,allowshrinking class retrofit2.Response

R8 / PROGUARD

If you are using R8 the shrinking and obfuscation rules are included automatically.

ProGuard users must manually add the options from retrofit2.pro.

You might also need rules for OkHttp and Okio which are dependencies of this library.