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. What is Document Detector and what is its main functionality?
  • 2. What are the system requirements for Document Detector on Android?
  • 3. What permissions are required to use the SDK?
  • 4. How do I integrate Document Detector into my Android project?
  • 5. What is the current version of the SDK, and where can I find version-specific details?
  • 6. How do I start the document capture process in my app?
  • 7. Does Document Detector support uploading documents instead of using the camera?
  • 8. What are the typical errors or issues that could occur, and how can I troubleshoot them?
  1. ANDROID
  2. Standalone Modules
  3. Document Detector

FAQ

Last updated 2 months ago


1. What is Document Detector and what is its main functionality?

Answer:

Document Detector allows users to capture authentic, high-quality photos of user-submitted documents for analysis using our API. It supports document capture and reading through both camera and upload modes. The tool can process various types of documents, from national IDs to international passports.


2. What are the system requirements for Document Detector on Android?

Answer:

The SDK supports Android API 26 and above, ensuring compatibility with modern Android devices. Your Android project should use a minimum SDK version of 26.

For more requirement details, such as Kotlin and Gradle version, please refer to the .


3. What permissions are required to use the SDK?

Answer:

The SDK requires the following permissions:

Permission
Reason
Required

CAMERA

To capture photos of the documents.

Only for capture feature.

READ_EXTERNAL_STORAGE

To access the device external storage and select documents in the upload flow.

Only for upload feature.

Ensure these are added to your AndroidManifest.xml and handle permission requests in your app appropriately for Android versions that require runtime permission requests.


4. How do I integrate Document Detector into my Android project?

Answer:

To integrate the SDK:

  1. Add the SDK dependencies to your build.gradle file.

  2. Configure necessary permissions for the camera and internet access in your app’s AndroidManifest.xml.

  3. Initialize the SDK in your application’s lifecycle, typically within onCreate() of your main activity.


5. What is the current version of the SDK, and where can I find version-specific details?

Answer:


6. How do I start the document capture process in my app?

Answer:

To start the document capture process, follow these steps:

  1. Build a capture session using the SDK’s builder.

  2. Start the document capture activity.

  3. Capture the result in the activity’s callback.


7. Does Document Detector support uploading documents instead of using the camera?

Answer:


8. What are the typical errors or issues that could occur, and how can I troubleshoot them?

Answer:

Some common errors include:

  • SDK initialization failure: Check your Gradle setup and ensure the SDK is properly initialized in the app lifecycle.

  • Network errors: Ensure the device has an active internet connection for document processing.

For detailed instructions, please refer to the .

The current version of the SDK is regularly updated. You can find the latest version information, including changelogs and version-specific details, .

For more details on how to initiate the process, refer to the .

Yes, Document Detector supports document capture through both camera and upload modes. To learn more about enabling and using the upload mode, please refer to the .

Security Failure: It usually happens when the user is with developer mode, debug mode or ADB enabled. Check the sections for more information.

For more troubleshooting details, refer to the .

Requirements section
Gradle setup section
here
Start SDK section
Upload Mode section
SDK responses section
security returns