Skip to main content
GET
/
cases
/
{id}
Get case details
curl --request GET \
  --url https://api.uk.veridox.ai/cases/{id} \
  --header 'x-api-key: <api-key>'
{
  "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",
  "files": [
    {
      "file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "label": "<string>",
      "uploaded_at": "2023-11-07T05:31:56Z",
      "thumbnail_url": "<string>",
      "mime_type": "<string>",
      "analysis_status": "waiting_for_upload",
      "analysis_completed_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total_files": 123
}
Returns detailed information about a specific case, including metadata, lock status, and the analysis status of all associated files. Only the case owner can access this endpoint.

​
Best Practices

  1. Check Completion: Use this endpoint to verify if all files in a case have completed analysis.
  2. File IDs: Use the file_id returned in the files array to request detailed forensic analysis for specific documents.
  3. Error Handling: Be prepared to handle 404 Not Found if the case ID is invalid or belongs to another organisation.

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
id
string
required

Case ID

Response

Case details retrieved successfully

​
case_id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$
​
label
string | null
required
​
metadata
object
required
​
is_locked
boolean
required
​
locked_at
string<date-time> | null
required
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))$
​
file_analysis_status
enum<string>
required
Available options:
waiting_for_file_analysis,
file_analysis_complete
​
file_analysis_completed_at
string<date-time> | null
required
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))$
​
created_at
string<date-time>
required
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))$
​
updated_at
string<date-time>
required
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))$
​
files
object[]
required
​
total_files
number
required