@microblink/blinkcard-in-browser-sdk/types/Recognizers/BlinkCard/BlinkCardRecognizer.d.ts

BlinkCard SDK is credit or payment cards scanning library for WebAssembly-enabled browsers.

/**
 * Copyright (c) Microblink Ltd. All rights reserved.
 */
import { ExtensionFactors, FullDocumentImageOptions, ImageResult } from "../BlinkID/ImageOptions";
import { MBDate, Recognizer, RecognizerResult, RecognizerSettings, WasmSDK } from "../../MicroblinkSDK/DataStructures";
export declare enum LivenessStatus {
    /**
     *  Verification process has not been started yet
     */
    NotAvailable = 0,
    /**
     * Hand not present
     */
    HandNotPresent = 1,
    /**
     * Not enough hand present
     */
    NotEnoughHandPresent = 2,
    /**
     * Detected document not in hand
     */
    DocumentNotInHand = 3,
    /**
     * Detected document in hand
     */
    DocumentInHand = 4
}
export type DocumentLivenessCallback = (livenessStatus: LivenessStatus) => void;
export declare enum CheckResult {
    NotPerformed = 0,
    Pass = 1,
    Fail = 2
}
export declare enum MatchLevel {
    Disabled = 0,
    Level1 = 1,
    Level2 = 2,
    Level3 = 3,
    Level4 = 4,
    Level5 = 5,
    Level6 = 6,
    Level7 = 7,
    Level8 = 8,
    Level9 = 9,
    Level10 = 10
}
export interface TieredCheck {
    result: CheckResult;
    matchLevel: MatchLevel;
}
export interface DocumentLivenessCheckSingleSideResult {
    screenCheck: TieredCheck;
    photocopyCheck: TieredCheck;
    handPresenceCheck: CheckResult;
}
export interface DocumentLivenessCheck {
    front: DocumentLivenessCheckSingleSideResult;
    back: DocumentLivenessCheckSingleSideResult;
}
/**
 * Determines which data is anonymized in the returned recognizer result
 */
export declare enum AnonymizationMode {
    /** No anonymization is performed in this mode. */
    None = 0,
    /**
     * Sensitive data in the document image is anonymized with black boxes covering selected sensitive data. Data
     * returned in result fields is not changed.
     */
    ImageOnly = 1,
    /** Document image is not changed. Data returned in result fields is redacted. */
    ResultFieldsOnly = 2,
    /**
     * Sensitive data in the image is anonymized with black boxes covering selected sensitive data. Data returned in
     * result fields is redacted.
     */
    FullResult = 3,
    /** Number of possible anonymization modes. */
    Count = 4
}
/**
 * Holds the settings which control card number anonymization.
 */
export declare class CardNumberAnonymizationSettings {
    /** Defines the mode of card number anonymization. */
    mode: AnonymizationMode;
    /** Defines how many digits at the beginning of the card number remain visible after anonymization. */
    prefixDigitsVisible: number;
    /** Defines how many digits at the end of the card number remain visible after anonymization. */
    suffixDigitsVisible: number;
}
export declare class AnonymizationSettings {
    /** Defines the parameters of card number anonymization. */
    cardNumberAnonymizationSettings: CardNumberAnonymizationSettings;
    /** Defines the mode of card number prefix anonymization. */
    cardNumberPrefixAnonymizationMode: AnonymizationMode;
    /** Defines the mode of CVV anonymization. */
    cvvAnonymizationMode: AnonymizationMode;
    /** Defines the mode of IBAN anonymization. */
    ibanAnonymizationMode: AnonymizationMode;
    /** Defines the mode of owner anonymization. */
    ownerAnonymizationMode: AnonymizationMode;
    /** If true, anonymization is applied on all fields of the image if extraction is uncertain. */
    fallbackAnonymization: boolean;
}
/**
 * A settings object that is used for configuring the BlinkCardRecognizer.
 */
export declare class BlinkCardRecognizerSettings implements FullDocumentImageOptions, RecognizerSettings {
    /**
     * Whether blured frames filtering is allowed
     */
    allowBlurFilter: boolean;
    /** Whether sensitive data should be redacted from the result */
    anonymizationSettings: AnonymizationSettings;
    /**
     * Padding is a minimum distance from the edge of the frame and is defined
     * as a percentage of the frame width. Default value is 0.0f and in that case
     * padding edge and image edge are the same.
     * If padding edge is needed, recommended value is 0.02f.
     */
    paddingEdge: number;
    /**
     * Whether invalid card number is accepted
     */
    allowInvalidCardNumber: boolean;
    /**
     * Whether to return CVV in recognizer results
     */
    extractCvv: boolean;
    /**
     * Whether to return expiry date in recognizer results
     */
    extractExpiryDate: boolean;
    /**
     * Whether to return IBAN in recognizer results
     */
    extractIban: boolean;
    /**
     * Whether to return owner in recognizer results
     */
    extractOwner: boolean;
    returnFullDocumentImage: boolean;
    returnEncodedFullDocumentImage: boolean;
    /**
     * Hand scale is calculated as a ratio between area of hand mask and document mask. `handScaleThreshold` is
     * the minimal value for hand to be accepted as significant.
     */
    handScaleThreshold: number;
    /**
     *  This parameter is used to adjust heuristics that eliminate cases when the hand is present in
        the input but it is not holding the document. `handDocumentOverlapThreshold` is the minimal ratio of hand
        pixels inside the frame surrounding the document and area of that frame. Only pixels inside that frame are
        used to ignore false-positive hand segmentations inside the document (e.g. profile photo on documents)
     */
    handDocumentOverlapThreshold: number;
    /**
     * Screen analysis match level - higher is stricter.
     */
    screenAnalysisMatchLevel: MatchLevel;
    /**
     * Photocopy analysis match level - higher is stricter.
     */
    photocopyAnalysisMatchLevel: MatchLevel;
    /**
     * Called when document verification status is available.
     */
    documentLivenessCallback: DocumentLivenessCallback | null;
    private _fullDocumentImageDpi;
    get fullDocumentImageDpi(): number;
    set fullDocumentImageDpi(value: number);
    fullDocumentImageExtensionFactors: ExtensionFactors;
}
/**
 * The result of image recognition when using the BlinkCardRecognizer.
 */
export interface BlinkCardRecognizerResult extends RecognizerResult {
    /**
     *  The payment card number.
     */
    readonly cardNumber: string;
    /**
     *  The payment card number prefix.
     */
    readonly cardNumberPrefix: string;
    /**
     *  The payment card number.
     */
    readonly cardNumberValid: boolean;
    /**
     *  Payment card's security code/value.
     */
    readonly cvv: string;
    /**
     *  The payment card's expiry date.
     */
    readonly expiryDate: MBDate;
    /**
     *  Wheater the first scanned side is blurred.
     */
    readonly firstSideBlurred: boolean;
    /**
     *  Full image of the payment card from first side recognition.
     */
    readonly firstSideFullDocumentImage: ImageResult;
    /**
     *  Payment card's IBAN.
     */
    readonly iban: string;
    /**
     *  Payment card's issuing network
     */
    readonly issuer: CardIssuer;
    /**
     *  Information about the payment card owner.
     */
    readonly owner: string;
    /**
     *  Status of the last recognition process.
     */
    readonly processingStatus: ProcessingStatus;
    /**
     *  Whether the scanning of the first side is finished.
     */
    readonly scanningFirstSideDone: boolean;
    /**
     *  Wheater the second scanned side is blurred.
     */
    readonly secondSideBlurred: boolean;
    /**
     *  Full image of the payment card from second side recognition.
     */
    readonly secondSideFullDocumentImage: ImageResult;
    /**
     * Is front side anonymized.
     */
    readonly firstSideAnonymized: boolean;
    /**
     * Is back side anonymized.
     */
    readonly secondSideAnonymized: boolean;
    /**
     * Document liveness check for both sides (screen, photocopy, hand presence);
     */
    readonly documentLivenessCheck: DocumentLivenessCheck;
}
/**
 * The Blink Card Recognizer is used for scanning Blink Card.
 */
export interface BlinkCardRecognizer extends Recognizer {
    /** Returns the currently applied BlinkCardRecognizerSettings. */
    currentSettings(): Promise<BlinkCardRecognizerSettings>;
    /** Applies new settings to the recognizer. */
    updateSettings(newSettings: BlinkCardRecognizerSettings): Promise<void>;
    /** Returns the current result of the recognition. */
    getResult(): Promise<BlinkCardRecognizerResult>;
}
/**
 * This function is used to create a new instance of `BlinkCardRecognizer`.
 * @param wasmSDK Instance of WasmSDK which will be used to communicate with the WebAssembly module.
 */
export declare function createBlinkCardRecognizer(wasmSDK: WasmSDK): Promise<BlinkCardRecognizer>;
/**
 * Payment Card Issuer defines supported issuing institutions that issued the card to the card holder.
 */
export declare enum CardIssuer {
    Other = 0,
    AmericanExpress = 1,
    ChinaUnionPay = 2,
    Diners = 3,
    DiscoverCard = 4,
    Elo = 5,
    Jcb = 6,
    Maestro = 7,
    Mastercard = 8,
    RuPay = 9,
    Verve = 10,
    Visa = 11,
    VPay = 12,
    Count = 13
}
/**
 * Detailed information about the recognition process.
 */
export declare enum ProcessingStatus {
    /** Recognition was successful. */
    Success = 0,
    /** Detection of the document failed. */
    DetectionFailed = 1,
    /** Preprocessing of the input image has failed. */
    ImagePreprocessingFailed = 2,
    /** Recognizer has inconsistent results. */
    StabilityTestFailed = 3,
    /** Wrong side of the document has been scanned. */
    ScanningWrongSide = 4,
    /** Identification of the fields present on the card has failed. */
    FieldIdentificationFailed = 5,
    /** Failed to return a requested image. */
    ImageReturnFailed = 6,
    /** Payment card currently not supported by the recognizer. */
    UnsupportedCard = 7,
    /** Number of possible processing statuses. */
    Count = 8
}