FAQ
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 Requirements section.
3. What permissions are required to use the SDK?
Answer:
The SDK requires the following permissions:
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:
Add the SDK dependencies to your
build.gradlefile.Configure necessary permissions for the camera and internet access in your app’s
AndroidManifest.xml.Initialize the SDK in your application’s lifecycle, typically within
onCreate()of your main activity.
For detailed instructions, please refer to the Gradle setup section.
5. 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.
6. How do I start the document capture process in my app?
Answer:
To start the document capture process, follow these steps:
Build a capture session using the SDK’s builder.
Start the document capture activity.
Capture the result in the activity’s callback.
For more details on how to initiate the process, refer to the Start SDK section.
7. Does Document Detector support uploading documents instead of using the camera?
Answer:
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 Upload Mode section.
8. What are the typical errors or issues that could occur, and how can I troubleshoot them?
Answer:
Some common errors include:
Security Failure: It usually happens when the user is with developer mode, debug mode or ADB enabled. Check the security returns sections for more information.
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 more troubleshooting details, refer to the SDK responses section.
Last updated
