API REFERENCE · SCHEMA

CaseRequest schema

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

All endpoints and schemas

Open a case for retained evidence. decision must be open; the API cannot complete the human investigation or independent approval workflow.

decisionRequired
"open"

Must be open when creating a case. Completed decisions require the human investigation workflow and return investigation_review_required here.

Must equal "open".

notesRequired
string

Nonempty opening rationale, trimmed before validation. Retained under the case policy.

Minimum length: 1. Maximum length: 5000.

screeningIdRequired
string

UUID of a retained standard screening in this organization and environment. An existing case returns case_exists; minimal or expired evidence cannot be used.

Format: uuid. Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$.

expectedUpdatedAtOptional
string

Legacy optional timestamp accepted and echoed by creation. It is not a concurrency guard for a new case; omit it.

Format: date-time. Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$.

Additional fields are not accepted.