CheckScanner

API for check scanning. More...

Public Member Functions
None	__init__ (self, *, Optional[CheckScannerConfiguration] configuration=None)
	Initialize the check scanner.
CheckScanningResult	run (self, *, ImageRef image)
	Scan check in the given image.
None	clear_result (self)
	Clears the accumulated results.

Detailed Description

API for check scanning.

Required licence feature(s): CheckScanner.

Constructor & Destructor Documentation

__init__()

None __init__	(		self,
		*	,
		Optional[CheckScannerConfiguration]	configuration = None )

Initialize the check scanner.

Parameters

configuration

The configuration to use for the check scanner.

Member Function Documentation

clear_result()

None clear_result

(

self

)

Clears the accumulated results.

Should be called after a document has been scanned to the customer's satisfaction to prevent a poisoned cache.

run()

CheckScanningResult run	(		self,
		*	,
		ImageRef	image )

Scan check in the given image.

Parameters

image

The image to scan check in.

Returns

The check scanning result.

---

The documentation for this class was generated from the following file:

• api/check/check_scanner.py