Skip to main content
POST
Revoke a pending verification

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

One of gate (canonical) or scope (deprecated alias) is required.

scope
string
deprecated

The gate's action name. Deprecated (alias window, sunset 2027-01-15): use gate. Accepted through the window; responses carry both. https://docs.botshield.ai/changelog/alias-window

user_email
string<email>
deprecated

Deprecated. Accepted and ignored — it is not stored.

partner_user_id
string
gate
string

The gate's action name.

Response

Revocation result. NOTE: handler errors also arrive here (HTTP 200) as data.error — codes for this operation: 401.

data
object
required