@sheerid/jslib
    Preparing search index...

    Type Alias Options

    Configurable options that can be passed when initializing this library.

    type Options = {
        _launchDarklyFlagCb?: (flags: Flags) => void;
        _launchDarklyUserTargeting?: boolean;
        cookies?: CookieOptions;
        customCss?: ProgramTheme["customCss"];
        customFormFields?: CustomFormFieldConfig[];
        customMetadata?: MetadataConfig;
        doFetchTheme?: boolean;
        externalUserId?: string;
        formFieldConfig?: FormFieldConfig[];
        hideMilitaryFamilyAcceptableUploads?: boolean;
        hideTestModeFlag?: boolean;
        httpRequestTimeout?: number;
        installPageUrl?: string;
        locale?: Locale;
        logLevel?: LogLevel;
        logoUrl?: ProgramTheme["logoUrl"];
        marketConsent?: MarketConsentOptions;
        messages?: object;
        messagesWithLocale?: Partial<Record<Locale, object>>;
        minimumOrganizationSearchLength?: number;
        mockCaptchaError?: CaptchaError;
        mockConsumerInfoState?: ConsumerInfoState;
        mockDocSelected?: string;
        mockErrorDetailId?: ErrorDetailId;
        mockErrorId?: ErrorId;
        mockIdCheckLoopServiceType?: IdCheckLoopServiceType;
        mockPreviousStep?: VerificationStep;
        mockRedirectUrl?: string;
        mockResponse?: VerificationResponse;
        mockRewardCode?: string;
        mockSegment?: Segment;
        mockStep?: MockStep;
        mockSubSegment?: SubSegment;
        privacyPolicyUrl?: ProgramTheme["privacyPolicyUrl"];
        renderAs?: "default" | "landingPage";
        restApi?: RestApiOptions;
        tryAgainAction?: TryAgainAction;
        urlAddSchoolFaq?: string;
        urlAddSchoolForm?: string;
        urlAgeFaq?: string;
        urlEmploymentFaq?: string;
        urlFaq?: string;
        urlFirstResponderFaq?: string;
        urlIdentityFaq?: string;
        urlLicensedProfessionalFaq?: string;
        urlLowIncomeFaq?: string;
        urlMedicalFaq?: string;
        urlMemberFaq?: string;
        urlMilitaryFaq?: string;
        urlSeniorFaq?: string;
        urlStudentFaq?: string;
        urlTeacherFaq?: string;
        useFingerprinting?: boolean;
        verificationId?: string;
    }
    Index

    Properties

    _launchDarklyFlagCb? _launchDarklyUserTargeting? cookies? customCss? customFormFields? customMetadata? doFetchTheme? externalUserId? formFieldConfig? hideMilitaryFamilyAcceptableUploads? hideTestModeFlag? httpRequestTimeout? installPageUrl? locale? logLevel? logoUrl? marketConsent? messages? messagesWithLocale? minimumOrganizationSearchLength? mockCaptchaError? mockConsumerInfoState? mockDocSelected? mockErrorDetailId? mockErrorId? mockIdCheckLoopServiceType? mockPreviousStep? mockRedirectUrl? mockResponse? mockRewardCode? mockSegment? mockStep? mockSubSegment? privacyPolicyUrl? renderAs? restApi? tryAgainAction? urlAddSchoolFaq? urlAddSchoolForm? urlAgeFaq? urlEmploymentFaq? urlFaq? urlFirstResponderFaq? urlIdentityFaq? urlLicensedProfessionalFaq? urlLowIncomeFaq? urlMedicalFaq? urlMemberFaq? urlMilitaryFaq? urlSeniorFaq? urlStudentFaq? urlTeacherFaq? useFingerprinting? verificationId?

    Properties

    Optional_launchDarklyFlagCb

    _launchDarklyFlagCb?: (flags: Flags) => void

    Optional_launchDarklyUserTargeting

    _launchDarklyUserTargeting?: boolean
    cookies?: CookieOptions
    customCss?: ProgramTheme["customCss"]
    customFormFields?: CustomFormFieldConfig[]
    customMetadata?: MetadataConfig
    doFetchTheme?: boolean
    externalUserId?: string
    formFieldConfig?: FormFieldConfig[]
    hideMilitaryFamilyAcceptableUploads?: boolean
    hideTestModeFlag?: boolean
    httpRequestTimeout?: number
    installPageUrl?: string
    locale?: Locale
    logLevel?: LogLevel
    logoUrl?: ProgramTheme["logoUrl"]
    marketConsent?: MarketConsentOptions
    messages?: object
    messagesWithLocale?: Partial<Record<Locale, object>>
    minimumOrganizationSearchLength?: number
    mockCaptchaError?: CaptchaError
    mockConsumerInfoState?: ConsumerInfoState
    mockDocSelected?: string
    mockErrorDetailId?: ErrorDetailId
    mockErrorId?: ErrorId
    mockIdCheckLoopServiceType?: IdCheckLoopServiceType
    mockPreviousStep?: VerificationStep
    mockRedirectUrl?: string
    mockResponse?: VerificationResponse
    mockRewardCode?: string
    mockSegment?: Segment
    mockStep?: MockStep
    mockSubSegment?: SubSegment
    privacyPolicyUrl?: ProgramTheme["privacyPolicyUrl"]
    renderAs?: "default" | "landingPage"

    Supports backwards compatibility with consumers who render the a verification form directly on their page, preventing the landing page from rendering within their container. This option may be removed in v2.

    restApi?: RestApiOptions
    tryAgainAction?: TryAgainAction
    urlAddSchoolFaq?: string
    urlAddSchoolForm?: string
    urlAgeFaq?: string

    since version 1.63

    urlEmploymentFaq?: string

    since version 1.63

    urlFaq?: string
    urlFirstResponderFaq?: string

    since version 1.63

    urlIdentityFaq?: string

    since version 1.63

    urlLicensedProfessionalFaq?: string

    since version 1.63

    urlLowIncomeFaq?: string
    urlMedicalFaq?: string

    since version 1.63

    urlMemberFaq?: string

    since version 1.63

    urlMilitaryFaq?: string

    since version 1.63

    urlSeniorFaq?: string

    since version 1.63

    urlStudentFaq?: string

    since version 1.63

    urlTeacherFaq?: string

    since version 1.63

    useFingerprinting?: boolean
    verificationId?: string

    Settings

    Member Visibility

    On This Page

    Properties