@alloyidentity/web-sdk/dist/services/embedBC.d.ts

Alloy Web Document SDK

export interface BioCatchScoringUpdatePayload {
    solution: 'AO';
    customer_session_id: string;
    application_id: string;
    brand: string;
    activity_type: string;
    uuid?: string;
    year_of_birth?: string;
    product?: string;
    session_type?: string;
    web_journey?: string;
    user_agent?: string;
    ip?: string;
}
export interface BioCatchScoringUpdateResponse {
    bc_status: 'updated';
}
export declare const getSessionIdValidationError: (sessionId: string) => string | null;
/**
 * Create a unique Customer Session ID
 *
 * Create a unique string between 10 and 100 characters
 * containing A-Za-z0-9,!@$%^&*.=+-_/\~
 *
 * @see {@link https://DOCS/docs/js-mandatory-functions#setcustomersessionid}
 */
export declare const createUniqueBCSessionId: (minLength?: number, maxLength?: number) => string;
/**
 * Configuration options for embedding the BC SDK
 */
export interface BCEmbedOptions {
    customerSessionId: string;
    context: string;
    brand: string;
    jsUrl: string;
    cid?: string;
    wupUrl?: string;
    runtimePlatform: 'web' | 'hybrid';
}
/**
 * result of embedding the BC SDK is the cdApi
 */
export interface BCEmbedResult {
    cdApi: typeof window.cdApi;
    bcClient: typeof window.bcClient;
}
/**
 * Load the bc js frontend, and call the mandatory functions
 *
 * This will return the bc cdApi object (though it should also
 * be available at window.cdApi)
 *
 * @see {@link https://DOCS/docs/js-mandatory-functions}
 */
declare const _default: (options: BCEmbedOptions, accessToken: string) => Promise<BCEmbedResult>;
export default _default;
export declare const removeBioCatch: () => void;