Skip to main content

Interface: SlashIDOptions

Types.SlashIDOptions

This class simply holds connection options for your SlashID organization, to be passed to the SlashID constructor.

Example

You can customize your SlashID connection options when creating an instance:

const sid = SlashID({
    baseURL: "https://api.sandbox.slashid.com/auth", // To use the sandbox environment
    sdkURL: "https://your.custom.sdk.domain/path.html" // SDK location for custom WebAuthn scope
})

Remarks

Specifying options for SlashID is optional and only required in two cases:

  • if your Organization has custom WebAuthn scopes: use your SlashID-provided sdkURL value;
  • you are experimenting and want to connect to the Sandbox environment:

Properties​

analyticsEnabled​

• Optional analyticsEnabled: boolean

Whether to enable analytics or not.

Default

false

baseURL​

• Optional baseURL: string

The base SlashID API endpoint.

oid​

• Optional oid: string

Your Organization ID provided by SlashID

sdkURL​

• Optional sdkURL: string

The location where your organization's custom SDK is served.