Skip to main content
GET
/
cases
/
{id}
Get case details
curl --request GET \
  --url https://api.{region}.neo.veridox.ai/cases/{id} \
  --header 'Authorization: Bearer <token>'
{
  "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
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Case ID

Response

Case details retrieved successfully

​
case_id
string<uuid>
required
​
label
string | null
required
​
metadata
object
required
​
is_locked
boolean
required
​
locked_at
string<date-time> | null
required
​
file_analysis_status
enum<string>
required
Available options:
waiting_for_file_analysis,
file_analysis_complete
​
file_analysis_completed_at
string<date-time> | null
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
files
object[]
required
​
total_files
number
required

Total number of files associated with the case