JavaScript agent

The JavaScript SDK loads the ShieldLabs browser agent and returns an Identification ID for each identification. Use that ID to read the result through the Server API or match a webhook.

import { load } from '@shieldlabs-ai/js';

const agent = await load({ publicKey: 'PUBLIC_API_KEY' });
const { requestId: identificationId } = await agent.identify();

Methods

Method	Returns	Purpose
`load(options)`	`Promise<ShieldLabsAgent>`	Load the agent and set defaults
`agent.identify(options?)`	`Promise<IdentifyResult>`	Start a fresh identification for a protected action
`agent.check(options?)`	`Promise<IdentifyResult \| null>`	Run a background check subject to the visit cooldown
`agent.identifyOnInteraction(target, options?)`	`InteractionIdentifier`	Start early and obtain the result when a form is submitted

The direct CDN snippet exposes callback-based methods. Framework SDKs wrap the same agent; see SDKs. Examples use @shieldlabs-ai/js version 1.0.1.

Installation and support

Start with JavaScript Quickstart for account creation, installation and your first result. For deployment requirements, see browser support and Content Security Policy. The package exports TypeScript definitions for LoadOptions, IdentifyOptions, IdentifyResult, ShieldLabsAgent, InteractionIdentifier and ShieldLabsErrorCode. Handle failures with ShieldLabsError.

Run a check

Get the result

Account

Contracts

Methods

Installation and support

​Methods

​Installation and support

Methods

Installation and support