Rejection Reason

Defined under the namespace Scandit.Datacapture.Id

RejectionReason

Added in version 6.24.0

Possible reasons why a document can be rejected.

When multiple rejection conditions apply, only the highest-priority reason is reported. The evaluation order, from highest to lowest priority, is:

  1. NotAcceptedDocumentType — document is in the rejected list

  2. NotAcceptedDocumentType — document is not in the accepted list

  3. ForgedAamvaBarcode

  4. NotRealIdCompliant

  5. InconsistentData

  6. HolderUnderage

  7. DocumentExpired

  8. DocumentExpiresSoon

  9. Timeout

  10. DocumentVoided, InvalidFormat, and others

Although InvalidFormat has the lowest priority in the evaluation order, it arises when a document cannot be parsed at all. In that case, document type and authenticity cannot be determined, so higher-priority reasons are not applicable in practice.

For two-sided documents, InconsistentData is only evaluated after both sides have been captured. If the front side triggers a rejection — such as HolderUnderage, DocumentExpired, or DocumentExpiresSoon — the back side is not scanned and InconsistentData is never evaluated, even though it ranks higher in the precedence order.

On web, AAMVA barcode verification is not performed automatically by the SDK. Use AamvaBarcodeVerifier after a successful capture instead. As a result, ForgedAamvaBarcode is never raised on web.

NotAcceptedDocumentType

Added in version 6.24.0

The type of the presented document is not enabled in the settings.

InvalidFormat

Added in version 6.24.0

The document format is incorrect.

DocumentVoided

Added in version 6.24.0

The document is voided.

Timeout

Added in version 7.0.0

The capture process resulted in a timeout.

SingleImageNotRecognized

Added in version 7.0.0

The capture process resulted in no result. This reason is only used in conjunction with a single image frame source. ID Capture is automatically :meth:id.IdCapture.Reset when this rejection happens. Currently only used by the Web platform

DocumentExpired

Added in version 7.1.0

The document is expired.

DocumentExpiresSoon

Added in version 7.1.0

The document will expire soon.

NotRealIdCompliant

Added in version 7.1.0

The document is not REAL ID compliant.

HolderUnderage

Added in version 7.1.0

The document’s holder is underage.

ForgedAamvaBarcode

Added in version 7.1.0

The document has a forged AAMVA barcode.

InconsistentData

Added in version 7.1.0

The document has inconsistent data.

CloudRequestFailed

Added in version 8.3.0

A request to the cloud failed. The service may be temporarily unavailable.