# Risk Scoring

> Retrieve a user's strike history and current enforcement action.

`GET /api/user/risk`

Base URLs: `https://eu.whitecircle.com`, `https://us.whitecircle.com`

OpenAPI: [2026-04-15/openapi.json](https://whitecircle.com/docs/2026-04-15/openapi.json)

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](https://whitecircle.com/docs/2026-04-15/first-steps/strike-system.md).

## Authorizations

- `Authorization` (`string`, header, required): API Key required. Format: Bearer wc-your-api-key.

## Headers

- `whitecircle-version` (`string`, required): API Version. Example: `"2026-04-15"`.

## Query Parameters

- `email` (`string | null`, optional): User email address (provide exactly one of email, id, or ip).
- `id` (`string | null`, optional): External user ID (provide exactly one of email or id). Example: `"user-123"`.

## Request example

**cURL (email)**

```bash
curl --request GET \
  --url 'https://eu.whitecircle.com/api/user/risk?email=user%40example.com' \
  --header 'Authorization: Bearer <token>' \
  --header 'whitecircle-version: 2025-12-01'
```

**cURL (id)**

```bash
curl --request GET \
  --url 'https://eu.whitecircle.com/api/user/risk?id=user-123' \
  --header 'Authorization: Bearer <token>' \
  --header 'whitecircle-version: 2025-12-01'
```

## Response

### 200

Success

`application/json`

- `strikes` (`object[]`, required)
- `strikes.created_at` (`integer<int64>`, required)
- `strikes.expires_at` (`integer<int64>`, required)
- `strikes.internal_session_id` (`string`, required)
- `strikes.points` (`integer<int32>`, required)
- `strikes.policy` (`object`, required)
- `strikes.policy.id` (`string`, required)
- `strikes.policy.name` (`string`, required)
- `strikes.policy.severity` (`string`, required)
- `strikes.reason` (`string`, required)
- `strikes.severity` (`string`, required)
- `strikes.appeal` (`null | object`, optional)
- `strikes.appeal.status` (`string`, required)
- `strikes.appeal.time` (`integer<int64>`, required)
- `strikes.external_session_id` (`string | null`, optional)
- `total_strike_points` (`integer<int32>`, required)
- `action` (`string | null`, optional)
- `action_expires_at` (`string<date-time> | null`, optional)

**Example**

```json
{
  "action": "warn",
  "action_expires_at": "2026-04-05T10:00:00Z",
  "strikes": [
    {
      "points": 10,
      "created_at": 1770612473,
      "expires_at": 1771217273,
      "reason": "session.flagged",
      "internal_session_id": "5f8a31d6-4b2f-4e61-88d5-cc537e4af79e",
      "external_session_id": "session-456",
      "appeal": {
        "time": 1770612573,
        "status": "appeal.in_review"
      },
      "policy": {
        "id": "8d3d8fad-0df7-443f-a6df-5445e48a8eaf",
        "name": "Adult Content",
        "severity": "high"
      }
    }
  ],
  "total_strike_points": 10
}
```

### 400

Bad Request
