TypeScript References

Types

FaceAuthenticatorResponse

Field	Type	Description
result	FaceAuthenticatorResult	Shows when face authentication returns a successful capture.
error	FaceAuthenticatorError	Shows when the face authentication return some error.
cancelled	boolean	Shows when user cancel the authentication.
isLoading	boolean	Shows when the face authentication is loading.

FaceAuthenticatorResult

Field	Type	Description
signedResponse	string	The signed response confirming the captured selfie is genuine.

FaceAuthenticatorError

Field	Type	Description
description	string	Detailed error message.
errorType	string	Enum describing the type of error.

Field	Type	Description
message	string	Detailed error message.
error	Error	Enum describing the type of error.

FaceAuthenticatorSettings

Field	Type	Description	Android	iOS
cafStage	Stage	Used to redirect the SDK to the desired stage in caf api.	✅	✅
filter	Filter	Used to change the SDK filter.	✅	✅
imageUrlExpirationTime	Time	Used to customize the image URL expiration time.	✅	✅
enableScreenshots	boolean	Used to enable screenshots during the SDK scan. Disabled by default for security reasons.	✅	✅
loadingScreen	boolean	Used to enable a default loading progressbar during loading events.	✅	✅
certificates	string[]	Used to set pinned certificates for reverse proxy implementation.	❌	✅
livenessBaseUrl	string	Used to enable the use of reverse proxy to execute liveness. If used, the certificates must be set with the setCertificates method.	❌	✅
authenticationBaseUrl	string	Used to enable the use of reverse proxy to execute SDK's authentications.	❌	✅

Enums

Stage

Field	Description	Android	iOS
BETA	Beta environment.	✅	✅
PROD	Production environment.	✅	✅

Filter

Field	Description	Android	iOS
LINE_DRAWING	Alternative mask for face liveness.	✅	✅
NATURAL	Normal mask for face liveness.	✅	✅

Time

Field	Description	Android	iOS
THREE_HOURS	Image url expiration time expires in three hours.	✅	✅
THIRTY_DAYS	Image url expiration time expires in thirty days.	✅	✅
THIRTY_MIN	Image url expiration time expires in thirty minutes.	❌	✅

Error

Field	Description	Android	iOS
UnknownException	Indicates an unknown issue.	✅	✅
CameraPermission	Indicates that camera permission is required for liveness verification.	✅	✅
NetworkException	Indicates a network-related exception occurred during verification.	✅	✅
ServerException	Indicates a server-side exception occurred during verification.	✅	✅
TokenException	Indicates an issue with the token used for verification.	✅	✅
UnsupportedDevice	Indicates that the device is unsupported for liveness verification.	✅	✅
CertificateException	Indicates an exception occurred on certificate pinning.	❌	✅