Scanning a check from an image | Capacitor Document Scanner

Detects a check on a still image (PNG or JPG file) regardless of the image source (e.g. scanned document image, image picked from photo library, etc).

ScanbotSDK.recognizeCheck(args: {
    imageFileUri: string;
    acceptedCheckStandards?: CheckStandard[];
  }): Promise<ResultWrapper<RecognizeCheckResult>>

import { ScanbotSDK } from 'capacitor-plugin-scanbot-sdk';

// Always make sure you have a valid license on runtime via ScanbotSDK.getLicenseInfo()
if (!licenseCheckMethod()) { return; }

const result = await ScanbotSDK.recognizeCheck({
    imageFileUri: 'file:///some/image-file.jpg'
});

// Handle the detected check(s) from result

Result

export interface CheckRecognizerResult {
    /** Check Recognizer recognized fields */
    fields: USACheckResult | FRACheckResult | KWTCheckResult | AUSCheckResult | INDCheckResult | UnknownCheckResult;
    /** The status of the operation */
    checkStatus: CheckStatus;
    /** The URI of the snapped Check Image */
    imageFileUri?: string;
    /** The type of the recognized check */
    checkType: CheckStandard;
}

Want to scan longer than one minute?

Generate a free trial license to test the Scanbot SDK thoroughly.

Get your free Trial License

What do you think of this documentation?

What can we do to improve it? Please be as detailed as you like.

---