Skip to main content

Client SDK Embed

The BotShield Client SDK is a lightweight web component (<botshield-verify>) that merchants embed directly on their pages to gate checkout, cart, and other sensitive flows behind human presence verification. CDN: https://cdn.botshield.ai/sdk.js (~9KB minified)
The Client SDK requires a site key (pk_live_...), which you create in the BotShield Partner Dashboard under Settings > Site Keys.

Two Integration Modes

Web Component

Active human verification via BotShield passkey flow. User clicks the widget, completes a passkey challenge, and receives a signed verification token.

Signal Pixel

Passive signal collection. Enable signals="true" on the web component to run edge scoring and behavioral fingerprinting silently. Low-risk traffic passes automatically; high-risk is escalated.

How It Works

Web Component Flow

Signal Pixel Flow

Quick Start

When to Use Which Mode

Site Keys

Site keys are public/secret key pairs created in the Partner Dashboard:
  • pk_test_ / sk_test_ for sandbox environments
  • pk_live_ / sk_live_ for production
  • Public keys are domain-locked at creation (stolen keys are unusable on other domains)
Create and manage site keys at Settings > Site Keys in the Partner Dashboard.

Next Steps

Web Component Reference

Full attribute API, events, states, and integration examples

Signal Pixel Reference

Bot scoring details, signal collection, and configuration

Try in Playground

Test both modes live in the Partner Dashboard playground

Source Code

View the SDK source on GitHub