Type alias DocumentDataExtractionStatus

DocumentDataExtractionStatus: "OK" | "OK_BUT_INVALID_DOCUMENT" | "OK_BUT_NOT_CONFIRMED" | "SCANNING_IN_PROGRESS_STILL_FOCUSING" | "ERROR_NOTHING_FOUND" | "ERROR_BAD_CROP" | "ERROR_UNKNOWN_DOCUMENT" | "ERROR_UNACCEPTABLE_DOCUMENT"

The status of the extraction process.

  • OK: The document data was extracted.
  • OK_BUT_INVALID_DOCUMENT: The document data was extracted. Some fields in the document have failed validation, e.g. because the document is damaged, not authentic, or does not have all required fields.
  • OK_BUT_NOT_CONFIRMED: The document data was extracted. Some fields have not yet been confirmed.
  • SCANNING_IN_PROGRESS_STILL_FOCUSING: Document data extraction in progress. Waiting for camera to finish focusing.
  • ERROR_NOTHING_FOUND: No document was detected.
  • ERROR_BAD_CROP: A document was detected at an angle or distance that 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.

Generated using TypeDoc