Skip to main content
GET
Read the gating status for the signed-in user

Headers

X-Portal-Bootstrap-Signature
string
required

Hex HMAC-SHA256 of the raw request body (or, for the GET status endpoint, of the X-Portal-Workos-User-Id header value) computed with the shared portal bootstrap secret.

X-Portal-Workos-User-Id
string
required

WorkOS user id whose gating status is being read.

Response

Latest sandbox and live status.

sandbox_status
enum<string> | null
Available options:
PENDING,
APPROVED,
DENIED,
NEEDS_INFO
live_status
enum<string> | null
Available options:
PENDING,
APPROVED,
DENIED,
NEEDS_INFO
sandbox_denial_reason_code_public
string | null
live_denial_reason_code_public
string | null