User

Risk Scoring

Retrieve a user’s strike history and current enforcement action.

GET
/api/user/risk

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

  • Authorizationstringheaderrequired

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

Headers

  • whitecircle-versionstringrequired

    API Version

    Example: "2025-12-01"

Query Parameters

  • emailstring | null

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

  • idstring | null

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

    Example: "user-123"

Response

application/json

Success

  • strikesobject[]required

    Show child attributes
    • strikes.created_atinteger<int64>required

    • strikes.expires_atinteger<int64>required

    • strikes.internal_session_idstringrequired

    • strikes.pointsinteger<int32>required

    • strikes.policyobjectrequired

      Show child attributes
      • strikes.policy.idstringrequired

      • strikes.policy.namestringrequired

      • strikes.policy.severitystringrequired

    • strikes.reasonstringrequired

    • strikes.severitystringrequired

    • strikes.appealnull | object

      Show child attributes
      • strikes.appeal.statusstringrequired

      • strikes.appeal.timeinteger<int64>required

    • strikes.external_session_idstring | null

  • total_strike_pointsinteger<int32>required

  • actionstring | null

  • action_expires_atstring<date-time> | null