Skip to main content
GET
/
cases
List all cases
curl --request GET \
  --url https://api.uk.veridox.ai/cases \
  --header 'x-api-key: <api-key>'
{
  "cases": [
    {
      "case_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "label": "<string>",
      "metadata": {},
      "is_locked": true,
      "locked_at": "2023-11-07T05:31:56Z",
      "file_analysis_completed_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "team_name": "<string>"
    }
  ],
  "total": 4503599627370495,
  "limit": 123,
  "offset": 4503599627370495
}
Retrieve a list of cases belonging to the authenticated user. Cases are returned in reverse chronological order (newest first).

​
Finding a case by label

Pass the optional label query parameter to fetch the case (or cases) whose label matches exactly. The match is case-sensitive and applies to the same access scope as the unfiltered list: you see only your own cases unless your organisation has shared cases enabled, in which case you see any matching case in the organisation. 
curl -H "x-api-key: $API_KEY" \
  "https://api.uk.veridox.ai/cases?label=Claim%20POLICY-12345"
A typical integration uses this to check whether a case already exists for an external reference before creating a new one, making the create-or-fetch flow safely idempotent.

​
Best Practices

  1. Use List for Overview: Use GET /cases for dashboards and case selection.
  2. Use Details for Specifics: Use GET /cases/{id} when you need file-level information.
  3. Use Label Lookup for Idempotency: Use GET /cases?label=... when you have an external reference (claim number, policy ID) and want to find or create a case by that identifier without paginating.
  4. Use Search for Discovery: For partial or fuzzy matching across case labels and file names, use GET /search instead. ?label= on this endpoint is exact-match only.
  5. Monitor Status: Check file_analysis_status for processing updates.

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
limit
integer
default:20

Maximum number of cases to return

Required range: 1 <= x <= 100
​
offset
integer
default:0

Number of cases to skip for pagination

Required range: 0 <= x <= 9007199254740991
​
label
string

Filter cases to those whose label matches this value exactly (case-sensitive). Returns 0 or 1 case for personal-cases users, or up to N cases in shared-cases orgs where multiple members may share a label. Use this for idempotent lookups (e.g. checking whether a case already exists for an external reference).

Required string length: 1 - 255

Response

List of cases retrieved successfully

​
cases
object[]
required
​
total
integer
required
Required range: 0 <= x <= 9007199254740991
​
limit
integer
required
Required range: x <= 9007199254740991
​
offset
integer
required
Required range: 0 <= x <= 9007199254740991