FAQ

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 Requirements section.

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:

Add the SDK package to your project by running:

npm intall @caf.io/react-native-document-detector

Configure the necessary permissions for camera and internet access in your app’s AndroidManifest.xml (for Android) and Info.plist (for iOS) files.
Complete any additional configuration in build.gradle (for Android) and Podfile (for iOS). For detailed instructions, please refer to the Installation section.

5. Is the Document Detector SDK compatible with Expo?

Answer:

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

Android setup:

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

allprojects { 
    repositories { 
        ... 
        maven { url 'https://repo.combateafraude.com/android/release' }
        maven { url 'https://jitpack.io' }
    } 
}

Ensure Java 8 compatibility by configuring android/app/build.gradle.

android {
    ...
    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
}

iOS setup:

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.

For detailed instructions, see the Installation section.

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

Answer:

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

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

Answer:

To start the document detector, follow these steps:

Import and use the startDocumentDetector function.
Start the document detector activity.
Capture the result in the useDocumentDetector hook.

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

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.

For more troubleshooting details, refer to the Typescript References section.

Last updated 3 days ago