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
  1. ANDROID
  2. Standalone Modules
  3. Document Detector
  4. Setting up the SDK

Setting properties

Here is the updated table with Kotlin-like parameters and default values included in the description where applicable:

Parameter
Description
Required

mobileToken: String

Token associated with your account, to use the SDK.

✅

setPersonId(personId: String?)

User identifier for fraud profile identification purposes and to assist in the identification of Analytics logs in cases of bugs and errors.

❌

setDocumentCaptureFlow(documentSteps: Array<DocumentDetectorStep>)

Defines the document capture flow as explained.

✅

setCaptureStages(captureStages: Array<CaptureStage>)

Configures the requirements for each capture stage. Designed to make capture more flexible in cases where the user is unable to capture with all checks active, preventing them from getting stuck at this stage in their registration flow.

❌

setPopupSettings(show: Boolean)

Enables/disables the popups displayed before each document capture. Default: true.

❌

setLayout(layoutId: Int?)

❌

setStyle(styleResourceId: Int)

❌

setNetworkSettings(requestTimeout: Int)

Defines SDK's requests timeout. Default: 60 seconds.

❌

setLuminositySensorSettings(sensorLuminositySettings: SensorLuminositySettings?)

Defines the threshold between acceptable/unacceptable ambient brightness. Default: 5 lx. Set null to disable this sensor.

❌

setOrientationSensorSettings(sensorOrientationSettings: SensorOrientationSettings?)

Defines the threshold between correct/incorrect device orientation. Higher values make it more flexible. Default: 3 m/s². Set null to disable this sensor.

❌

setStabilitySensorSettings(sensorStabilitySettings: SensorStabilitySettings?)

Defines stability sensor settings. Default: 2000 ms and 0.5 m/s². Set null to disable this sensor.

❌

setProxySettings(proxySettings: ProxySettings)

❌

setPreviewSettings(previewSettings: PreviewSettings)

Enables/disables and configures the visualization of the performed capture, requesting the user's confirmation to proceed. Default: disabled.

❌

setCurrentStepDoneDelay(showDelay: Boolean, delay: Int)

Delays the activity after the completion of each step. This method can be used to display a success message on the screen itself after the capture, for example. Default: false.

❌

setMessageSettings(messageSettings: MessageSettings)

❌

setResolutionSettings(resolution: Resolution)

Allows you to set the capture resolution. Options: FULL_HD (1920 x 1080), QUAD_HD (2560 x 1440), ULTRA_HD (3840 x 2160). Default: FULL_HD.

❌

setCompressSettings(compressQuality: Int)

Configures the quality in the compression process. Expects values between 80 and 100, where 100 is the best quality compression. Default: 90.

❌

enableGoogleServices(enable: Boolean)

Enables/disables features of the SDK that consume Google Services. Default: true. Disabling is not recommended due to the loss of security.

❌

setUseDeveloperMode(use: Boolean)

Enables developer mode when true. Not recommended for production; use only for testing. Default: false.

❌

setUseAdb(use: Boolean)

Enables Android Debug Bridge (ADB) debugging mode when true. Not recommended for production; use only for testing. Default: false.

❌

setUseDebug(use: Boolean)

Allows using the app in debug mode when true. Not recommended for production; use only for testing. Default: false.

❌

setGetImageUrlExpireTime(expireTime: String)

Sets the time the image URL will last on the server until it expires. Accepts intervals like 30m (minutes), 24h (hours), 10d (days). Examples: 30m, 1h 10m, 10d. Default: 3h.

❌

setUploadSettings(uploadSettings: UploadSettings)

❌

setAllowedPassportCountriesList(countryList: Array<CountryCodeList>)

❌

useManualCaptureAsFallback

Defines whether manual capture should be used as a fallback mechanism when there are problems initializing the embedded AI. By default, this fallback mechanism is disabled.

❌

Last updated 17 days ago

Overrides the default SDK layout. Create a file in the layout folder of your project, copy this , and make the changes you want.

Sets up a new style guideline for the SDK. Create a styles.xml file in your project with this and customize it.

Defines proxy settings. Follow ). Default: null.

Customizes messages displayed in the feedback label during the capture and analysis process. See the available attributes .

Configures document upload settings. The SDK flow will prompt the user to upload the document files instead of capturing them. Includes document type and quality checks. See . Default: disabled.

Restricts accepted passports to specific issuing countries. See the full list of country codes . Example: setAllowedPassportCountriesList(arrayOf(CountryCodesList.BRA)). Default: All countries.

template
template
this guide
here
details here
here