Type alias Options

Options: {
    _launchDarklyFlagCb?: ((flags) => void);
    _launchDarklyUserTargeting?: boolean;
    cookies?: CookieOptions;
    customCss?: ProgramTheme["customCss"];
    customFormFields?: CustomFormFieldConfig[];
    customMetadata?: MetadataConfig;
    doFetchTheme?: boolean;
    formFieldConfig?: FormFieldConfig[];
    hideMilitaryFamilyAcceptableUploads?: boolean;
    hideTestModeFlag?: boolean;
    httpRequestTimeout?: number;
    installPageUrl?: string;
    locale?: Locale;
    logLevel?: LogLevel;
    logoUrl?: ProgramTheme["logoUrl"];
    marketConsent?: MarketConsentOptions;
    messages?: object;
    messagesWithLocale?: object;
    minimumOrganizationSearchLength?: number;
    mockConsumerInfoState?: ConsumerInfoState;
    mockDocSelected?: string;
    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;
}

Type declaration

  • Optional _launchDarklyFlagCb?: ((flags) => void)
      • (flags): void
      • Parameters

        • flags: Flags

        Returns void

  • Optional _launchDarklyUserTargeting?: boolean
  • Optional cookies?: CookieOptions
  • Optional customCss?: ProgramTheme["customCss"]
  • Optional customFormFields?: CustomFormFieldConfig[]
  • Optional customMetadata?: MetadataConfig
  • Optional doFetchTheme?: boolean
  • Optional formFieldConfig?: FormFieldConfig[]
  • Optional hideMilitaryFamilyAcceptableUploads?: boolean

    Deprecated

  • Optional hideTestModeFlag?: boolean
  • Optional httpRequestTimeout?: number
  • Optional installPageUrl?: string
  • Optional locale?: Locale
  • Optional logLevel?: LogLevel
  • Optional logoUrl?: ProgramTheme["logoUrl"]
  • Optional marketConsent?: MarketConsentOptions
  • Optional messages?: object
  • Optional messagesWithLocale?: object
  • Optional minimumOrganizationSearchLength?: number
  • Optional mockConsumerInfoState?: ConsumerInfoState
  • Optional mockDocSelected?: string
  • Optional mockErrorId?: ErrorId
  • Optional mockIdCheckLoopServiceType?: IdCheckLoopServiceType
  • Optional mockPreviousStep?: VerificationStep
  • Optional mockRedirectUrl?: string
  • Optional mockResponse?: VerificationResponse
  • Optional mockRewardCode?: string
  • Optional mockSegment?: Segment
  • Optional mockStep?: MockStep
  • Optional mockSubSegment?: SubSegment
  • Optional privacyPolicyUrl?: ProgramTheme["privacyPolicyUrl"]
  • Optional 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.

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

    Deprecated

    since version 1.63

  • Optional urlEmploymentFaq?: string

    Deprecated

    since version 1.63

  • Optional urlFaq?: string
  • Optional urlFirstResponderFaq?: string

    Deprecated

    since version 1.63

  • Optional urlIdentityFaq?: string

    Deprecated

    since version 1.63

  • Optional urlLicensedProfessionalFaq?: string

    Deprecated

    since version 1.63

  • Optional urlLowIncomeFaq?: string
  • Optional urlMedicalFaq?: string

    Deprecated

    since version 1.63

  • Optional urlMemberFaq?: string

    Deprecated

    since version 1.63

  • Optional urlMilitaryFaq?: string

    Deprecated

    since version 1.63

  • Optional urlSeniorFaq?: string

    Deprecated

    since version 1.63

  • Optional urlStudentFaq?: string

    Deprecated

    since version 1.63

  • Optional urlTeacherFaq?: string

    Deprecated

    since version 1.63

  • Optional useFingerprinting?: boolean
  • Optional verificationId?: string

Description

Configurable options that can be passed when initializing this library.