List all cases
curl --request GET \
--url https://api.uk.veridox.ai/cases \
--header 'x-api-key: <api-key>'import requests
url = "https://api.uk.veridox.ai/cases"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.uk.veridox.ai/cases', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.uk.veridox.ai/cases",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.uk.veridox.ai/cases"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.uk.veridox.ai/cases")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.uk.veridox.ai/cases")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"cases": [
{
"case_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"label": "<string>",
"metadata": {},
"is_locked": true,
"locked_at": "2023-11-07T05:31:56Z",
"file_analysis_status": "waiting_for_file_analysis",
"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
}{
"error_code": "request.cases.file.missing-risk-score",
"error_message": "User tried to perform an invalid operation on a file without a risk score.",
"error_details": {
"field": "email_address"
}
}{
"error_code": "request.cases.file.missing-risk-score",
"error_message": "User tried to perform an invalid operation on a file without a risk score.",
"error_details": {
"field": "email_address"
}
}{
"error_code": "request.cases.file.missing-risk-score",
"error_message": "User tried to perform an invalid operation on a file without a risk score.",
"error_details": {
"field": "email_address"
}
}Cases
List Cases
Retrieve a list of cases you can reach, with optional exact-match label lookup.
GET
/
cases
List all cases
curl --request GET \
--url https://api.uk.veridox.ai/cases \
--header 'x-api-key: <api-key>'import requests
url = "https://api.uk.veridox.ai/cases"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.uk.veridox.ai/cases', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.uk.veridox.ai/cases",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.uk.veridox.ai/cases"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.uk.veridox.ai/cases")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.uk.veridox.ai/cases")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"cases": [
{
"case_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"label": "<string>",
"metadata": {},
"is_locked": true,
"locked_at": "2023-11-07T05:31:56Z",
"file_analysis_status": "waiting_for_file_analysis",
"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
}{
"error_code": "request.cases.file.missing-risk-score",
"error_message": "User tried to perform an invalid operation on a file without a risk score.",
"error_details": {
"field": "email_address"
}
}{
"error_code": "request.cases.file.missing-risk-score",
"error_message": "User tried to perform an invalid operation on a file without a risk score.",
"error_details": {
"field": "email_address"
}
}{
"error_code": "request.cases.file.missing-risk-score",
"error_message": "User tried to perform an invalid operation on a file without a risk score.",
"error_details": {
"field": "email_address"
}
}Retrieve a list of cases, newest first.
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.
Permission
You see the cases you created, or every case in your organisation if you haveorganisation_cases:read or your organisation has shared cases enabled. An API key without organisation_cases:read receives an empty list, unless your organisation has shared cases enabled. See Permissions and API Keys.
Pass scope=own to see only the cases you created, or scope=org to ask for every case in the organisation. If you cannot see every case, scope=org returns 400 with request.cases.case.org-scope-not-permitted.
Finding a case by label
Pass the optionallabel query parameter to fetch the case (or cases) whose label matches exactly. The match is case-sensitive and covers the same cases as the unfiltered list.
curl -H "x-api-key: $API_KEY" \
"https://api.uk.veridox.ai/cases?label=Claim%20POLICY-12345"
Best Practices
- Use List for Overview: Use
GET /casesfor dashboards and case selection. - Use Details for Specifics: Use
GET /cases/{id}when you need file-level information. - 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. - Use Search for Discovery: For partial or fuzzy matching across case labels and file names, use
GET /searchinstead.?label=on this endpoint is exact-match only. - Monitor Status: Check
file_analysis_statusfor processing updates.
Authorizations
Query Parameters
Maximum number of cases to return
Required range:
1 <= x <= 100Number of cases to skip for pagination
Required range:
0 <= x <= 9007199254740991Required string length:
1 - 255Explicitly request a visibility scope. "own" forces the result to only cases the caller created, even if they can view the whole organisation. "org" explicitly requests every case in the organisation — rejected with 400 if the caller cannot view org-wide. Omitted (default): today's behaviour is unchanged — the caller's resolved org-wide visibility decides the result set, with no rejection.
Available options:
own, org Was this page helpful?
⌘I