Interface SheerIdJsApi

The interface exposed on the window object

interface SheerIdJsApi {
    VerificationForm: (new (element, programId) => void);
    conversion: Conversion;
    hooks: Hooks;
    overrideComponent: ((componentName, newComponent) => void);
    resetOverriddenComponents: (() => void);
    resetStore: (() => void);
    addHook(hook): RegisteredHooks;
    collectDeviceProfile(verificationId, programId): void;
    getMessages(locale, programThemeMessages?, segment?): Promise<StringMap>;
    getMetadata(): Metadata;
    postVerificationSizeUpdates(options): void;
    refreshStore(): void;
    resetMetadata(): void;
    resetOptions(): void;
    resetViewModel(): void;
    setMetadata(metadata): void;
    setOptions(options): void;
    setProgramTheme(theme): void;
    setViewModel(viewModel): void;
}

Properties

VerificationForm: (new (element, programId) => void)

Type declaration

    • new (element, programId): void
    • Parameters

      • element: HTMLElement
      • programId: string

      Returns void

conversion: Conversion
hooks: Hooks
overrideComponent: ((componentName, newComponent) => void)

Type declaration

resetOverriddenComponents: (() => void)

Type declaration

    • (): void
    • Returns void

resetStore: (() => void)

Type declaration

    • (): void
    • Returns void

Methods

  • Parameters

    • verificationId: string
    • programId: string

    Returns void

  • Parameters

    • locale: "ar" | "bg" | "bn-IN" | "cs" | "da" | "de" | "el" | "en-GB" | "en-US" | "es-ES" | "es" | "fi" | "fr-CA" | "fr" | "ga" | "hi-IN" | "hr" | "hu" | "id" | "is" | "it" | "iw" | "ja" | "ko" | "lo" | "lt" | "ms" | "nl" | "nl-BE" | "no" | "pl" | "pt-BR" | "pt" | "ro" | "ru" | "sk" | "sl" | "sr" | "sv" | "sw" | "uk" | "ur" | "vi" | "th" | "tr" | "zh-HK" | "zh" | "zu"
    • Optional programThemeMessages: ProgramThemeMessages
    • Optional segment: Segment

    Returns Promise<StringMap>

  • Parameters

    Returns void

  • Returns void

  • Returns void

  • Returns void

  • Returns void

  • Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    Returns void