Class CreditCardScanningResult

Contains the result of running the credit card scanner.

Hierarchy (view full)

Constructors

constructor

Properties

creditCard detectionStatus quad quadNormalized scanningStatus

Methods

encodeImages release serialize

Constructors

constructor

Properties

Readonly creditCard

creditCard: null | GenericDocument

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

Readonly detectionStatus

detectionStatus: DocumentDetectionStatus

The status of the credit card detection step.

Readonly quad

quad: Point[]

Coordinates of the detected credit card in the input image (clockwise from top-left).

Readonly quadNormalized

quadNormalized: Point[]

Coordinates of the detected credit card in the input image (clockwise from top-left), normalized to the range [0, 1].

Readonly scanningStatus

scanningStatus: CreditCardScanningStatus

The status of the credit card scanning step.

Methods

encodeImages

  • encodeImages(): Promise<void>

  • Returns Promise<void>

release

  • release(): void

  • Returns void

serialize

  • serialize(config?): Promise<{
        creditCard?: 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;
        };
        detectionStatus?: DocumentDetectionStatus;
        quad?: (undefined | {
            x?: number;
            y?: number;
        })[];
        quadNormalized?: (undefined | {
            x?: number;
            y?: number;
        })[];
        scanningStatus?: CreditCardScanningStatus;
        encodeImages?: any;
        release?: any;
        serialize?: any;
    }>

  • Parameters

    Returns Promise<{
        creditCard?: 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;
        };
        detectionStatus?: DocumentDetectionStatus;
        quad?: (undefined | {
            x?: number;
            y?: number;
        })[];
        quadNormalized?: (undefined | {
            x?: number;
            y?: number;
        })[];
        scanningStatus?: CreditCardScanningStatus;
        encodeImages?: any;
        release?: any;
        serialize?: any;
    }>

Settings

Member Visibility

Theme

On This Page

constructorcreditCarddetectionStatusquadquadNormalizedscanningStatusencodeImagesreleaseserialize