Skip to main content
POST
Confirm a link that waits for your server

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
request_id
string
required

The request the person tapped (req_…), from account.link_pending, botshield:success or your own create call.

partner_user_ref
string

The account your own signed-in session shows: the same user ref the link was started with. Hashed, never stored in the clear.

partner_user_id
string

Alias of partner_user_ref.

Response

200 - application/json

Result. Errors arrive here (HTTP 200) as data.error with code, message and statusCode: secret_key_required (401), invalid_key (401), account_required (400), link_not_found (404 — no waiting link with this id for your organization), environment_mismatch (403), link_account_mismatch (403 — nothing linked, the waiting link is dropped), link_expired (410), link_refused (409), rebind_requires_prior_id (409), already_trusted (409; reason_name: account_limit_reached when your account limit refused it), unavailable (503 — retry).

data
object