Interface StartOptions

Configuration options for start and FingerprintProvider.

Shared options live at the top level; platform-only options are grouped under android, ios, and web so an option cannot silently no-op on a platform that does not support it.

interface StartOptions {
    android?: AndroidStartOptions;
    apiKey: string;
    endpoints?: Endpoints;
    ios?: IosStartOptions;
    region?: Region;
    web?: WebStartOptions;
}

Hierarchy (view full)

Properties

android? apiKey endpoints? ios? region? web?

Properties

Optional android

android?: AndroidStartOptions

Android-only options.

apiKey

apiKey: string

Your public API key that authenticates the agent with the Fingerprint API.

Optional endpoints

endpoints?: Endpoints

API endpoint(s). Should only be used with a custom subdomain or proxy integration.

Optional ios

ios?: IosStartOptions

iOS-only options.

Optional region

region?: Region

Which region to use.

Optional web

web?: WebStartOptions

Web-only options.

Settings

Member Visibility

Theme

On This Page

androidapiKeyendpointsiosregionweb