Class CheckScanningResult

The result of check scanning.

Hierarchy (view full)

Constructors

constructor

Properties

check croppedImage documentDetectionResult status

Methods

encodeImages release serialize

Constructors

constructor

Properties

Readonly check

check: null | GenericDocument

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

Readonly croppedImage

croppedImage: null | ImageRef

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

Readonly documentDetectionResult

documentDetectionResult: null | 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.

Readonly status

status: CheckMagneticInkStripScanningStatus

Magnetic ink strip scanning status.

Default is ERROR_NOTHING_FOUND

Methods

encodeImages

  • encodeImages(): Promise<void>

  • Returns Promise<void>

release

  • release(): void

  • Returns void

serialize

  • serialize(config?): Promise<{
        check?: null | {
            children?: (undefined | ({ readonly type?: { readonly name?: string | undefined; readonly fullName?: string | undefined; readonly normalizedName?: string | undefined; readonly listIndex?: number | null | undefined; serialize?: {} | undefined; } | undefined; ... 9 more ...; encodeImages?: {} | undefined; }))[];
            confidence?: number;
            confidenceWeight?: number;
            crop?: null | {
                buffer: undefined | string;
                uniqueId?: string;
                clear?: any;
                clone?: any;
                encodeImage?: any;
                encodeInPlace?: any;
                hibernate?: any;
                info?: any;
                isRetained?: any;
                release?: any;
                retain?: any;
                saveImage?: any;
                serialize?: any;
            };
            fields?: (undefined | {
                confidenceWeight?: number;
                image?: null | {
                    buffer: (...) | (...);
                    uniqueId?: (...) | (...);
                    clear?: any;
                    clone?: any;
                    encodeImage?: any;
                    encodeInPlace?: any;
                    hibernate?: any;
                    info?: any;
                    isRetained?: any;
                    release?: any;
                    retain?: any;
                    saveImage?: any;
                    serialize?: any;
                };
                parsedData?: ((...) | (...))[];
                polygonInRoot?: ((...) | (...))[];
                type?: {
                    commonType?: (...) | (...) | (...);
                    fullName?: (...) | (...);
                    listIndex?: (...) | (...) | (...);
                    name?: (...) | (...);
                    normalizedName?: (...) | (...);
                    serialize?: any;
                };
                validationStatus?: FieldValidationStatus;
                value?: null | {
                    confidence?: (...) | (...);
                    text?: (...) | (...);
                    serialize?: any;
                };
                encodeImages?: any;
                release?: any;
                serialize?: any;
            })[];
            quad?: (undefined | {
                x?: number;
                y?: number;
            })[];
            quadInRoot?: (undefined | {
                x?: number;
                y?: number;
            })[];
            type?: {
                fullName?: string;
                listIndex?: null | number;
                name?: string;
                normalizedName?: string;
                serialize?: any;
            };
            encodeImages?: any;
            release?: any;
            serialize?: any;
        };
        croppedImage?: null | {
            buffer: undefined | string;
            uniqueId?: string;
            clear?: any;
            clone?: any;
            encodeImage?: any;
            encodeInPlace?: any;
            hibernate?: any;
            info?: any;
            isRetained?: any;
            release?: any;
            retain?: any;
            saveImage?: any;
            serialize?: any;
        };
        documentDetectionResult?: null | {
            aspectRatio?: number;
            averageBrightness?: number;
            detectionScores?: {
                angleScore?: number;
                aspectRatioScore?: number;
                distanceScore?: number;
                heightScore?: number;
                lineCoverageScore?: number;
                sizeScore?: number;
                totalScore?: number;
                widthScore?: number;
                serialize?: any;
            };
            horizontalLines?: (undefined | {
                end?: {
                    x?: (...) | (...);
                    y?: (...) | (...);
                };
                start?: {
                    x?: (...) | (...);
                    y?: (...) | (...);
                };
                serialize?: any;
            })[];
            horizontalLinesNormalized?: (undefined | {
                end?: {
                    x?: (...) | (...);
                    y?: (...) | (...);
                };
                start?: {
                    x?: (...) | (...);
                    y?: (...) | (...);
                };
                serialize?: any;
            })[];
            points?: (undefined | {
                x?: number;
                y?: number;
            })[];
            pointsNormalized?: (undefined | {
                x?: number;
                y?: number;
            })[];
            status?: DocumentDetectionStatus;
            verticalLines?: (undefined | {
                end?: {
                    x?: (...) | (...);
                    y?: (...) | (...);
                };
                start?: {
                    x?: (...) | (...);
                    y?: (...) | (...);
                };
                serialize?: any;
            })[];
            verticalLinesNormalized?: (undefined | {
                end?: {
                    x?: (...) | (...);
                    y?: (...) | (...);
                };
                start?: {
                    x?: (...) | (...);
                    y?: (...) | (...);
                };
                serialize?: any;
            })[];
            serialize?: any;
        };
        status?: CheckMagneticInkStripScanningStatus;
        encodeImages?: any;
        release?: any;
        serialize?: any;
    }>

  • Parameters

    Returns Promise<{
        check?: null | {
            children?: (undefined | ({ readonly type?: { readonly name?: string | undefined; readonly fullName?: string | undefined; readonly normalizedName?: string | undefined; readonly listIndex?: number | null | undefined; serialize?: {} | undefined; } | undefined; ... 9 more ...; encodeImages?: {} | undefined; }))[];
            confidence?: number;
            confidenceWeight?: number;
            crop?: null | {
                buffer: undefined | string;
                uniqueId?: string;
                clear?: any;
                clone?: any;
                encodeImage?: any;
                encodeInPlace?: any;
                hibernate?: any;
                info?: any;
                isRetained?: any;
                release?: any;
                retain?: any;
                saveImage?: any;
                serialize?: any;
            };
            fields?: (undefined | {
                confidenceWeight?: number;
                image?: null | {
                    buffer: (...) | (...);
                    uniqueId?: (...) | (...);
                    clear?: any;
                    clone?: any;
                    encodeImage?: any;
                    encodeInPlace?: any;
                    hibernate?: any;
                    info?: any;
                    isRetained?: any;
                    release?: any;
                    retain?: any;
                    saveImage?: any;
                    serialize?: any;
                };
                parsedData?: ((...) | (...))[];
                polygonInRoot?: ((...) | (...))[];
                type?: {
                    commonType?: (...) | (...) | (...);
                    fullName?: (...) | (...);
                    listIndex?: (...) | (...) | (...);
                    name?: (...) | (...);
                    normalizedName?: (...) | (...);
                    serialize?: any;
                };
                validationStatus?: FieldValidationStatus;
                value?: null | {
                    confidence?: (...) | (...);
                    text?: (...) | (...);
                    serialize?: any;
                };
                encodeImages?: any;
                release?: any;
                serialize?: any;
            })[];
            quad?: (undefined | {
                x?: number;
                y?: number;
            })[];
            quadInRoot?: (undefined | {
                x?: number;
                y?: number;
            })[];
            type?: {
                fullName?: string;
                listIndex?: null | number;
                name?: string;
                normalizedName?: string;
                serialize?: any;
            };
            encodeImages?: any;
            release?: any;
            serialize?: any;
        };
        croppedImage?: null | {
            buffer: undefined | string;
            uniqueId?: string;
            clear?: any;
            clone?: any;
            encodeImage?: any;
            encodeInPlace?: any;
            hibernate?: any;
            info?: any;
            isRetained?: any;
            release?: any;
            retain?: any;
            saveImage?: any;
            serialize?: any;
        };
        documentDetectionResult?: null | {
            aspectRatio?: number;
            averageBrightness?: number;
            detectionScores?: {
                angleScore?: number;
                aspectRatioScore?: number;
                distanceScore?: number;
                heightScore?: number;
                lineCoverageScore?: number;
                sizeScore?: number;
                totalScore?: number;
                widthScore?: number;
                serialize?: any;
            };
            horizontalLines?: (undefined | {
                end?: {
                    x?: (...) | (...);
                    y?: (...) | (...);
                };
                start?: {
                    x?: (...) | (...);
                    y?: (...) | (...);
                };
                serialize?: any;
            })[];
            horizontalLinesNormalized?: (undefined | {
                end?: {
                    x?: (...) | (...);
                    y?: (...) | (...);
                };
                start?: {
                    x?: (...) | (...);
                    y?: (...) | (...);
                };
                serialize?: any;
            })[];
            points?: (undefined | {
                x?: number;
                y?: number;
            })[];
            pointsNormalized?: (undefined | {
                x?: number;
                y?: number;
            })[];
            status?: DocumentDetectionStatus;
            verticalLines?: (undefined | {
                end?: {
                    x?: (...) | (...);
                    y?: (...) | (...);
                };
                start?: {
                    x?: (...) | (...);
                    y?: (...) | (...);
                };
                serialize?: any;
            })[];
            verticalLinesNormalized?: (undefined | {
                end?: {
                    x?: (...) | (...);
                    y?: (...) | (...);
                };
                start?: {
                    x?: (...) | (...);
                    y?: (...) | (...);
                };
                serialize?: any;
            })[];
            serialize?: any;
        };
        status?: CheckMagneticInkStripScanningStatus;
        encodeImages?: any;
        release?: any;
        serialize?: any;
    }>

Settings

Member Visibility

Theme

On This Page

constructorcheckcroppedImagedocumentDetectionResultstatusencodeImagesreleaseserialize