Skip to main content
GET
Get Secured Account status

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.

Query Parameters

platform_user_ref
string
required

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. Must be a stable id, not an email address.

Required string length: 1 - 512

Response

Current state. NOTE: handler errors also arrive here (HTTP 200) as data.error — codes: api_key_required / invalid_api_key (401), partner_not_found (403), presence_requires_user_ref / notarize_ref_must_be_stable (400), presence_unavailable (503, retry).

data
object
required