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
  • DocumentDetectorResult
  • Capture
  1. ANDROID
  2. Standalone Modules
  3. Document Detector

References

DocumentDetectorResult

Parameter
Description
Allow Null

captures: Array<Capture>

Array of captures for the documents provided. Can be null in case of an error.

✅

type: String

✅

trackingId: String

Identifier for this execution on our servers. Required for analytics and debugging.

❌

sdkFailure: SDKFailure?

Indicates the reason for SDK shutdown. Null if the operation is successful.

✅

Possible Values for type

The parameter type can have one of the following values:

  • "blank"

  • "cnh"

  • "cnh_new"

  • "generic"

  • "rg"

  • "rg_new"

  • "rne"

  • "rnm"

  • "ctps"

  • "passport"

  • "crlv"

  • "crlv_new"

  • "cin"

Capture

Parameter
Description
Allow Null

imagePath: String

Full path of the image on the user's device.

❌

imageUrl: String

URL of the document on the Caf's server. This URL expires, and expiry time can be set using setGetImageUrlExpireTime.

❌

label: String

❌

quality: Double

Quality score inferred by the document quality algorithm. Ranges between 0 and 5.

❌

Possible Values for captures

The parameter captures can have one of the following values:

  • "blank"

  • "cnh_back"

  • "cnh_front"

  • "cnh_full"

  • "new_cnh_back"

  • "new_cnh_front"

  • "new_cnh_full"

  • "crlv"

  • "crlv_new"

  • "generic"

  • "rg_back"

  • "rg_front"

  • "rg_full"

  • "rg_new_back"

  • "rg_new_front"

  • "rg_new_full"

  • "rne_back"

  • "rne_front"

  • "rnm_back"

  • "rnm_front"

  • "ctps_back"

  • "ctps_front"

  • "passport"

  • "cin_front"

  • "cin_back"

Last updated 2 months ago

Class of the document stream. Possible values are listed above. Can be null in case of error. The possible value are listed in the

Label of the respective document. Possible values are listed in the .

section below
section below