Document

@Serializable
class Document : Cloneable

Defines options and settings for document analysis.

Types

Link copied to clipboard
@Serializable
class Advanced : Cloneable

WARNING: Advanced settings have the capacity to drastically alter the session and can lead to a poor user experience. Please consult the support team before using any of these settings.

Link copied to clipboard
@Serializable
class Check : Cloneable

Defines options and settings for the analysis of check images.

Link copied to clipboard

Describes requirements to extract certain contents out of images.

Link copied to clipboard

Describes document orientation control options.

Link copied to clipboard

Describes trigger actions to pick document images.

Properties

Link copied to clipboard

WARNING: Advanced settings have the capacity to drastically alter the session and can lead to a poor user experience. Please consult the support team before using any of these settings.

Link copied to clipboard

Sets whether the barcode needs to be read. Used when combining barcode and document analysis.

Link copied to clipboard
Link copied to clipboard

Sets whether data needs to be read from the document.

Link copied to clipboard

Sets whether document classification should be enabled. This feature requires a license with the document classification feature enabled.

Link copied to clipboard

Sets whether frame feedback should be processed for manual sessions. This feature requires a license with the enhanced manual feature enabled. WARNING: If you're legally required to disable the ReviewFragment look into your target "analysis fragment's" WorkflowSettings to set the appropriate review condition that adjusts to your needs.

Link copied to clipboard

Enables the MiSnap session to attempt a camera focus when acquiring the final frame. This feature allows to improve the level of detail in the final frame, the level of detail depends on the hardware and it's suitable for scenarios where the images may be reviewed by humans. NOTE: This feature is not supported for check sessions.

Link copied to clipboard

Sets the expected orientation of the document.

Enables prioritizing the document extraction results over the quality of the image when the documentExtractionRequirement is set to ExtractionRequirement.REQUIRED. NOTE: this setting can lead to faster extraction sessions but result in low quality images, this setting is not compatible with extraction requirements other than ExtractionRequirement.REQUIRED and features that highly depend on image quality such as enableDocumentClassification.

Link copied to clipboard

Indicates if the optional data contents should be redacted out of the results when extraction is requested. NOTE: Redaction is only supported for NLD documents. WARNING: When this option is enabled in combined workflows, steps with OnMissingNldBSN behavior will be skipped. The video recording feature requires no frame processing therefore optional data will not be redacted in a recorded video. It is your responsibility to enable or disable video recording as per your needs.

Link copied to clipboard

The trigger condition used to pick which image to return.