Skip to main content

Quick Start

Choose the integration that fits your platform:

Client SDK Embed

Drop a script tag on your page. No backend required.

Server SDK

Full control via REST API or TypeScript SDK.

Prerequisites

  • A BotShield Partner account (request access)
  • Your site key (pk_live_...) from Settings > Site Keys
  • Your API key (bs_prod_...) from Settings > API & Credentials

Option A: Client SDK Embed

The fastest path. Add a single script tag and the <botshield-verify> web component handles everything.

1. Add the Script Tag

2. Add the Widget

Place the widget before your checkout or submit button:

3. Handle the Result

The widget’s onsuccess token is the PII-free verification_token. Validate it on your server to confirm the signature before you act on it:
Census returns one of three result states — Human Verified, MultiPass Active, or Human Unavailable. The widget renders these for you; a verified token (verified: true) corresponds to a Human Verified or MultiPass Active result. See Human Presence for the full model.
The Client SDK also supports a Signal Pixel mode for passive bot scoring without user interaction. Add signals="true" to the web component. See the Signal Pixel reference for details.
Full reference: Client SDK Embed docs

Option B: Server SDK

For platforms that need full backend control over the verification flow.

1. Install the SDK

2. Create a Session

4. Receive the Result

Via webhook (recommended). Anonymous by construction — no identity, signed with Svix:
Via polling:

5. Verify the Webhook

The webhook’s authenticity is the Svix signature over the payload — there’s no identity in the body and no token to decode. Verify with the svix library and your endpoint’s signing secret (from Console → Settings → Webhooks), then act on type + request_id:
Full walkthrough (idempotency, retries, all event types): Webhooks — Payloads & Verification. Full reference: Server SDK docs | API Reference

What Happens During Verification

Regardless of which option you choose, the user experience is:
  1. BotShield presents a verification prompt
  2. The user authenticates with their device (Face ID, Touch ID, or device passcode)
  3. A signed, one-time-use token is generated
  4. The token is returned to your platform
No personal data is collected. BotShield verifies presence, not identity.

Next Steps

SDK Overview

Understand the full architecture and capabilities

Partner Dashboard

Test verification flows in the Playground

How It Works

Learn about Human Presence Signals

Get Access

Request developer credentials