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 iOS?
  • 3. What permissions are required to use the SDK?
  • 4. How do I integrate Document Detector into my iOS project?
  • 5. How do I start the document capture process in my app?
  • 6. Does Document Detector support uploading documents instead of using the camera?
  • 7. What are the common issues or errors, and how can I troubleshoot them?
  • 8. What is the current version of the SDK, and where can I find updates?
  1. iOS
  2. Standalone Modules
  3. Document Detector

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 2 months ago

For step-by-step integration details, refer to the .

For more implementation details, see the .

You can configure the preferred mode during session setup. For detailed implementation, see the .

For a complete list of errors and troubleshooting steps, refer to the .

The SDK version is updated regularly to include new features and improvements. You can find the latest version details, release notes, and updates in the .

Installation Guide
Document Capture Guide
Upload Mode Documentation
SDK Release Notes
Troubleshooting Guide