API REFERENCE · Review evidence

Read match decisions, assignments, retained notes and attachment metadata

Complete request parameters, body fields, response formats, examples, and errors for GET /investigations/{id}.

Base URL: https://www.sanctionskit.com/api/v1. Documentation examples are saved and require no API key to read.

All endpoints and schemas
GET/investigations/{id}Read match decisions, assignments, retained notes and attachment metadata

Authentication: Authorization: Bearer YOUR_API_KEY (required). Use a server-side key for the intended environment and scopes.

Required API key scope: results:read.

Request parameters

Path parameters
id
Query parameters
None.
JSON body fields
None.

This operation has no request body.

Headers, path and query parameters

idpathRequired
string

Opaque resource identifier owned by the authenticated organization.

Format: uuid.

Request body

This operation has no request body.

Responses

200Successful response. JSON object with the required data key. All properties marked required are present, including keys whose value may be null. Unmarked properties can be omitted; clients should tolerate additional response properties.

Response headers

X-Request-Id
string

Server-generated request correlation identifier.

Format: uuid.

application/json

Response fields

Required means present in the containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

dataRequired
objectView Investigation schema
data fields and rules
data.idRequired
string

Format: uuid.

data.screeningIdRequired
string

Format: uuid.

data.counterpartyIdRequired
string or null

May be null.

data.counterpartyId fields and rules

Allowed alternatives

  • string

    Format: uuid.

  • null

    May be null.

data.decisionRequired
string

Values: "open", "confirmed", "dismissed".

data.revisionRequired
integer

Minimum: 0.

data.assigneeIdRequired
string or null

May be null.

data.assigneeId fields and rules

Allowed alternatives

  • string
  • null

    May be null.

data.priorityRequired
string

Values: "low", "normal", "high", "urgent".

data.dueAtRequired
string or null

May be null.

data.dueAt fields and rules

Allowed alternatives

  • string

    Format: date-time.

  • null

    May be null.

data.escalatedAtRequired
string or null

May be null.

data.escalatedAt fields and rules

Allowed alternatives

  • string

    Format: date-time.

  • null

    May be null.

data.requiresSecondReviewRequired
boolean
data.reviewStateRequired
string

Values: "open", "pending_approval", "approved", "superseded".

data.businessDispositionRequired
string

Values: "pending", "allow", "restrict", "escalate".

data.reviewStartedAtRequired
string

Format: date-time.

data.supersededByScreeningIdRequired
string or null

May be null.

data.supersededByScreeningId fields and rules

Allowed alternatives

  • string

    Format: uuid.

  • null

    May be null.

data.supersededByCaseIdRequired
string or null

May be null.

data.supersededByCaseId fields and rules

Allowed alternatives

  • string

    Format: uuid.

  • null

    May be null.

data.approvalRequiredByPolicyRequired
boolean
data.approvalRequiredForActionsRequired
string[]
data.approvalRequiredForActions item fields

Each array item: string.

data.approverRolesRequired
string[]
data.approverRoles item fields

Each array item: string.

data.reviewConcernRequired
string or null

May be null.

data.reviewConcern fields and rules

Allowed alternatives

  • string
  • null

    May be null.

data.policyContextRequired
object or null

May be null.

data.policyContext fields and rules

Allowed alternatives

  • Provide data.policyContext.id and data.policyContext.version and data.policyContext.name and data.policyContext.purpose and data.policyContext.exclusions.
    data.policyContext.idRequired
    string

    Format: uuid.

    data.policyContext.versionRequired
    integer

    Minimum: 0.

    data.policyContext.nameRequired
    string
    data.policyContext.purposeRequired
    string
    data.policyContext.exclusionsRequired
    string[]
    data.policyContext.exclusions item fields

    Each array item: string.

  • null

    May be null.

data.decisionHistoryRequired
object[]
data.decisionHistory item fields

Each array item: object.

data.decisionHistory[].idRequired
string

Format: uuid.

data.decisionHistory[].screeningIdRequired
string or null

May be null.

data.decisionHistory[].screeningId fields and rules

Allowed alternatives

  • string

    Format: uuid.

  • null

    May be null.

data.decisionHistory[].decisionRequired
string

Values: "open", "confirmed", "dismissed".

data.decisionHistory[].businessDispositionRequired
string or null

May be null.

data.decisionHistory[].businessDisposition fields and rules

Allowed alternatives

  • string

    Values: "pending", "allow", "restrict", "escalate".

  • null

    May be null.

data.decisionHistory[].rationaleRequired
string or null

May be null.

data.decisionHistory[].rationale fields and rules

Allowed alternatives

  • string
  • null

    May be null.

data.decisionHistory[].actorIdRequired
string
data.decisionHistory[].actorLabelRequired
string or null

May be null.

data.decisionHistory[].actorLabel fields and rules

Allowed alternatives

  • string
  • null

    May be null.

data.decisionHistory[].createdAtRequired
string

Format: date-time.

data.decisionHistory[].appliedControlsRequired
AppliedDecisionControls or null

May be null.

data.decisionHistory[].appliedControls fields and rules

Allowed alternatives

data.decisionHistoryTruncatedRequired
boolean
data.checksRequired
object[]
data.checks item fields

Each array item: object.

data.checks[].labelRequired
string
data.checks[].instructionsOptional
string
data.checks[].evidenceExampleOptional
string
data.checks[].reviewConcernOptional
string
data.checks[].statusRequired
string

Values: "outstanding", "completed_externally", "not_applicable".

data.checks[].evidenceReferenceRequired
string
data.checks[].rationaleRequired
string
data.checks[].actorIdRequired
string or null

May be null.

data.checks[].actorId fields and rules

Allowed alternatives

  • string
  • null

    May be null.

data.checks[].updatedAtRequired
string or null

May be null.

data.checks[].updatedAt fields and rules

Allowed alternatives

  • string

    Format: date-time.

  • null

    May be null.

data.checkHistoryRequired
object[]
data.checkHistory item fields

Each array item: object.

data.checkHistory[].idRequired
string

Format: uuid.

data.checkHistory[].screeningIdRequired
string

Format: uuid.

data.checkHistory[].labelRequired
string
data.checkHistory[].statusRequired
string

Values: "outstanding", "completed_externally", "not_applicable".

data.checkHistory[].evidenceReferenceRequired
string
data.checkHistory[].rationaleRequired
string
data.checkHistory[].actorIdRequired
string
data.checkHistory[].updatedAtRequired
string

Format: date-time.

data.checkHistory[].expiresAtRequired
string or null

May be null.

data.checkHistory[].expiresAt fields and rules

Allowed alternatives

  • string

    Format: date-time.

  • null

    May be null.

data.reuseChallengesRequired
object[]
data.reuseChallenges item fields

Each array item: object.

data.reuseChallenges[].ruleIdRequired
string
data.reuseChallenges[].originCaseIdRequired
string
data.reuseChallenges[].challengedByCaseIdRequired
string
data.reuseChallenges[].actorIdRequired
string
data.reuseChallenges[].revokedAtRequired
string

Format: date-time.

data.reuseChallenges[].affectedCaseIdsRequired
string[]
data.reuseChallenges[].affectedCaseIds item fields

Each array item: string.

data.submittedByRequired
string or null

May be null.

data.submittedBy fields and rules

Allowed alternatives

  • string
  • null

    May be null.

data.approvedByRequired
string or null

May be null.

data.approvedBy fields and rules

Allowed alternatives

  • string
  • null

    May be null.

data.matchesRequired
object[]
data.matches item fields

Each array item: object.

data.matches[].idRequired
string

Format: uuid.

data.matches[].screeningIdRequired
string

Format: uuid.

data.matches[].sourceIdRequired
string
data.matches[].recordIdRequired
string
data.matches[].identityDecisionRequired
string

Values: "unresolved", "same", "different".

data.matches[].businessDecisionRequired
string

Values: "pending", "allow", "restrict", "escalate".

data.matches[].rationaleRequired
string
data.matches[].reusableUntilRequired
string or null

May be null.

data.matches[].reusableUntil fields and rules

Allowed alternatives

  • string

    Format: date-time.

  • null

    May be null.

data.matches[].reusedRuleIdRequired
string or null

May be null.

data.matches[].reusedRuleId fields and rules

Allowed alternatives

  • string

    Format: uuid.

  • null

    May be null.

data.matches[].actorIdRequired
string
data.matches[].updatedAtRequired
string

Format: date-time.

data.matches[].reuseOptional
object
data.matches[].reuse fields and rules
data.matches[].reuse.caseIdRequired
string

Format: uuid.

data.matches[].reuse.screeningIdRequired
string

Format: uuid.

data.matches[].reuse.approvedByRequired
string
data.matches[].reuse.expiresAtRequired
string

Format: date-time.

data.matches[].reuse.revokedAtRequired
string or null

May be null.

data.matches[].reuse.revokedAt fields and rules

Allowed alternatives

  • string

    Format: date-time.

  • null

    May be null.

data.subjectRequired
Subject or null

May be null.

data.subject fields and rules

Allowed alternatives

  • Subject

    See all Subject fields for the complete structure, required properties and constraints.

  • null

    May be null.

data.counterpartySubjectRequired
Subject or null

May be null.

data.counterpartySubject fields and rules

Allowed alternatives

  • Subject

    See all Subject fields for the complete structure, required properties and constraints.

  • null

    May be null.

data.counterpartyRevisionRequired
integer or null

May be null.

data.counterpartyRevision fields and rules

Allowed alternatives

  • integer

    Minimum: 0.

  • null

    May be null.

data.originCorrectionRequired
object or null

May be null.

data.originCorrection fields and rules

Allowed alternatives

  • Provide data.originCorrection.caseId and data.originCorrection.screeningId.
    data.originCorrection.caseIdRequired
    string

    Format: uuid.

    data.originCorrection.screeningIdRequired
    string

    Format: uuid.

  • null

    May be null.

data.evidenceRequired
object[]
data.evidence item fields

Each array item: object.

data.evidence[].idRequired
string

Format: uuid.

data.evidence[].screeningIdRequired
string

Format: uuid.

data.evidence[].sourceIdRequired
string
data.evidence[].recordIdRequired
string
data.evidence[].fieldRequired
string
data.evidence[].valueRequired
string
data.evidence[].sourceReferenceRequired
string
data.evidence[].verificationRequired
string

Values: "unverified", "verified".

data.evidence[].comparisonRequired
string

Values: "agrees", "conflicts", "unknown".

data.evidence[].notesRequired
string
data.evidence[].contentRequired
string
data.evidence[].actorIdRequired
string
data.evidence[].createdAtRequired
string

Format: date-time.

data.evidence[].expiresAtRequired
string or null

May be null.

data.evidence[].expiresAt fields and rules

Allowed alternatives

  • string

    Format: date-time.

  • null

    May be null.

data.correctionsRequired
object[]
data.corrections item fields

Each array item: object.

data.corrections[].idRequired
string

Format: uuid.

data.corrections[].screeningIdRequired
string

Format: uuid.

data.corrections[].resultScreeningIdRequired
string

Format: uuid.

data.corrections[].resultCaseIdRequired
string or null

May be null.

data.corrections[].resultCaseId fields and rules

Allowed alternatives

  • string

    Format: uuid.

  • null

    May be null.

data.corrections[].beforeRequired
objectView Subject schema
data.corrections[].before fields and rules

See all Subject fields for the complete structure, required properties and constraints.

data.corrections[].afterRequired
objectView Subject schema
data.corrections[].after fields and rules

See all Subject fields for the complete structure, required properties and constraints.

data.corrections[].reasonRequired
string
data.corrections[].actorIdRequired
string
data.corrections[].createdAtRequired
string

Format: date-time.

data.corrections[].expiresAtRequired
string or null

May be null.

data.corrections[].expiresAt fields and rules

Allowed alternatives

  • string

    Format: date-time.

  • null

    May be null.

data.reviewHistoryRequired
object[]
data.reviewHistory item fields

Each array item: object.

data.reviewHistory[].idRequired
string

Format: uuid.

data.reviewHistory[].screeningIdRequired
string

Format: uuid.

data.reviewHistory[].sourceIdRequired
string
data.reviewHistory[].recordIdRequired
string
data.reviewHistory[].reviewRequired
object
data.reviewHistory[].review fields and rules
data.reviewHistory[].review.idRequired
string

Format: uuid.

data.reviewHistory[].review.screeningIdRequired
string

Format: uuid.

data.reviewHistory[].review.sourceIdRequired
string
data.reviewHistory[].review.recordIdRequired
string
data.reviewHistory[].review.identityDecisionRequired
string
data.reviewHistory[].review.businessDecisionRequired
string
data.reviewHistory[].review.rationaleRequired
string
data.reviewHistory[].review.reusableUntilRequired
string or null

May be null.

data.reviewHistory[].review.reusableUntil fields and rules

Allowed alternatives

  • string

    Format: date-time.

  • null

    May be null.

data.reviewHistory[].review.reusedRuleIdRequired
string or null

May be null.

data.reviewHistory[].review.reusedRuleId fields and rules

Allowed alternatives

  • string

    Format: uuid.

  • null

    May be null.

data.reviewHistory[].review.actorIdRequired
string
data.reviewHistory[].review.updatedAtRequired
string

Format: date-time.

data.reviewHistory[].replacedByRequired
string
data.reviewHistory[].reasonRequired
string

Values: "decision_updated", "evidence_added", "subject_corrected", "rule_challenged".

data.reviewHistory[].createdAtRequired
string

Format: date-time.

data.reviewHistory[].expiresAtRequired
string or null

May be null.

data.reviewHistory[].expiresAt fields and rules

Allowed alternatives

  • string

    Format: date-time.

  • null

    May be null.

data.commentsRequired
object[]
data.comments item fields

Each array item: object.

data.comments[].idRequired
string

Format: uuid.

data.comments[].bodyRequired
string
data.comments[].actorIdRequired
string
data.comments[].createdAtRequired
string

Format: date-time.

data.attachmentsRequired
object[]
data.attachments item fields

Each array item: object.

data.attachments[].idRequired
string

Format: uuid.

data.attachments[].titleRequired
string
data.attachments[].sha256Required
string
data.attachments[].sizeRequired
integer

Minimum: 0.

data.attachments[].actorIdRequired
string
data.attachments[].createdAtRequired
string

Format: date-time.

data.attachments[].expiresAtRequired
string or null

May be null.

data.attachments[].expiresAt fields and rules

Allowed alternatives

  • string

    Format: date-time.

  • null

    May be null.

data.assigneesRequired
object[]
data.assignees item fields

Each array item: object.

data.assignees[].idRequired
string
data.assignees[].emailRequired
string
data.assignees[].roleRequired
string

Example response

Recorded from the real application handler against an isolated synthetic database. IDs, times and nonfunctional temporary secrets are normalized. No customer data or live provider request.

{
  "data": {
    "id": "00000000-0000-4000-8000-000000000001",
    "screeningId": "00000000-0000-4000-8000-000000000002",
    "counterpartyId": "00000000-0000-4000-8000-000000000003",
    "decision": "open",
    "revision": 1,
    "assigneeId": null,
    "priority": "normal",
    "dueAt": null,
    "escalatedAt": null,
    "requiresSecondReview": false,
    "reviewState": "open",
    "businessDisposition": "pending",
    "reviewStartedAt": "2026-09-17T12:00:00.000Z",
    "supersededByScreeningId": null,
    "supersededByCaseId": null,
    "approvalRequiredByPolicy": false,
    "approvalRequiredForActions": [],
    "approverRoles": [
      "owner",
      "admin",
      "analyst"
    ],
    "reviewConcern": null,
    "policyContext": {
      "id": "00000000-0000-4000-8000-000000000004",
      "version": 1,
      "name": "Synthetic onboarding policy",
      "purpose": "Document vendor onboarding checks",
      "exclusions": []
    },
    "decisionHistory": [
      {
        "id": "00000000-0000-4000-8000-000000000005",
        "decision": "open",
        "businessDisposition": "pending",
        "rationale": "Potential matches require analyst review.",
        "actorId": "system:screening",
        "actorLabel": null,
        "createdAt": "2026-09-17T12:00:00.000Z",
        "appliedControls": {
          "restrictedRoles": {
            "approval": [],
            "production": []
          },
          "screeningPolicy": {
            "id": "00000000-0000-4000-8000-000000000004",
            "review": {
              "approverRoles": [
                "owner",
                "admin",
                "analyst"
              ],
              "secondReviewFor": [],
              "requireSecondReview": false
            },
            "version": 1
          },
          "governanceRevision": 1,
          "organizationApproval": {
            "approverRoles": [
              "owner",
              "admin",
              "analyst"
            ],
            "secondReviewFor": [],
            "requireSecondReview": false
          }
        },
        "screeningId": "00000000-0000-4000-8000-000000000002"
      }
    ],
    "decisionHistoryTruncated": false,
    "checks": [
      {
        "label": "Ownership review",
        "status": "outstanding",
        "evidenceReference": "",
        "rationale": "",
        "actorId": null,
        "updatedAt": null
      }
    ],
    "checkHistory": [],
    "reuseChallenges": [],
    "submittedBy": null,
    "approvedBy": null,
    "matches": [
      {
        "id": "00000000-0000-4000-8000-000000000006",
        "screeningId": "00000000-0000-4000-8000-000000000002",
        "sourceId": "sandbox-synthetic",
        "recordId": "sandbox:person-001",
        "identityDecision": "unresolved",
        "businessDecision": "pending",
        "rationale": "",
        "reusableUntil": null,
        "reusedRuleId": null,
        "actorId": "system:screening",
        "updatedAt": "2026-09-17T12:00:00.000Z"
      }
    ],
    "subject": {
      "name": "Alex Morgan",
      "entityType": "person",
      "identifiers": []
    },
    "counterpartySubject": {
      "name": "Alex Morgan",
      "entityType": "person",
      "identifiers": []
    },
    "counterpartyRevision": 2,
    "evidence": [],
    "corrections": [],
    "originCorrection": null,
    "reviewHistory": [],
    "comments": [],
    "attachments": [],
    "assignees": [
      {
        "id": "docs-synthetic-reviewer",
        "email": "reviewer@example.test",
        "role": "owner"
      }
    ]
  }
}
400invalid_request — Correct the request fields, resource identifiers, JSON body or query parameters before retrying.

Response headers

X-Request-Id
string

Server-generated correlation identifier, also returned in error.requestId.

Format: uuid.

application/jsonView Error schema

Response fields

Required means present in the containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

Failure envelope for every documented non-2xx API response. No data property is returned. Switch on error.code; messages may change.

errorRequired
object
error fields and rules
error.codeRequired
string

Machine-readable failure code. See this operation’s status-specific examples for codes and recovery.

error.messageRequired
string

Human-readable explanation. Do not parse this text to control application behavior.

error.requestIdRequired
string

Server correlation ID, also returned in X-Request-Id. Include this ID in support requests.

Format: uuid.

error.detailsOptional
object[] or object or string or number or boolean or null

Optional JSON details for client and validation failures. Validation failures return an array of { path, message } issues; other 4xx codes may return a code-specific object. Server failures omit details. Never assume this key is present.

error.details fields and rules

Allowed alternatives

  • object[]

    Maximum items: 50.

    Each array item: object.

    error.details[].pathRequired
    string

    Dot-separated invalid field path, including array indexes.

    Maximum length: 160.

    error.details[].messageRequired
    string

    Validation problem for this field.

    Maximum length: 300.

  • object

    Additional keys are allowed; their values are not a fixed contract.

  • string or number or boolean or null

    May be null.

error.detailsTruncatedOptional
boolean

True when only the first 50 validation issues are returned. Validation paths and messages are bounded.

Example response

Synthetic error example. Correct the request fields, resource identifiers, JSON body or query parameters before retrying.

{
  "error": {
    "code": "invalid_request",
    "message": "The request is invalid.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}
401authentication_required — Send Authorization: Bearer with a valid API key. An omitted header can produce authentication_required; invalid supplied credentials produce invalid_api_key. invalid_api_key — Use an active key for the intended environment.

Response headers

X-Request-Id
string

Server-generated correlation identifier, also returned in error.requestId.

Format: uuid.

WWW-Authenticate
string

Bearer authentication challenge.

application/jsonView Error schema

Response fields

Required means present in the containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

Failure envelope for every documented non-2xx API response. No data property is returned. Switch on error.code; messages may change.

errorRequired
object
error fields and rules
error.codeRequired
string

Machine-readable failure code. See this operation’s status-specific examples for codes and recovery.

error.messageRequired
string

Human-readable explanation. Do not parse this text to control application behavior.

error.requestIdRequired
string

Server correlation ID, also returned in X-Request-Id. Include this ID in support requests.

Format: uuid.

error.detailsOptional
object[] or object or string or number or boolean or null

Optional JSON details for client and validation failures. Validation failures return an array of { path, message } issues; other 4xx codes may return a code-specific object. Server failures omit details. Never assume this key is present.

error.details fields and rules

Allowed alternatives

  • object[]

    Maximum items: 50.

    Each array item: object.

    error.details[].pathRequired
    string

    Dot-separated invalid field path, including array indexes.

    Maximum length: 160.

    error.details[].messageRequired
    string

    Validation problem for this field.

    Maximum length: 300.

  • object

    Additional keys are allowed; their values are not a fixed contract.

  • string or number or boolean or null

    May be null.

error.detailsTruncatedOptional
boolean

True when only the first 50 validation issues are returned. Validation paths and messages are bounded.

Example response

Synthetic error example. Send Authorization: Bearer with a valid API key. An omitted header can produce authentication_required; invalid supplied credentials produce invalid_api_key.

{
  "error": {
    "code": "authentication_required",
    "message": "Sign in to continue.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}
invalid api key

Synthetic error example. Use an active key for the intended environment.

{
  "error": {
    "code": "invalid_api_key",
    "message": "The API key is invalid, expired, or revoked.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}
403permission_denied — Ask an organization owner to grant the required role or API-key scope. insufficient_scope — Use a key with the scope stated in this operation.

Response headers

X-Request-Id
string

Server-generated correlation identifier, also returned in error.requestId.

Format: uuid.

application/jsonView Error schema

Response fields

Required means present in the containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

Failure envelope for every documented non-2xx API response. No data property is returned. Switch on error.code; messages may change.

errorRequired
object
error fields and rules
error.codeRequired
string

Machine-readable failure code. See this operation’s status-specific examples for codes and recovery.

error.messageRequired
string

Human-readable explanation. Do not parse this text to control application behavior.

error.requestIdRequired
string

Server correlation ID, also returned in X-Request-Id. Include this ID in support requests.

Format: uuid.

error.detailsOptional
object[] or object or string or number or boolean or null

Optional JSON details for client and validation failures. Validation failures return an array of { path, message } issues; other 4xx codes may return a code-specific object. Server failures omit details. Never assume this key is present.

error.details fields and rules

Allowed alternatives

  • object[]

    Maximum items: 50.

    Each array item: object.

    error.details[].pathRequired
    string

    Dot-separated invalid field path, including array indexes.

    Maximum length: 160.

    error.details[].messageRequired
    string

    Validation problem for this field.

    Maximum length: 300.

  • object

    Additional keys are allowed; their values are not a fixed contract.

  • string or number or boolean or null

    May be null.

error.detailsTruncatedOptional
boolean

True when only the first 50 validation issues are returned. Validation paths and messages are bounded.

Example response

Synthetic error example. Ask an organization owner to grant the required role or API-key scope.

{
  "error": {
    "code": "permission_denied",
    "message": "Your role does not allow this action.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}
insufficient scope

Synthetic error example. Use a key with the scope stated in this operation.

{
  "error": {
    "code": "insufficient_scope",
    "message": "The API key does not grant this action.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}
404not_found — Check the identifier and selected environment. The resource must belong to your organization and remain available.

Response headers

X-Request-Id
string

Server-generated correlation identifier, also returned in error.requestId.

Format: uuid.

application/jsonView Error schema

Response fields

Required means present in the containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

Failure envelope for every documented non-2xx API response. No data property is returned. Switch on error.code; messages may change.

errorRequired
object
error fields and rules
error.codeRequired
string

Machine-readable failure code. See this operation’s status-specific examples for codes and recovery.

error.messageRequired
string

Human-readable explanation. Do not parse this text to control application behavior.

error.requestIdRequired
string

Server correlation ID, also returned in X-Request-Id. Include this ID in support requests.

Format: uuid.

error.detailsOptional
object[] or object or string or number or boolean or null

Optional JSON details for client and validation failures. Validation failures return an array of { path, message } issues; other 4xx codes may return a code-specific object. Server failures omit details. Never assume this key is present.

error.details fields and rules

Allowed alternatives

  • object[]

    Maximum items: 50.

    Each array item: object.

    error.details[].pathRequired
    string

    Dot-separated invalid field path, including array indexes.

    Maximum length: 160.

    error.details[].messageRequired
    string

    Validation problem for this field.

    Maximum length: 300.

  • object

    Additional keys are allowed; their values are not a fixed contract.

  • string or number or boolean or null

    May be null.

error.detailsTruncatedOptional
boolean

True when only the first 50 validation issues are returned. Validation paths and messages are bounded.

Example response

Synthetic error example. Check the identifier and selected environment. The resource must belong to your organization and remain available.

{
  "error": {
    "code": "not_found",
    "message": "Investigation not found.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}
405method_not_allowed — Use a method in the Allow response header. OPTIONS lists supported methods; HEAD follows GET authorization and returns no body.

Response headers

X-Request-Id
string

Server-generated correlation identifier, also returned in error.requestId.

Format: uuid.

Allow
string

Comma-separated supported HTTP methods.

application/jsonView Error schema

Response fields

Required means present in the containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

Failure envelope for every documented non-2xx API response. No data property is returned. Switch on error.code; messages may change.

errorRequired
object
error fields and rules
error.codeRequired
string

Machine-readable failure code. See this operation’s status-specific examples for codes and recovery.

error.messageRequired
string

Human-readable explanation. Do not parse this text to control application behavior.

error.requestIdRequired
string

Server correlation ID, also returned in X-Request-Id. Include this ID in support requests.

Format: uuid.

error.detailsOptional
object[] or object or string or number or boolean or null

Optional JSON details for client and validation failures. Validation failures return an array of { path, message } issues; other 4xx codes may return a code-specific object. Server failures omit details. Never assume this key is present.

error.details fields and rules

Allowed alternatives

  • object[]

    Maximum items: 50.

    Each array item: object.

    error.details[].pathRequired
    string

    Dot-separated invalid field path, including array indexes.

    Maximum length: 160.

    error.details[].messageRequired
    string

    Validation problem for this field.

    Maximum length: 300.

  • object

    Additional keys are allowed; their values are not a fixed contract.

  • string or number or boolean or null

    May be null.

error.detailsTruncatedOptional
boolean

True when only the first 50 validation issues are returned. Validation paths and messages are bounded.

Example response

Synthetic error example. Use a method in the Allow response header. OPTIONS lists supported methods; HEAD follows GET authorization and returns no body.

{
  "error": {
    "code": "method_not_allowed",
    "message": "This method is not supported for this endpoint.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}
413response_too_large — Reduce the requested page size or use the documented segmented case archive. No evidence is silently truncated. investigation_too_large — Use the complete segmented case archive for retained evidence.

Response headers

X-Request-Id
string

Server-generated correlation identifier, also returned in error.requestId.

Format: uuid.

application/jsonView Error schema

Response fields

Required means present in the containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

Failure envelope for every documented non-2xx API response. No data property is returned. Switch on error.code; messages may change.

errorRequired
object
error fields and rules
error.codeRequired
string

Machine-readable failure code. See this operation’s status-specific examples for codes and recovery.

error.messageRequired
string

Human-readable explanation. Do not parse this text to control application behavior.

error.requestIdRequired
string

Server correlation ID, also returned in X-Request-Id. Include this ID in support requests.

Format: uuid.

error.detailsOptional
object[] or object or string or number or boolean or null

Optional JSON details for client and validation failures. Validation failures return an array of { path, message } issues; other 4xx codes may return a code-specific object. Server failures omit details. Never assume this key is present.

error.details fields and rules

Allowed alternatives

  • object[]

    Maximum items: 50.

    Each array item: object.

    error.details[].pathRequired
    string

    Dot-separated invalid field path, including array indexes.

    Maximum length: 160.

    error.details[].messageRequired
    string

    Validation problem for this field.

    Maximum length: 300.

  • object

    Additional keys are allowed; their values are not a fixed contract.

  • string or number or boolean or null

    May be null.

error.detailsTruncatedOptional
boolean

True when only the first 50 validation issues are returned. Validation paths and messages are bounded.

Example response

Synthetic error example. Reduce the requested page size or use the documented segmented case archive. No evidence is silently truncated.

{
  "error": {
    "code": "response_too_large",
    "message": "This response exceeds the size limit. Request a smaller page or a segmented export.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}
investigation too large

Synthetic error example. Use the complete segmented case archive for retained evidence.

{
  "error": {
    "code": "investigation_too_large",
    "message": "This investigation exceeds the bounded response size.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}
429rate_limited — Wait for the request window to reset and retry with backoff.

Response headers

X-Request-Id
string

Server-generated correlation identifier, also returned in error.requestId.

Format: uuid.

Retry-After
string

When present, a delay in seconds or an HTTP-date before which the client should not retry. Service-unavailable responses default to a one-second delay unless another safe value is supplied. A usage allowance error may require quota recovery instead of retrying.

application/jsonView Error schema

Response fields

Required means present in the containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

Failure envelope for every documented non-2xx API response. No data property is returned. Switch on error.code; messages may change.

errorRequired
object
error fields and rules
error.codeRequired
string

Machine-readable failure code. See this operation’s status-specific examples for codes and recovery.

error.messageRequired
string

Human-readable explanation. Do not parse this text to control application behavior.

error.requestIdRequired
string

Server correlation ID, also returned in X-Request-Id. Include this ID in support requests.

Format: uuid.

error.detailsOptional
object[] or object or string or number or boolean or null

Optional JSON details for client and validation failures. Validation failures return an array of { path, message } issues; other 4xx codes may return a code-specific object. Server failures omit details. Never assume this key is present.

error.details fields and rules

Allowed alternatives

  • object[]

    Maximum items: 50.

    Each array item: object.

    error.details[].pathRequired
    string

    Dot-separated invalid field path, including array indexes.

    Maximum length: 160.

    error.details[].messageRequired
    string

    Validation problem for this field.

    Maximum length: 300.

  • object

    Additional keys are allowed; their values are not a fixed contract.

  • string or number or boolean or null

    May be null.

error.detailsTruncatedOptional
boolean

True when only the first 50 validation issues are returned. Validation paths and messages are bounded.

Example response

Synthetic error example. Wait for the request window to reset and retry with backoff.

{
  "error": {
    "code": "rate_limited",
    "message": "The per-minute request limit has been reached.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}
500internal_error — Retry with backoff. For writes reuse the same idempotency key and identical input; include requestId when contacting support.

Response headers

X-Request-Id
string

Server-generated correlation identifier, also returned in error.requestId.

Format: uuid.

application/jsonView Error schema

Response fields

Required means present in the containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

Failure envelope for every documented non-2xx API response. No data property is returned. Switch on error.code; messages may change.

errorRequired
object
error fields and rules
error.codeRequired
string

Machine-readable failure code. See this operation’s status-specific examples for codes and recovery.

error.messageRequired
string

Human-readable explanation. Do not parse this text to control application behavior.

error.requestIdRequired
string

Server correlation ID, also returned in X-Request-Id. Include this ID in support requests.

Format: uuid.

error.detailsOptional
object[] or object or string or number or boolean or null

Optional JSON details for client and validation failures. Validation failures return an array of { path, message } issues; other 4xx codes may return a code-specific object. Server failures omit details. Never assume this key is present.

error.details fields and rules

Allowed alternatives

  • object[]

    Maximum items: 50.

    Each array item: object.

    error.details[].pathRequired
    string

    Dot-separated invalid field path, including array indexes.

    Maximum length: 160.

    error.details[].messageRequired
    string

    Validation problem for this field.

    Maximum length: 300.

  • object

    Additional keys are allowed; their values are not a fixed contract.

  • string or number or boolean or null

    May be null.

error.detailsTruncatedOptional
boolean

True when only the first 50 validation issues are returned. Validation paths and messages are bounded.

Example response

Synthetic error example. Retry with backoff. For writes reuse the same idempotency key and identical input; include requestId when contacting support.

{
  "error": {
    "code": "internal_error",
    "message": "The request could not be completed.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}
503temporarily_unavailable — Honor Retry-After when present and retry with bounded backoff. Follow this endpoint’s retry contract; preserve the same key and input for idempotent writes. Contact support with requestId if the failure persists.

Response headers

X-Request-Id
string

Server-generated correlation identifier, also returned in error.requestId.

Format: uuid.

Retry-After
string

When present, a delay in seconds or an HTTP-date before which the client should not retry. Service-unavailable responses default to a one-second delay unless another safe value is supplied. A usage allowance error may require quota recovery instead of retrying.

application/jsonView Error schema

Response fields

Required means present in the containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

Failure envelope for every documented non-2xx API response. No data property is returned. Switch on error.code; messages may change.

errorRequired
object
error fields and rules
error.codeRequired
string

Machine-readable failure code. See this operation’s status-specific examples for codes and recovery.

error.messageRequired
string

Human-readable explanation. Do not parse this text to control application behavior.

error.requestIdRequired
string

Server correlation ID, also returned in X-Request-Id. Include this ID in support requests.

Format: uuid.

error.detailsOptional
object[] or object or string or number or boolean or null

Optional JSON details for client and validation failures. Validation failures return an array of { path, message } issues; other 4xx codes may return a code-specific object. Server failures omit details. Never assume this key is present.

error.details fields and rules

Allowed alternatives

  • object[]

    Maximum items: 50.

    Each array item: object.

    error.details[].pathRequired
    string

    Dot-separated invalid field path, including array indexes.

    Maximum length: 160.

    error.details[].messageRequired
    string

    Validation problem for this field.

    Maximum length: 300.

  • object

    Additional keys are allowed; their values are not a fixed contract.

  • string or number or boolean or null

    May be null.

error.detailsTruncatedOptional
boolean

True when only the first 50 validation issues are returned. Validation paths and messages are bounded.

Example response

Synthetic error example. Honor Retry-After when present and retry with bounded backoff. Follow this endpoint’s retry contract; preserve the same key and input for idempotent writes. Contact support with requestId if the failure persists.

{
  "error": {
    "code": "temporarily_unavailable",
    "message": "The service is temporarily unavailable. Retry shortly.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}

Back to request parameters