Document Manipulation Result

Defined under the namespace Scandit.Datacapture.Id

DocumentManipulationStatus

Added in version 8.7.0

Whether the cloud document manipulation check produced a verdict.

Ok

Added in version 8.7.0

A verdict was produced.

TamperingCheckFailed

Added in version 8.7.0

The request completed but the Scandit cloud could not produce a usable verdict.

RequestFailed

Added in version 8.7.0

The request did not complete, for example because of a timeout or a network error.

DocumentManipulationVerdict

Added in version 8.7.0

Overall verdict of the cloud document manipulation check.

Genuine

Added in version 8.7.0

No sign of manipulation was found.

Manipulated

Added in version 8.7.0

The document shows signs of manipulation.

Inconclusive

Added in version 8.7.0

The document could not be assessed, typically because of image quality.

DocumentManipulationCheckResult

Added in version 8.7.0

Outcome of one check of the cloud document manipulation check.

Pass

Added in version 8.7.0

The check found no sign of manipulation.

Fail

Added in version 8.7.0

The check found signs of manipulation.

Unverifiable

Added in version 8.7.0

The check could not be performed on this document or image.

DocumentManipulationResult

class DocumentManipulationResult

Added in version 8.7.0

Outcome of the cloud document manipulation check run when the scanner is configured with SingleSideScannerOptions.manipulationCheck, available as VerificationResult.documentManipulationResult. A document is delivered as captured when the verdict is DocumentManipulationVerdict.Genuine or DocumentManipulationVerdict.Inconclusive, and rejected with RejectionReason.ManipulatedDocument when it is DocumentManipulationVerdict.Manipulated. The checks, their evidence and the verdict are produced by the Scandit cloud; this class exposes them as returned. Experimental.

status

get status(): DocumentManipulationStatus

Added in version 8.7.0

Whether a verdict was produced; see error when it was not.

verdict

get verdict(): DocumentManipulationVerdict | null

Added in version 8.7.0

The verdict; null when no verdict was produced.

assessable

get assessable(): boolean | null

Added in version 8.7.0

False when the image quality was too poor to assess the document; the verdict is then DocumentManipulationVerdict.Inconclusive.

checks

get checks(): DocumentManipulationCheck[]

Added in version 8.7.0

The individual checks of the rubric.

summary

get summary(): string | null

Added in version 8.7.0

A short reviewer-facing summary of the verdict.

error

get error(): string | null

Added in version 8.7.0

Set when the request failed (timeout, HTTP error) or the response could not be parsed.

vlmRequestId

get vlmRequestId(): string | null

Added in version 8.7.0

Identifier of the cloud request, for support inquiries.

DocumentManipulationCheck

class DocumentManipulationCheck

Added in version 8.7.0

One check of the cloud document manipulation check rubric, as returned by the Scandit cloud. Experimental.

name

get name(): string

Added in version 8.7.0

Name of the check.

result

get result(): DocumentManipulationCheckResult | null

Added in version 8.7.0

Outcome of the check; null when the Scandit cloud reported a value this SDK version does not know.

confidence

get confidence(): string | null

Added in version 8.7.0

The model’s confidence in the result, when provided.

evidence

get evidence(): string | null

Added in version 8.7.0

Short evidence text supporting the result, when provided.