scanbotsdk
    Preparing search index...

    Type Alias DocumentDataExtractionStatus

    DocumentDataExtractionStatus:
        | "OK"
        | "OK_BUT_LOW_CONFIDENCE_RESULTS"
        | "OK_BUT_INVALID_DOCUMENT"
        | "SCANNING_IN_PROGRESS"
        | "SCANNING_IN_PROGRESS_STILL_FOCUSING"
        | "ERROR_NOTHING_FOUND"
        | "ERROR_BAD_CROP"
        | "ERROR_UNKNOWN_DOCUMENT"
        | "ERROR_UNACCEPTABLE_DOCUMENT"

    The status of the extraction process. Some values are only applicable in live mode, some only in single-shot mode.

    • OK: The document data was successfully extracted.
    • 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: The document data was extracted, but some fields failed validation (e.g., document is damaged, not authentic, or missing required fields).
    • 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: Document data extraction in progress. Waiting for camera to finish focusing. (Live mode only).
    • ERROR_NOTHING_FOUND: No document was detected.
    • ERROR_BAD_CROP: A document was detected, but the angle or distance would result in a poor quality crop.
    • ERROR_UNKNOWN_DOCUMENT: A document was detected, but it does not match any supported document format.
    • ERROR_UNACCEPTABLE_DOCUMENT: A supported document was detected, but it is unacceptable in the current configuration.

    Type Declaration

    • "OK"

      The document data was successfully extracted.

    • "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"

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

    • "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"

      Document data extraction in progress. Waiting for camera to finish focusing. (Live mode only).

    • "ERROR_NOTHING_FOUND"

      No document was detected.

    • "ERROR_BAD_CROP"

      A document was detected, but the angle or distance would result in a poor quality crop.

    • "ERROR_UNKNOWN_DOCUMENT"

      A document was detected, but it does not match any supported document format.

    • "ERROR_UNACCEPTABLE_DOCUMENT"

      A supported document was detected, but it is unacceptable in the current configuration.