CDN snippet methods

The CDN snippet exposes four methods for sites that do not use the npm SDK. Each returns void and accepts an optional initialization callback.

const agent = await import(
  'https://cdn.shieldlabs.ai/snippet.js?publicKey=PUBLIC_API_KEY'
);

agent.forceCheckAnonymous({
  onInitialized(result) {
    if (result.status === 'initialized') {
      const { requestID: identificationId } = result;
      console.log(identificationId);
    }
  },
});

For installation and the JavaScript-disabled beacon, see Install the JS Snippet.

Methods

Signature	User context	Cooldown
`checkAnonymous(options?)`	Anonymous	Five-minute same-user visit window
`checkAuthenticatedUser(userHID, options?)`	Supplied account	Five-minute same-user visit window
`forceCheckAnonymous(options?)`	Anonymous	Starts immediately
`forceCheckAuthenticatedUser(userHID, options?)`	Supplied account	Starts immediately

Use a force method when your application requires a fresh Identification ID for a protected action. A regular call inside the cooldown posts no identification.

Arguments

string

Required for authenticated methods. A stable hashed or pseudonymous account identifier computed on your server. See User HID.

function

Called once with initialization status. Pass it inside an options object; a bare callback function is not supported.

Callback result

type InitializationResult =
  | { status: 'initialized'; requestID: string }
  | { status: 'not_initialized' };

The initialized branch supplies the Identification ID for server-side correlation. The other branch has no Identification ID and includes skipped checks. Module import failures must be handled separately with try/catch.

SDK method mapping

npm SDK	CDN snippet
`identify()` without `userId`	`forceCheckAnonymous()`
`identify({ userId })`	`forceCheckAuthenticatedUser(userId)`
`check()` without `userId`	`checkAnonymous()`
`check({ userId })`	`checkAuthenticatedUser(userId)`

The SDK wraps initialization in a promise, adds timeouts and validation, and exposes the Identification ID as requestId.

Run a check

Get the result

Account

Contracts

Methods

Arguments

Callback result

SDK method mapping

​Methods

​Arguments

​Callback result

​SDK method mapping

Methods

Arguments

Callback result

SDK method mapping