Skip to main content
GET
Use this endpoint to retrieve a user’s risk profile. Provide exactly one identifier: email or id. For setup details (severity, custom actions, metadata, webhooks, and appeals), see Strike System.

Authorizations

Authorization
string
header
required

API Key required. Format: Bearer wc-your-api-key

Headers

whitecircle-version
string
required

API Version

Query Parameters

email
string | null

User email address (provide exactly one of email, id, or ip)

id
string | null

External user ID (provide exactly one of email or id)

Response

Success

strikes
object[]
required
total_strike_points
integer<int32>
required
action
string | null
action_expires_at
string<date-time> | null