References
CafFilterStyle
natural
The original captured selfie.
lineDrawing
A line drawing filter applied to the captured selfie.
CafFaceLivenessSettings
faceLivenessToken
Usage token associated with your CAF account.
useLoadingScreen
Boolean value to enable or disable the loading screen.
filter
Filter style to apply to the captured selfie.
CafSmartAuthError
The CafSmartAuthError enum represents various types of errors that may occur in the SDK:
PermissionReason
Some mandatory permission is missing.
AvailabilityReason
CafSmartAuth is not available for use.
NetworkReason
Internet connection failure.
ServerReason
When a request receives a failure status code.
SecurityReason
The SDK cannot be started due to a security-related issue.
StorageReason
There is insufficient space in the internal storage of the user's device.
PolicyReason
A policy being used is not supported by the SDK.
GetLocationReason
Error retrieving the user's location.
TerminateByUser
Process was terminated by the user.
CafFailureType
The CafFailureType enum represents detailed feedback codes for liveness failures:
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
This section provides a reference to the main configurable properties and potential errors for the CafSmartAuth SDK on iOS.
Last updated