TypeScript References
Types
CafSmartAuthResponse
CafSmartAuthResponse
error
string
Shows when the smart auth return some error.
cancelled
boolean
Shows when user cancel the smart auth.
isLoading
boolean
Shows when the smart auth is loading.
CafSmartAuthSuccess
CafSmartAuthSuccess
isAuthorized
boolean
A Boolean value indicating whether the smart auth is genuine.
attemptId
string
The ID of the face liveness verification attempt.
attestation
string
The signed response confirming the smart auth is genuine.
CafSmartAuthPending
CafSmartAuthPending
isAuthorized
boolean
A Boolean value indicating whether the smart auth is genuine.
attestation
string
The signed response confirming the smart auth is genuine.
CafFaceAuthenticationSettings
CafFaceAuthenticationSettings
enableScreenCapture
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.
✅
✅
CafSmartAuthTheme
CafSmartAuthTheme
backgroundColor
string
Background color of the authentication screen.
✅
✅
textColor
string
Color of primary text on the screen.
✅
✅
progressColor
string
Color of the progress indicator.
✅
✅
linkColor
string
Color of clickable links.
✅
✅
boxBackgroundColor
string
Background color of input fields.
✅
✅
boxFilledBackgroundColor
string
Background color of input fields when filled.
❌
✅
boxBorderColor
string
Border color of input fields.
✅
✅
boxFilledBorderColor
string
Border color of input fields when filled.
❌
✅
boxTextColor
string
Text color inside input fields.
✅
✅
CafSmartAuthThemeConfigurator
CafSmartAuthThemeConfigurator
CafSmartAuthSettings
CafSmartAuthSettings
emailUrl
string
Sets the email authentication URL. Must be HTTPS protocol.
✅
✅
phoneUrl
string
Sets the phone authentication URL. Must be HTTPS protocol.
✅
✅
theme
Sets the theme configuration for the SDK. Customize appearance for light and dark modes.
✅
✅
Enums
CafStage
CafStage
DEV
Developmemnt environment
✅
✅
BETA
Beta environment.
✅
✅
PROD
Production environment.
✅
✅
CafFilter
CafFilter
NATURAL
Normal mask for face liveness.
✅
✅
LINE_DRAWING
Alternative mask for face liveness.
✅
✅
Last updated