Class CheckScanner

API for check scanning.

Required licence feature(s): CheckScanner.

Methods

destroy run create

Methods

destroy

  • destroy(): Promise<void>

  • Frees up any resources associated with this object. No other methods may be called on this object after destroy has been called.

    Returns Promise<void>

run

Static create

  • create(workerBridge, configuration?): Promise<CheckScanner>

  • Parameters

    • workerBridge: WorkerBridge
    • Optional configuration: {
          acceptedCheckStandards?: CheckStandard[];
          documentDetectionMode?: CheckDocumentDetectionMode;
          processingMode?: ProcessingMode;
      }
      • Optional acceptedCheckStandards?: CheckStandard[]

        Accepted check standards. Optional, by default - all checks are accepted. With an empty list no filter is applied and all checks are accepted.

        Default Value

        [];
      • Optional documentDetectionMode?: CheckDocumentDetectionMode

        Document detection to be performed in addition to scanning the machine-readable data in the check.

        By default only the machine-readable data is extracted during check scanning. Optionally, the coordinates and a crop of the entire check document can be returned, in addition to the check data. A check scan result may still be successful even if the whole document is not visible in the input image and the complete document could not be located.

        If cropping is enabled, check recognition will be performed on the cropped image of the check, which may improve recognition results.

        Default Value

        "DISABLED";
      • Optional processingMode?: ProcessingMode

        Scanners typically can produce better results from a single image if they are allowed to spend a longer time analyzing it.

        On the other hand, scanners can produce even better results if they can analyze multiple images of the same subject and cross-check and combine the results. The processing mode tells the scanner whether to optimize for single or multiple images of a subject.

        Default Value

        "AUTO";

    Returns Promise<CheckScanner>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc