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
  • FaceLivenessResponse
  • FaceLivenessResult
  • FaceLivenessFailure
  • FaceLivenessError
  • FaceLivenessSettings
  • Enums
  • Stage
  • Filter
  • Time
  • Error
  1. REACT NATIVE
  2. Standalone Modules
  3. Face Liveness

TypeScript References

Types

FaceLivenessResponse

Field
Type
Description

result

Shows when face liveness returns a successful capture.

failure

Shows when face liveness returns a failure capture.

error

Shows when the face livenes return some error.

cancelled

boolean

Shows when user cancel the liveness.

isLoading

boolean

Shows when the face liveness is loading.

FaceLivenessResult

Field
Type
Description

signedResponse

string

The signed response confirming the captured selfie is genuine.

FaceLivenessFailure

Field
Type
Description

message

string

Detailed fail message.

type

string

Detailed type fail message.

FaceLivenessError

Field
Type
Description

message

string

Detailed error message.

type

Enum describing the type of error.

FaceLivenessSettings

Field
Type
Description
Android
iOS

cafStage

Used to redirect the SDK to the desired stage in caf api.

✅

✅

filter

Used to change the SDK filter.

✅

✅

imageUrlExpirationTime

Used to customize the image URL expiration time.

✅

✅

enableScreenshots

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.

✅

✅

certificates

string[]

Used to set pinned certificates for reverse proxy implementation.

✅

✅

faceLivenessBaseUrl

string

Used to enable the use of reverse proxy to execute face liveness. If used, the certificates must be set with the setCertificates method.

✅

✅

authenticationBaseUrl

string

Used to enable the use of reverse proxy to execute SDK's authentications.

✅

✅

Enums

Stage

Field
Description
Android
iOS

BETA

Beta environment.

✅

✅

PROD

Production environment.

✅

✅

Filter

Field
Description
Android
iOS

LINE_DRAWING

Alternative mask for face liveness.

✅

✅

NATURAL

Normal mask for face liveness.

✅

✅

Time

Field
Description
Android
iOS

THREE_HOURS

Image url expiration time expires in three hours.

✅

✅

THIRTY_DAYS

Image url expiration time expires in thirty days.

✅

✅

THIRTY_MIN

Image url expiration time expires in thirty minutes.

❌

✅

Error

Field
Description
Android
iOS

UnknownException

Indicates an unknown issue.

✅

✅

CameraPermission

Indicates that camera permission is required for liveness verification.

✅

✅

NetworkException

Indicates a network-related exception occurred during verification.

✅

✅

ServerException

Indicates a server-side exception occurred during verification.

✅

✅

TokenException

Indicates an issue with the token used for verification.

✅

✅

UnsupportedDevice

Indicates that the device is unsupported for liveness verification.

✅

✅

CertificateException

Indicates an exception occurred on certificate pinning.

✅

✅

Last updated 14 days ago

FaceLivenessResult
FaceLivenessFailure
FaceLivenessError
Error
Stage
Filter
Time