Protect

Get Session by ID

GET
/api/protect/get_by_id

Retrieve the results of a previously submitted content check request.

Required Parameters

ParameterDescription
deployment_idSpecific deployment ID used for the check. See Deployments.

Authorizations

  • Authorizationstringheaderrequired

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

Headers

  • whitecircle-versionstringrequired

    API Version

    Example: "2025-06-15"

Query Parameters

  • deployment_idstringrequired

    Specific deployment ID used for the check. See Deployments.

  • include_policy_namesboolean | null

    Whether to include human-readable policy names in the response (default: false)

  • external_idstring | null

    Find check results by external ID (your tracking identifier)

  • internal_idstring | null

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

Response

application/json

Success

  • listobject[]required

    List of check results matching the query

    Show child attributes
    • list.internal_idstringrequired

      Unique internal identifier for this check

    • list.violationbooleanrequired

      Whether any policy violations were detected

    • list.violationsobjectrequired

      Map of policy IDs to policy status objects containing violation and optional name

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

        Show child attributes
        • list.violations.{key}.violationbooleanrequired

          Whether a violation was detected for this policy

        • list.violations.{key}.violation_sourceenum<string>[]required

          Sources where violations were detected (includes only triggered violations)

          Available options: text, image

        • list.violations.{key}.namestring | null

          Human-readable policy name (only present if include_policy_names=true)

    • list.external_idstring | null

      Optional external identifier provided by client