Check the Development | Production toggle in the page header before you start. Keys and gates belong to one environment, and a gate’s environment is fixed when you place it. Start in Development: it is not billed and has no requirements. Production unlocks after four steps. See Go to production.
Create a site key
The widget authenticates with a site key. It is public, so it is locked to the origins you list.1
Open Site Keys
Go to Settings → Developer Tools and select the Site Keys tab. Select New Site Key.
2
Name the key and pick an environment
Enter a Name, for example “Production checkout”. Under Environment, choose test for Development gates or live for Production gates. A test key starts with
pk_test_ and a live key starts with pk_live_.3
Add allowed origins
Under Allowed Origins, add each origin that will host the widget, for example
https://www.meridianairlines.com. Origins are matched exactly. Use https://*.meridianairlines.com to allow every subdomain. On a live key, every origin must sit under a verified domain: the root itself or any subdomain of it.4
Create
Select Create Site Key. The key appears in the list with its origins. You can edit the origins or revoke the key later from the same list.
organization_id claim of every verification token, so keep it in your server configuration. See Keys and environments.
Place the gate
1
Open BotShield Gates
Select Verified Accounts in the sidebar and open the BotShield Gates tab. It lists your gates for the environment selected in the header. Select Place a gate.
2
Fill in the modal
Name the gate and pick a preset. Everything the preset fills can be changed later on the gate.
What they see previews the card the person reads in the BotShield app. A gate always asks: every pass is a new passkey confirmation on the person’s phone.
3
Confirm with your passkey (Production only)
In Production the modal shows a Passkey badge: “Placing a gate is confirmed with your passkey — only someone holding the passkey places a gate.” Select Place gate and confirm with your Developer passkey when prompted. In Development there is no passkey step.
4
Check the key
The gate opens in a detail panel as a Draft. Its key is shown under the name. If the key you asked for was already taken, BotShield adds a suffix such as
-2, so copy the key from this panel, not from memory.pk_test_ and bs_dev_ keys reach Development gates, pk_live_ and bs_production_ keys reach Production gates.
When it opens and closes
A gate’s When row, in its Configuration card, holds Opens and Closes, in your local time. Leave Opens empty to open as soon as the gate is active. Leave Closes empty to run until you close it. Select Save to keep the times. A person who arrives outside the window is refused withgate_not_open.
Gate states
The list shows each gate’s state:
To activate, open the Draft and select Activate in the header, or Activate → in the Next steps list.
How you end a gate depends on its state:
Production requirements
A Development gate activates with no checks. A Production gate activates only when your organization has finished the four steps of Go to production: a verified domain, business verification, a Developer passkey and a plan with room for the gate. Free covers your first production gate. If a step is missing, Activate fails with one of these codes, checked in this order, and the Console shows the message:
Placing a Production gate can also return the two passkey codes and the plan limit. Gates that are already Active keep running when a requirement changes later.
The embed snippet
The gate’s Deploy card shows the site key for the gate’s environment, a link to its allowed origins, and three steps, each with a Copy button: Put the tag on your page, Send the token to your server, and Confirm it on your server — required. The tag is ready to paste: it carries the site key, the gate key asscope, and scan-mode="modal", which names the widget’s QR code and mobile hand-off flow.
pk_live_… or pk_test_… as a placeholder, you have no site key in that environment yet. Create one first. The third step is not optional: without a server check, the widget’s success is only a claim made in the browser. See Verify on your server and Web component.
The gate detail panel
Select a gate in the BotShield Gates list to open its panel. A Draft shows only Overview. Active and Archived gates show three tabs.- Overview
- Verification Logs
- Activity Logs
- A date range (Last 7 days, Last 30 days, Last 90 days) and Export CSV for the summary.
- Metric tiles with the period’s totals and its Verified and Unavailable counts. An Age Gate shows Over N Verified and Age Unavailable as well.
- Configuration: preset, gate type, age threshold (Age Gate), When and Who may pass.
- Deploy: site key, allowed origins and the three deploy steps.
- Next steps: place, activate, then test in the Sandbox.
Next steps
Web component
Put the widget on your page.
Verify on your server
Check the result before you trust it.
Testing
Try the gate in the Console Sandbox.
Keys and environments
Site keys, API keys and how the two environments differ.
