> ## 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.

# Get Session by ID

Retrieve the results of a previously submitted content check request.

## Required Parameters

| Parameter       | Description                                                 |
| --------------- | ----------------------------------------------------------- |
| `deployment_id` | Specific deployment ID used for the check. See Deployments. |


## OpenAPI

````yaml GET /api/protect/get_by_id
openapi: 3.1.0
info:
  title: WhiteCircle API Backend
  version: '2025-06-15'
servers:
  - url: https://eu.whitecircle.com
  - url: https://us.whitecircle.com
security: []
tags:
  - name: Protect
    description: Content protection and policy checking
  - name: Radar
    description: Risk assessment and user scoring
paths:
  /api/protect/get_by_id:
    get:
      tags:
        - Protect
      operationId: get_by_id_v2
      parameters:
        - name: whitecircle-version
          in: header
          description: API Version
          required: true
          schema:
            type: string
          example: '2025-06-15'
        - name: deployment_id
          in: query
          description: Specific deployment ID used for the check. See Deployments.
          required: true
          schema:
            type: string
        - name: include_policy_names
          in: query
          description: >-
            Whether to include human-readable policy names in the response
            (default: false)
          required: false
          schema:
            type:
              - boolean
              - 'null'
        - name: external_id
          in: query
          description: Find check results by external ID (your tracking identifier)
          required: false
          schema:
            type:
              - string
              - 'null'
        - name: internal_id
          in: query
          description: Find check results by internal ID (system-generated UUID)
          required: false
          schema:
            type:
              - string
              - 'null'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetByIdResponseV2'
        '400':
          description: Bad Request
      security:
        - bearerAuth: []
components:
  schemas:
    GetByIdResponseV2:
      type: object
      required:
        - list
      properties:
        list:
          type: array
          items:
            $ref: '#/components/schemas/CheckResponseV2'
          description: List of check results matching the query
      example:
        list:
          - external_id: user-session-001
            internal_id: 123e4567-e89b-12d3-a456-426614174000
            violation: true
            violations:
              70289e06-9111-463e-b121-7247c2b7bfbd:
                name: No PII Sharing
                violation: true
              a4a91875-1e54-42d7-b9b0-a75dfebeb057:
                name: Drugs
                violation: false
    CheckResponseV2:
      type: object
      required:
        - violation
        - internal_id
        - violations
      properties:
        external_id:
          type:
            - string
            - 'null'
          description: Optional external identifier provided by client
        internal_id:
          type: string
          description: Unique internal identifier for this check
        violation:
          type: boolean
          description: Whether any policy violations were detected
        violations:
          type: object
          description: >-
            Map of policy IDs to policy status objects containing violation and
            optional name
          additionalProperties:
            $ref: '#/components/schemas/PolicyStatusV2'
          propertyNames:
            type: string
      example:
        external_id: user-session-001
        internal_id: 123e4567-e89b-12d3-a456-426614174000
        violation: true
        violations:
          123e4567-e89b-12d3-a456-426614174000:
            name: NSFW
            violation: true
            violation_source:
              - image
          70289e06-9111-463e-b121-7247c2b7bfbd:
            name: No PII Sharing
            violation: false
            violation_source: []
          a4a91875-1e54-42d7-b9b0-a75dfebeb057:
            name: Drugs
            violation: true
            violation_source:
              - text
    PolicyStatusV2:
      type: object
      required:
        - violation
        - violation_source
      properties:
        name:
          type:
            - string
            - 'null'
          description: >-
            Human-readable policy name (only present if
            include_policy_names=true)
        violation:
          type: boolean
          description: Whether a violation was detected for this policy
        violation_source:
          type: array
          items:
            $ref: '#/components/schemas/ViolationSource'
          description: >-
            Sources where violations were detected (includes only triggered
            violations)
      example:
        name: No PII Sharing
        violation: true
        violation_source:
          - text
    ViolationSource:
      type: string
      enum:
        - text
        - image
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: 'API Key required. Format: Bearer wc-your-api-key'

````