TypeScript References

Types

CafSmartAuthResponse

Field	Type	Description
success	CafSmartAuthSuccess	Shows when smart auth returns a successful capture.
error	string	Shows when the smart auth return some error.
cancelled	boolean	Shows when user cancel the smart auth.
pending	CafSmartAuthPending	Shows when smart auth is pending.
isLoading	boolean	Shows when the smart auth is loading.

CafSmartAuthSuccess

Field	Type	Description
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

Field	Type	Description
isAuthorized	boolean	A Boolean value indicating whether the smart auth is genuine.
attestation	string	The signed response confirming the smart auth is genuine.

CafSmartAuthError

Field	Type	Description
message	string	A message error emitted from SDK.

CafSmartAuthCancel

Field	Type	Description
isCancelled	boolean	Indicates if the smart auth process was canceled.

CafSmartAuthLoading

Field	Type	Description
isLoading	boolean	Indicates if the smart auth is loading.

CafSmartAuthLoaded

Field	Type	Description
isLoaded	boolean	Indicates if the smart auth is loaded.

CafSmartAuthTheme

Field	Type	Description	Android	iOS
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

Field	Type	Description	Android	iOS
lightTheme	CafSmartAuthTheme	Defines the visual theme for the authentication screen in light mode.	✅	✅
darkTheme	CafSmartAuthTheme	Defines the visual theme for the authentication screen in dark mode.	✅	✅

CafSmartAuthSettings

Field	Type	Description	Android	iOS
faceAuthenticationSettings	CafFaceAuthenticationSettings	Used to change the SDK filter.	✅	✅
stage	CafStage	Used to redirect the SDK to the desired stage in caf api.	✅	✅
emailUrl	string	Sets the email authentication URL. Must be HTTPS protocol.	✅	✅
phoneUrl	string	Sets the phone authentication URL. Must be HTTPS protocol.	✅	✅
theme	CafSmartAuthThemeConfigurator	Sets the theme configuration for the SDK. Customize appearance for light and dark modes.	✅	✅

CafSmartAuthResponse

Field	Type	Description
success	CafSmartAuthSuccess	Shows when smart auth returns a successful capture.
error	CafSmartAuthError | null	Shows when the smart auth returns an error.
cancelled	boolean	Indicates if the user canceled the smart auth process.
pending	CafSmartAuthPending | null	Shows when smart auth is pending.
isLoading	boolean	Indicates if the smart auth process is currently loading.

CafSmartAuthBridgeModuleEvents

Event	Type	Description
CafSmartAuth_Success	CafSmartAuthSuccess	Triggered when a successful capture occurs.
CafSmartAuth_Pending	CafSmartAuthPending	Triggered when the smart auth process is pending.
CafSmartAuth_Error	CafSmartAuthError	Triggered when an error occurs.
CafSmartAuth_Cancel	CafSmartAuthCancel	Triggered when the process is canceled.
CafSmartAuth_Loading	CafSmartAuthLoading	Triggered when the process is loading.
CafSmartAuth_Loaded	CafSmartAuthLoaded	Triggered when the process has loaded.

Enums

CafStage

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

CafFilter

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