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 the Document Detector SDK and what is its main functionality?
  • 2. What are the system requirements for the Document Detector SDK on React Native?
  • 3. What permissions are required to use the SDK?
  • 4. How do I integrate the Document Detector SDK into my React Native project?
  • 5. Is the Document Detector SDK compatible with Expo?
  • 6. What is the current version of the SDK, and where can I find version-specific details?
  • 7. How do I start the Document Detector verification process in my app?
  • 8. What are the typical errors or issues that could occur, and how can I troubleshoot them?
  1. REACT NATIVE
  2. Standalone Modules
  3. Document Detector

FAQ

Last updated 3 months ago


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

Answer:

The Document Detector SDK is designed to capture identity documents, such as RG, CNH, and RNE, with high-quality imaging and reliable data extraction. Instead of relying on a standard camera, it utilizes a smart camera with features like automatic capture and document detection, reducing the chance of low-quality or unusable photos. This functionality enhances onboarding processes, ensuring that documents are captured accurately and efficiently for identity verification and other secure applications.


2. What are the system requirements for the Document Detector SDK on React Native?

Answer:

React Native: The SDK supports React Native versions that are 0.73.x or above.

Android: 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.

iOS: The SDK supports iOS 13 and above, ensuring compatibility with modern iOS devices. Your iOS project should use a minimum deployment target of iOS 13.

For more requirement details, please refer to the .


3. What permissions are required to use the SDK?

Answer:

The SDK requires the following permissions:

  • Android setup:

    • Camera (android.permission.CAMERA)

    • External Library (android.permission.READ_EXTERNAL_STORAGE) Only for upload feature.

    • Internet (android.permission.INTERNET)

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

  • iOS setup:

    • Camera (Privacy - Camera Usage Description)

    • External Library (Privacy - Photo Library Usage Description) Only for upload feature.

Ensure these are added to your Info.plist and handle permission requests in your app appropriately for iOS versions that require runtime permission requests.


4. How do I integrate the Document Detector SDK into my React Native project?

Answer:

To integrate the SDK:

  1. Add the SDK package to your project by running:

    npm intall @caf.io/react-native-document-detector
  2. Configure the necessary permissions for camera and internet access in your app’s AndroidManifest.xml (for Android) and Info.plist (for iOS) files.


5. Is the Document Detector SDK compatible with Expo?

Answer:

  • Android setup:

    1. Add the following Maven repositories to android/build.gradle:

      allprojects { 
          repositories { 
              ... 
              maven { url 'https://repo.combateafraude.com/android/release' }
              maven { url 'https://jitpack.io' }
          } 
      }     
    2. Ensure Java 8 compatibility by configuring android/app/build.gradle.

      android {
          ...
          compileOptions {
              sourceCompatibility JavaVersion.VERSION_1_8
              targetCompatibility JavaVersion.VERSION_1_8
          }
      }
  • iOS setup:

    1. Add the following sources to your Podfile to access required dependencies.

      source 'https://github.com/combateafraude/iOS.git'
      source 'https://cdn.cocoapods.org'

These configurations enable the SDK to function effectively in an Expo environment with native support.


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

Answer:


7. How do I start the Document Detector verification process in my app?

Answer:

To start the document detector, follow these steps:

  1. Import and use the startDocumentDetector function.

  2. Start the document detector activity.

  3. Capture the result in the useDocumentDetector hook.


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

Answer:

Some common errors include:

  • Camera permission not granted: Ensure your app requests the necessary permissions at runtime.

  • 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 the document detector to succeed.

Complete any additional configuration in build.gradle (for Android) and Podfile (for iOS). For detailed instructions, please refer to the .

Yes, the Document Detector SDK can be used with Expo, but only in the , which allows for the necessary native configurations. To set up the SDK for Expo, follow these steps:

For detailed instructions, see 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 .

For more troubleshooting details, refer to the .

Requirements section
Installation section
Bare Workflow
Installation section
here
Start SDK section
Typescript References section