Package io.scanbot.sdk.documentdata

Enum Class DocumentDataExtractionStatus

java.lang.Object
java.lang.Enum<DocumentDataExtractionStatus>
io.scanbot.sdk.documentdata.DocumentDataExtractionStatus
All Implemented Interfaces:
Serializable, Comparable<DocumentDataExtractionStatus>, Constable
public enum DocumentDataExtractionStatus extends Enum<DocumentDataExtractionStatus>
The status of the extraction process. Some values are only applicable in live mode, some only in single-shot mode.

  • Enum Constant Details

    • OK

      public static final DocumentDataExtractionStatus OK
      The document data was successfully extracted.

    • OK_BUT_LOW_CONFIDENCE_RESULTS

      public static final DocumentDataExtractionStatus OK_BUT_LOW_CONFIDENCE_RESULTS
      The document data was extracted, but the confidence is below the acceptable threshold. (Single-shot mode only).

    • OK_BUT_INVALID_DOCUMENT

      public static final DocumentDataExtractionStatus OK_BUT_INVALID_DOCUMENT
      The document data was extracted, but some fields failed validation (e.g., document is damaged, not authentic, or missing required fields).

    • SCANNING_IN_PROGRESS

      public static final DocumentDataExtractionStatus SCANNING_IN_PROGRESS
      Document data extraction in progress. The document data was extracted, but not all fields have been confirmed across enough frames yet. Continue scanning to confirm. (Live mode only).

    • SCANNING_IN_PROGRESS_STILL_FOCUSING

      public static final DocumentDataExtractionStatus SCANNING_IN_PROGRESS_STILL_FOCUSING
      Document data extraction in progress. Waiting for camera to finish focusing. (Live mode only).

    • ERROR_NOTHING_FOUND

      public static final DocumentDataExtractionStatus ERROR_NOTHING_FOUND
      No document was detected.

    • ERROR_BAD_CROP

      public static final DocumentDataExtractionStatus ERROR_BAD_CROP
      A document was detected, but the angle or distance would result in a poor quality crop.

    • ERROR_UNKNOWN_DOCUMENT

      public static final DocumentDataExtractionStatus ERROR_UNKNOWN_DOCUMENT
      A document was detected, but it does not match any supported document format.

    • ERROR_UNACCEPTABLE_DOCUMENT

      public static final DocumentDataExtractionStatus ERROR_UNACCEPTABLE_DOCUMENT
      A supported document was detected, but it is unacceptable in the current configuration.

  • Method Details

    • values

      public static DocumentDataExtractionStatus[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static DocumentDataExtractionStatus valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null