Skip to main content
Version: v2

@friendlycaptcha/sdk > FriendlyCaptchaSDKOptions

FriendlyCaptchaSDKOptions interface

Options when creating a new SDK instance.

Signature:

export interface FriendlyCaptchaSDKOptions 

Properties

PropertyModifiersTypeDescription
apiEndpoint?string | "eu" | "global"

(Optional) The API endpoint to use, defaults to https://global.frcapi.com/api/v2/captcha.

Supports the following shortcuts: - eu - https://eu.frcapi.com/api/v2/captcha - global - https://global.frcapi.com/api/v2/captcha

startAgent?boolean(Optional) Start the background agent (and solver) immediately, defaults to true.