FAQ

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

Answer:

Document Detector allows users to capture high-quality and authentic 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, such as national IDs and international passports.

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

Answer:

The SDK requires the following iOS configurations:

Deployment Info
Version

iOS Target

13.0+

Xcode

15.4+

Swift

5.3.2+

Ensure your project is configured to meet these requirements before integrating the SDK.

3. What permissions are required to use the SDK?

Answer:

The SDK requires specific permissions in your app's info.plist file:

Permission

Reason

Required?

Privacy - Camera Usage Description

To capture document photos.

No, only required for the camera stream.

Privacy - Photo Library Usage Description

To access photos in the gallery.

No, only required for the upload stream.

Make sure to provide appropriate descriptions for these permissions to comply with App Store guidelines.

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

Answer:

To integrate the SDK:

  1. Install the SDK using Swift Package Manager or another dependency manager.

  2. Add the required permissions in your info.plist file.

  3. Import the SDK into your code and initialize it in the app lifecycle, typically within the AppDelegate or SceneDelegate.

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

Answer:

To initiate the document capture process:

  1. Configure the SDK capture session using its builder.

  2. Launch the capture view controller using your preferred navigation method.

  3. Handle the result callback with the captured document data.

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

Answer:

Yes, the SDK supports two modes for document input:

  • Camera Mode: Capture documents using the device camera.

  • Upload Mode: Upload existing photos from the device’s photo library.

7. What are the common issues or errors, and how can I troubleshoot them?

Answer:

Some common issues include:

  • Permission Denied: Ensure required permissions (Camera or Photo Library) are included in the info.plist file and granted by the user.

  • SDK Initialization Failure: Check that the SDK is initialized correctly and dependencies meet the required versions.

  • App Crashes During Capture: Verify the view controller integration and test on supported iOS devices.

8. What is the current version of the SDK, and where can I find updates?

Answer:

Last updated