> ## Documentation Index
> Fetch the complete documentation index at: https://docs.whitecircle.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Risk Scoring

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

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](/2026-04-15/first-steps/strike-system).


## OpenAPI

````yaml GET /api/user/risk
openapi: 3.1.0
info:
  title: WhiteCircle API Backend
  description: 'Authentication: Bearer API Key Required'
  license:
    name: ''
  version: '2025-12-01'
servers:
  - url: https://eu.whitecircle.com
  - url: https://us.whitecircle.com
security: []
tags:
  - name: Session
    description: Session-based content checking and moderation
  - name: User
    description: User risk assessment and scoring
  - name: Policy
    description: Policy management CRUD
  - name: Metric
    description: Metric management CRUD
  - name: Artifact
    description: Standalone artifact moderation
paths:
  /api/user/risk:
    get:
      tags:
        - User
      operationId: risk_v3
      parameters:
        - name: whitecircle-version
          in: header
          description: API Version
          required: true
          schema:
            type: string
          example: '2025-12-01'
        - name: email
          in: query
          description: User email address (provide exactly one of email, id, or ip)
          required: false
          schema:
            type:
              - string
              - 'null'
        - name: id
          in: query
          description: External user ID (provide exactly one of email or id)
          required: false
          schema:
            type:
              - string
              - 'null'
          example: user-123
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserRiskResponse'
              example:
                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':
          description: Bad Request
      security:
        - bearerAuth: []
      x-codeSamples:
        - lang: cURL
          label: cURL (email)
          source: |-
            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'
        - lang: cURL
          label: cURL (id)
          source: |-
            curl --request GET \
              --url 'https://eu.whitecircle.com/api/user/risk?id=user-123' \
              --header 'Authorization: Bearer <token>' \
              --header 'whitecircle-version: 2025-12-01'
components:
  schemas:
    UserRiskResponse:
      type: object
      required:
        - total_strike_points
        - strikes
      properties:
        action:
          type:
            - string
            - 'null'
        action_expires_at:
          type:
            - string
            - 'null'
          format: date-time
        strikes:
          type: array
          items:
            $ref: '#/components/schemas/PublicStrikeItem'
        total_strike_points:
          type: integer
          format: int32
      example:
        action: null
        action_expires_at: null
        strikes: []
        total_strike_points: 0
    PublicStrikeItem:
      type: object
      required:
        - severity
        - points
        - created_at
        - expires_at
        - reason
        - internal_session_id
        - policy
      properties:
        appeal:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/PublicStrikeAppeal'
        created_at:
          type: integer
          format: int64
        expires_at:
          type: integer
          format: int64
        external_session_id:
          type:
            - string
            - 'null'
        internal_session_id:
          type: string
        points:
          type: integer
          format: int32
        policy:
          $ref: '#/components/schemas/PublicStrikePolicy'
        reason:
          type: string
        severity:
          type: string
    PublicStrikeAppeal:
      type: object
      required:
        - time
        - status
      properties:
        status:
          type: string
        time:
          type: integer
          format: int64
    PublicStrikePolicy:
      type: object
      required:
        - id
        - name
        - severity
      properties:
        id:
          type: string
        name:
          type: string
        severity:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: 'API Key required. Format: Bearer wc-your-api-key'

````