Skip to main content
POST
Revoke a Secured Account

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. Create keys in the Console under Settings → Developer Tools.

Body

application/json
platform_user_ref
string

Your stable user id for the account (the same platform_user_ref you passed when it was secured). Hashed server-side; never stored or returned. Send this OR handle.

Maximum string length: 512
handle
string

The Secured Account handle — your per-platform reference for the person, the same value carried on account.secured / account.unlinked. Send this OR platform_user_ref.

Pattern: ^OP_[A-Za-z0-9]{12}$
reason
enum<string>

Default platform.

Available options:
platform,
credential_changed

Response

Result. NOTE: handler errors also arrive here (HTTP 200) as data.error — codes: api_key_required / invalid_api_key (401), partner_not_found (403), ref_or_handle_required / invalid_platform_user_ref / invalid_handle / invalid_reason (400), revoke_failed (500).

data
object
required