# Type Alias Options

#### Description

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;
}

- Defined in jslib/src/lib/types/types.ts:134

##### 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

- Defined in jslib/src/lib/types/types.ts:233

### `Optional`_launchDarklyUserTargeting

_launchDarklyUserTargeting?: boolean

- Defined in jslib/src/lib/types/types.ts:231

### `Optional` cookies

cookies?: CookieOptions

- Defined in jslib/src/lib/types/types.ts:209

### `Optional` customCss

customCss?: ProgramTheme["customCss"]

- Defined in jslib/src/lib/types/types.ts:205

### `Optional` customFormFields

customFormFields?: CustomFormFieldConfig[]

- Defined in jslib/src/lib/types/types.ts:226

### `Optional` customMetadata

customMetadata?: MetadataConfig

- Defined in jslib/src/lib/types/types.ts:212

### `Optional` doFetchTheme

doFetchTheme?: boolean

- Defined in jslib/src/lib/types/types.ts:153

### `Optional` externalUserId

externalUserId?: string

- Defined in jslib/src/lib/types/types.ts:214

### `Optional` formFieldConfig

formFieldConfig?: FormFieldConfig[]

- Defined in jslib/src/lib/types/types.ts:227

### `Optional` hideMilitaryFamilyAcceptableUploads

hideMilitaryFamilyAcceptableUploads?: boolean

#### Deprecated

- Defined in jslib/src/lib/types/types.ts:224

### `Optional` hideTestModeFlag

hideTestModeFlag?: boolean

- Defined in jslib/src/lib/types/types.ts:219

### `Optional` httpRequestTimeout

httpRequestTimeout?: number

- Defined in jslib/src/lib/types/types.ts:217

### `Optional` installPageUrl

installPageUrl?: string

- Defined in jslib/src/lib/types/types.ts:149

### `Optional` locale

locale?: Locale

- Defined in jslib/src/lib/types/types.ts:154

### `Optional` logLevel

logLevel?: LogLevel

- Defined in jslib/src/lib/types/types.ts:136

### `Optional` logoUrl

logoUrl?: ProgramTheme["logoUrl"]

- Defined in jslib/src/lib/types/types.ts:206

### `Optional` marketConsent

marketConsent?: MarketConsentOptions

- Defined in jslib/src/lib/types/types.ts:211

### `Optional` messages

messages?: object

- Defined in jslib/src/lib/types/types.ts:155

### `Optional` messagesWithLocale

messagesWithLocale?: Partial<Record<Locale, object>>

- Defined in jslib/src/lib/types/types.ts:156

### `Optional` minimumOrganizationSearchLength

minimumOrganizationSearchLength?: number

- Defined in jslib/src/lib/types/types.ts:215

### `Optional` mockCaptchaError

mockCaptchaError?: CaptchaError

- Defined in jslib/src/lib/types/types.ts:142

### `Optional` mockConsumerInfoState

mockConsumerInfoState?: ConsumerInfoState

- Defined in jslib/src/lib/types/types.ts:145

### `Optional` mockDocSelected

mockDocSelected?: string

- Defined in jslib/src/lib/types/types.ts:148

### `Optional` mockErrorDetailId

mockErrorDetailId?: ErrorDetailId

- Defined in jslib/src/lib/types/types.ts:141

### `Optional` mockErrorId

mockErrorId?: ErrorId

- Defined in jslib/src/lib/types/types.ts:140

### `Optional` mockIdCheckLoopServiceType

mockIdCheckLoopServiceType?: IdCheckLoopServiceType

- Defined in jslib/src/lib/types/types.ts:146

### `Optional` mockPreviousStep

mockPreviousStep?: VerificationStep

- Defined in jslib/src/lib/types/types.ts:147

### `Optional` mockRedirectUrl

mockRedirectUrl?: string

- Defined in jslib/src/lib/types/types.ts:144

### `Optional` mockResponse

mockResponse?: VerificationResponse

- Defined in jslib/src/lib/types/types.ts:150

### `Optional` mockRewardCode

mockRewardCode?: string

- Defined in jslib/src/lib/types/types.ts:143

### `Optional` mockSegment

mockSegment?: Segment

- Defined in jslib/src/lib/types/types.ts:138

### `Optional` mockStep

mockStep?: MockStep

- Defined in jslib/src/lib/types/types.ts:137

### `Optional` mockSubSegment

mockSubSegment?: SubSegment

- Defined in jslib/src/lib/types/types.ts:139

### `Optional` privacyPolicyUrl

privacyPolicyUrl?: ProgramTheme["privacyPolicyUrl"]

- Defined in jslib/src/lib/types/types.ts:207

### `Optional` renderAs

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.

- Defined in jslib/src/lib/types/types.ts:239

### `Optional` restApi

restApi?: RestApiOptions

- Defined in jslib/src/lib/types/types.ts:135

### `Optional` tryAgainAction

tryAgainAction?: TryAgainAction

- Defined in jslib/src/lib/types/types.ts:228

### `Optional` urlAddSchoolFaq

urlAddSchoolFaq?: string

- Defined in jslib/src/lib/types/types.ts:203

### `Optional` urlAddSchoolForm

urlAddSchoolForm?: string

- Defined in jslib/src/lib/types/types.ts:204

### `Optional` urlAgeFaq

urlAgeFaq?: string

#### Deprecated

since version 1.63

- Defined in jslib/src/lib/types/types.ts:169

### `Optional` urlEmploymentFaq

urlEmploymentFaq?: string

#### Deprecated

since version 1.63

- Defined in jslib/src/lib/types/types.ts:193

### `Optional` urlFaq

urlFaq?: string

- Defined in jslib/src/lib/types/types.ts:157

### `Optional` urlFirstResponderFaq

urlFirstResponderFaq?: string

#### Deprecated

since version 1.63

- Defined in jslib/src/lib/types/types.ts:185

### `Optional` urlIdentityFaq

urlIdentityFaq?: string

#### Deprecated

since version 1.63

- Defined in jslib/src/lib/types/types.ts:197

### `Optional` urlLicensedProfessionalFaq

urlLicensedProfessionalFaq?: string

#### Deprecated

since version 1.63

- Defined in jslib/src/lib/types/types.ts:201

### `Optional` urlLowIncomeFaq

urlLowIncomeFaq?: string

- Defined in jslib/src/lib/types/types.ts:202

### `Optional` urlMedicalFaq

urlMedicalFaq?: string

#### Deprecated

since version 1.63

- Defined in jslib/src/lib/types/types.ts:189

### `Optional` urlMemberFaq

urlMemberFaq?: string

#### Deprecated

since version 1.63

- Defined in jslib/src/lib/types/types.ts:181

### `Optional` urlMilitaryFaq

urlMilitaryFaq?: string

#### Deprecated

since version 1.63

- Defined in jslib/src/lib/types/types.ts:173

### `Optional` urlSeniorFaq

urlSeniorFaq?: string

#### Deprecated

since version 1.63

- Defined in jslib/src/lib/types/types.ts:165

### `Optional` urlStudentFaq

urlStudentFaq?: string

#### Deprecated

since version 1.63

- Defined in jslib/src/lib/types/types.ts:161

### `Optional` urlTeacherFaq

urlTeacherFaq?: string

#### Deprecated

since version 1.63

- Defined in jslib/src/lib/types/types.ts:177

### `Optional` useFingerprinting

useFingerprinting?: boolean

- Defined in jslib/src/lib/types/types.ts:210

### `Optional` verificationId

verificationId?: string

- Defined in jslib/src/lib/types/types.ts:213