Sessions

Get Results by ID

GET
/api/session/get_by_id

Retrieve the results of a previously submitted content check request. Use this endpoint to look up policy check results using either your own tracking identifier or the system-generated ID.

Query Parameters

ParameterRequiredDescription
internal_session_id✓*The system-generated UUID returned in the content check response. This is always available, even if you didn’t provide an external session ID.
external_session_id✓*Your custom tracking identifier that you passed when checking content. Use this if you want to track sessions with your own IDs.
deployment_idOverride deployment resolved from API key. Defaults to the deployment associated with your API key.

*Exactly one of internal_session_id or external_session_id is required.

Example Requests

Using your external session ID:

cURL

curl -X GET "https://eu.whitecircle.com/api/session/get_by_id?deployment_id=your-deployment-id&external_session_id=user-session-123" \
  -H "Authorization: Bearer wc-your-api-key" \
  -H "whitecircle-version: 2025-12-01"

Using the internal session ID:

cURL

curl -X GET "https://eu.whitecircle.com/api/session/get_by_id?deployment_id=your-deployment-id&internal_session_id=123e4567-e89b-12d3-a456-426614174000" \
  -H "Authorization: Bearer wc-your-api-key" \
  -H "whitecircle-version: 2025-12-01"

Response

The endpoint returns a list of check results matching the provided session identifier. Each result includes:

  • flagged — Whether any policy violations were detected
  • internal_session_id — The system-generated UUID for the session
  • external_session_id — Your custom tracking ID (if provided during check)
  • policies — A map of policy IDs to their status, including whether each policy was violated

Authorizations

  • Authorizationstringheaderrequired

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

Headers

  • whitecircle-versionstringrequired

    API Version

    Example: "2025-12-01"

Query Parameters

  • deployment_idstring | null

    Optional deployment ID to validate session ownership

  • external_session_idstring | null

    Find check results by external session ID (your tracking identifier)

  • internal_session_idstring | null

    Find check results by internal session ID (system-generated UUID)

Response

application/json

Success

  • listobject[]required

    Show child attributes
    • list.flaggedbooleanrequired

    • list.internal_session_idstringrequired

    • list.policiesobjectrequired

      Show child attributes
      • list.policies.{key}object

        Show child attributes
        • list.policies.{key}.flaggedbooleanrequired

        • list.policies.{key}.flagged_sourceenum<string>[]required

          Available options: text, image

        • list.policies.{key}.namestringrequired

    • list.external_session_idstring | null

    • list.notestring | null