LogoLogo
Useful links
  • Home
  • Product guides
  • API
  • SDKs
  • Overview
  • First steps
  • ANDROID
    • Getting Started with the SDK
    • Standalone Modules
      • Document Detector
        • Release Notes
        • Current Version
        • Requirements
        • Gradle Dependencies
        • Gradle Source Code
        • Setting up the SDK
          • Setting properties
          • Capture Stages
          • Messages Settings
          • Customization
          • Security Settings
          • Detection Steps
          • Upload Mode
          • Advanced Settings
            • Proxy configuration
            • Preview configuration
        • Start Document Detection
        • Source Code
        • Google security form
        • Reduce SDKs size
        • SDKs response
        • References
        • FAQ
      • Face Liveness
        • Release Notes
        • Current Version
        • Requirements
        • Gradle Dependencies
        • Gradle Source Code
        • SDK Lifecycle
        • Building the SDK
        • Start Liveness Verification
        • Source Code
        • References
        • Advanced Features
        • FAQ
      • Face Authenticator
        • Release Notes
      • Smart Auth
        • Release Notes
        • Current Version
        • Requirements
        • Gradle Dependencies
        • Gradle Source Code
        • Permissions
        • SDK Lifecycle
        • Building the SDK
        • Start Smart Authentication
        • Source Code
        • References
        • FAQ
      • Face Liveness (deprecated)
        • Release Notes
  • iOS
    • Getting Started with the SDK
    • Standalone Modules
      • Document Detector
        • Release Notes
        • Current Version
        • Requirements
        • Installing the SDK
        • Setting up the SDK
          • Setting properties
          • Messages Settings
          • Customization
          • Detection Steps
          • Upload Mode
          • Advanced Settings
            • Proxy configuration
            • Preview configuration
        • Start Document Detection
        • References
        • FAQ
      • Face Liveness
        • Release Notes
        • Installation
        • Current Version
        • Requirements
        • SDK Lifecycle
        • Building the SDK
        • Start Liveness Verification
        • Source Code
        • References
        • FAQ
      • Face Authenticator
        • Release Notes
        • Installation
        • Current Version
        • Requirements
        • Building the SDK
        • Start the SDK
        • References
        • FAQ
      • Smart Auth
        • Release Notes
        • Installation
        • Current Version
        • Requirements
        • SDK Lifecycle
        • Building the SDK
        • Start Smart Authentication
        • Source Code
        • References
        • FAQ
      • Face Liveness (deprecated)
        • Release Notes
  • REACT NATIVE
    • Standalone Modules
      • Document Detector
        • Release Notes
        • Current Version
        • Requirements
        • Installation
        • Hooks
        • Start Document Verification
        • Source Code
        • TypeScript References
        • Customizing Style
        • FAQ
      • Face Liveness
        • Release Notes
        • Current Version
        • Requirements
        • Installation
        • Hooks
        • Start Liveness Verification
        • Source Code
        • TypeScript References
        • FAQ
      • Face Authenticator
        • Release Notes
        • Current Version
        • Requirements
        • Installation
        • Hooks
        • Start Authentication Verification
        • Source Code
        • TypeScript References
        • FAQ
      • Smart Auth
        • Getting started
        • Release notes
        • Using Native Modules
          • Requirements
          • Gradle Source Code
          • Podfile Source Code
          • Native Module Android
          • Native Module iOS
          • Import Native Modules
          • Source Code
          • TypeScript References
          • FAQ
        • Using Expo Modules
          • Requirements
          • Create Local Expo Module
          • Gradle Source Code
          • Podspec Source Code
          • Native Module Android
          • Native Module iOS
          • Import Expo Modules
          • Source Code
          • TypeScript References
          • FAQ
  • WEB (JAVASCRIPT)
    • Standalone Modules
      • Document Detector
        • Getting started
        • SDK builder options
          • Analytics
          • Appearance
          • Messages
        • SDK methods
        • Event listeners
        • Customization
        • Release notes
      • Face Liveness
        • Customization
        • Release notes
      • Face Authenticator
        • Customization
        • Release notes
      • Smart Auth
        • SDK errors
        • Customization
        • Release notes
LogoLogo

2025 © Caf. - All rights reserved

On this page
  • Types
  • CafSmartAuthResponse
  • CafSmartAuthSuccess
  • CafSmartAuthPending
  • CafFaceAuthenticationSettings
  • CafSmartAuthTheme
  • CafSmartAuthThemeConfigurator
  • CafSmartAuthSettings
  • Enums
  • CafStage
  • CafFilter
  1. REACT NATIVE
  2. Standalone Modules
  3. Smart Auth
  4. Using Native Modules

TypeScript References

Types

CafSmartAuthResponse

Field
Type
Description

success

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

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.

CafFaceAuthenticationSettings

Field
Type
Description
Android
iOS

filter

Used to change the SDK filter.

✅

✅

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

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

Defines the visual theme for the authentication screen in light mode.

✅

✅

darkTheme

Defines the visual theme for the authentication screen in dark mode.

✅

✅

CafSmartAuthSettings

Field
Type
Description
Android
iOS

faceAuthenticationSettings

Used to change the SDK filter.

✅

✅

stage

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

Sets the theme configuration for the SDK. Customize appearance for light and dark modes.

✅

✅

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.

✅

✅

Last updated 1 month ago

CafSmartAuthSuccess
CafSmartAuthPending
CafFilter
CafSmartAuthTheme
CafSmartAuthTheme
CafFaceAuthenticationSettings
CafStage
CafSmartAuthThemeConfigurator