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

Result Reference

CafFaceLivenessLiteResult – Success Event

Field
Description

signedResponse

Opaque JWT returned by async route. Forward it to your backend; the SDK does not return isAlive or images.

From 2.0.0, a successful capture starts an async transaction. Use signedResponse with your backend to obtain the final liveness outcome.

CafErrorType – Error Handling

Common error types returned via didFinishWithError(type:description:):

Error
Description

unsupportedDevice

Device does not meet minimum HW/SW requirements

cameraPermission

Camera permission not granted

networkException

Network-related error (no internet, timeout, etc.)

serverException

Server-side processing error

tokenException

Invalid or expired token

captureAlreadyActiveException

A previous capture is still active

userTimeoutException

User did not complete the capture in time

imageNotFoundException

Capture image not found

tooManyRequestsException

Rate limiting / too many requests

invalidResponseException

Invalid or malformed server response

permissionException

Generic OS permission error

libraryException

Underlying library failure

unexpectedErrorException

Unexpected internal error

unknownException

Unspecified error

cameraException

Camera hardware error

certificateException

Certificate validation failed

invalidOptionsException

Invalid SDK configuration options provided

securityException

Security violation detected (triggered when enableSecurity: true and instrumentation or hooking is detected)

CafFailureType – Failure References

Available feedback codes returned via didFinishWithFailure(type:description:signedResponse:):

Enum value
Localized description (English)
GPA
LA

unknown

Try again

βœ…

❌

tooMuchMovement

Keep still

βœ…

❌

tooBright

Move somewhere darker

βœ…

❌

tooDark

Move somewhere brighter

βœ…

❌

misalignedFace

Keep your face in the oval

βœ…

❌

faceTooFar

Move your face closer to the screen

βœ…

❌

faceTooClose

Move your face farther from the screen

βœ…

❌

sunglasses

Remove sunglasses

βœ…

❌

systemError

System Error

⚠️

βœ…

rejected

Transaction could not be completed

⚠️

βœ…

faceNotFound

Align your face in the oval and then try to keep still

⚠️

βœ…

obscuredFace

Make sure your whole face is visible and remove any accessories that might cover your face

βœ…

βœ…

timeout

System timeout

⚠️

βœ…

eyewear

Remove your eyewear

⚠️

βœ…

multipleFaces

Ensure only one person is visible

βœ…

βœ…

eyesClosed

Make sure your eyes are open

βœ…

βœ…

userNotFound

Transaction could not be completed

⚠️

βœ…

lightingIssues

Make sure your face is well lit and free from glare

⚠️

βœ…

framesBlurry

Align your face in the oval and then try to keep still

⚠️

βœ…

deviceIssue

Try a different device

⚠️

βœ…

motionIssue

Align your face in the oval and then try to keep still

⚠️

βœ…

backgroundIssue

Move to a different location with a neutral background

⚠️

βœ…

deviceRestart

Please restart your device and try again

⚠️

βœ…

processingFault

Please try again

⚠️

βœ…

Key: βœ… = will be returned, ❌ = will not be returned, ⚠️ = may be returned in the future

Last updated