Skip to main content
POST
Create a grant token

Authorizations

Authorization
string
header
required

Your secret API key (bs_dev_… for development, bs_production_… for production), or a site key (pk_test_… / pk_live_…) when calling from an allowed origin. The Verified Accounts operations take the secret API key only and refuse site keys. Create keys in the Console under Settings → Developer Tools.

Body

application/json
partner_user_id
string

Your internal user identifier for correlation

metadata
object
notarize
boolean

Request a notarize ceremony ("Secure your account with BotShield") for this window. A request, not a decision: the gate's Console switch (Notarize account with BotShield) is the authority and is applied when the verification link is minted. Requires partner_user_id; without it the field is ignored and the response carries notarize_fallback_reason = notarize_requires_user_ref.

Response

Grant token created. NOTE: handler errors also arrive here (HTTP 200) as data.error — codes for this operation: 401 (bad or missing credential), 403 (origin not allowed for the site key).

data
object
required