Interface Options

Options for FingerprintJS server API client

interface Options {
    apiKey: string;
    authenticationMode?: "AuthHeader" | "QueryParameter" | AuthenticationMode;
    fetch?: {
        (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
        (input: string | Request | URL, init?: RequestInit): Promise<Response>;
    };
    region?: "EU"
    | "AP"
    | "Global"
    | Region;
}

Properties

apiKey authenticationMode? fetch? region?

Properties

apiKey

apiKey: string

Secret API key

OptionalauthenticationMode

authenticationMode?: "AuthHeader" | "QueryParameter" | AuthenticationMode

Authentication mode Optional, default value is AuthHeader

Optionalfetch

fetch?: {
    (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
    (input: string | Request | URL, init?: RequestInit): Promise<Response>;
}

Optional fetch implementation

Type declaration

    • (input: RequestInfo | URL, init?: RequestInit): Promise<Response>

    • MDN Reference

      Parameters

      • input: RequestInfo | URL
      • Optionalinit: RequestInit

      Returns Promise<Response>

    • (input: string | Request | URL, init?: RequestInit): Promise<Response>

    • MDN Reference

      Parameters

      • input: string | Request | URL
      • Optionalinit: RequestInit

      Returns Promise<Response>

Optionalregion

region?: "EU" | "AP" | "Global" | Region

Region of the FingerprintJS service server

Settings

Member Visibility

On This Page

Properties