Android Scanbot SDK API reference/io.scanbot.sdk.check/CheckScanningResult

CheckScanningResult

data class CheckScanningResult(val status: CheckMagneticInkStripScanningStatus = CheckMagneticInkStripScanningStatus.ERROR_NOTHING_FOUND, val check: GenericDocument?, val documentDetectionResult: DocumentDetectionResult?, val croppedImage: ImageRef? = null) : AutoCloseable, Parcelable

The result of check scanning.

Constructors

Link copied to clipboard
constructor(source: Map<String, Any?>)
constructor(json: JSONObject)
constructor(status: CheckMagneticInkStripScanningStatus = CheckMagneticInkStripScanningStatus.ERROR_NOTHING_FOUND, check: GenericDocument?, documentDetectionResult: DocumentDetectionResult?, croppedImage: ImageRef? = null)

Properties

Link copied to clipboard
val check: GenericDocument?

Generic document containing check data. Not present, if status is FAIL.

Link copied to clipboard
val croppedImage: ImageRef? = null

Crop of the check if documentDetectionMode is set to DETECT_AND_CROP_DOCUMENT. Will be non-empty, only if check recognition succeeded.

Link copied to clipboard
val documentDetectionResult: DocumentDetectionResult?

The result of document detection. Will be set only if detectDocument in the configuration is set to true. Check scanning may still succeed even if the whole document is not visible in the input image and the complete document could not be located.

Link copied to clipboard
val status: CheckMagneticInkStripScanningStatus

Magnetic ink strip scanning status.

Functions

Link copied to clipboard
Link copied to clipboard
open override fun close()
Link copied to clipboard
fun toJson(config: ToJsonConfiguration = ToJsonConfiguration.default()): JSONObject