Search cases and files
curl --request GET \
--url https://api.uk.veridox.ai/search \
--header 'x-api-key: <api-key>'import requests
url = "https://api.uk.veridox.ai/search"
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/search', 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/search",
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/search"
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/search")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.uk.veridox.ai/search")
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{
"results": [
{
"file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"case_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"case_label": "<string>",
"label": "<string>",
"mime_type": "<string>",
"thumbnail_url": "<string>",
"current_risk_score": "<string>",
"analysis_status": "waiting_for_upload",
"analysis_outcome": "success",
"current_analysis_phase": "<string>",
"uploaded_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"team_name": "<string>",
"match_context": {
"score": 123,
"highlights": {},
"matched_entities": {
"key_persons": [
"<string>"
],
"key_organisations": [
"<string>"
],
"key_locations": [
"<string>"
],
"key_dates": [
"<string>"
],
"key_reference_numbers": [
"<string>"
]
}
}
}
],
"total": 123
}{
"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"
}
}Search
Search Cases and Files
Perform full-text search across all cases and files accessible to you.
GET
/
search
Search cases and files
curl --request GET \
--url https://api.uk.veridox.ai/search \
--header 'x-api-key: <api-key>'import requests
url = "https://api.uk.veridox.ai/search"
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/search', 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/search",
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/search"
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/search")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.uk.veridox.ai/search")
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{
"results": [
{
"file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"case_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"case_label": "<string>",
"label": "<string>",
"mime_type": "<string>",
"thumbnail_url": "<string>",
"current_risk_score": "<string>",
"analysis_status": "waiting_for_upload",
"analysis_outcome": "success",
"current_analysis_phase": "<string>",
"uploaded_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"team_name": "<string>",
"match_context": {
"score": 123,
"highlights": {},
"matched_entities": {
"key_persons": [
"<string>"
],
"key_organisations": [
"<string>"
],
"key_locations": [
"<string>"
],
"key_dates": [
"<string>"
],
"key_reference_numbers": [
"<string>"
]
}
}
}
],
"total": 123
}{
"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"
}
}Perform a comprehensive search across all cases and files accessible to you. This endpoint allows you to find matching case labels and file names, providing a unified search experience for your document workflows.
Permission
You see the files you uploaded and their cases, or every file in your organisation if you haveorganisation_files:read or your organisation has shared cases enabled. An API key without organisation_files:read receives empty results, unless your organisation has shared cases enabled. See Permissions and API Keys.
Pass scope=own to search only your own cases and files, or scope=org to search the whole organisation. If you cannot see every file, scope=org returns 400 with request.cases.case-file.org-scope-not-permitted.
Features
- Prefix Matching: Search results include partial matches (e.g., “pol” matches “policy”).
- Unified Results: Matches against both case labels and file names.
- Flat Output: Returns a flat list of files with their parent case context for easy display.
Best Practices
- Debounce UI Searches: If implementing search-as-you-type in your frontend, debounce requests (e.g., 300ms) to avoid hitting rate limits.
- Specific Queries: More specific search terms yield more relevant results and improve performance.
- Pagination: Use
limitandoffsetfor large result sets to maintain responsive UI performance.
Authorizations
Query Parameters
Required string length:
1 - 100Maximum number of results to return
Required range:
1 <= x <= 100Number of results to skip for pagination
Required range:
0 <= x <= 9007199254740991Explicitly request a visibility scope. "own" forces the result to only cases/files the caller created, even if they can view the whole organisation. "org" explicitly requests every case/file 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