Skip to main content
POST
/
cases
Create a new case
curl --request POST \
  --url https://api.uk.veridox.ai/cases \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "label": "<string>",
  "file_labels": [
    "<string>"
  ]
}
'
{
  "case_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_locked": true,
  "stream_url": "<string>",
  "files": [
    {
      "file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "label": "<string>",
      "sas_url": "<string>",
      "expires_at": "2023-11-07T05:31:56Z"
    }
  ]
}
A case acts as a container for documents that need to be analysed together. You can create a case with or without file placeholders. With file placeholders: Pre-define expected files and get upload URLs immediately. Without file placeholders: Create case first, then add files later.
Important: Cases are designed for single-batch file uploads. Once you begin uploading files, the case locks to ensure complete analysis. Plan to upload all your files together.

​
Best Practices

  1. Descriptive Labels: Use clear, descriptive case labels like claim numbers or policy numbers for easy identification.
  2. Unique Labels (Case-Insensitive): Case labels must be unique per user regardless of letter casing. Creating a case with a label that only differs by case will return a 409 Conflict response.
  3. File Planning: Pre-define expected files when possible to get upload URLs immediately.
  4. Batch Operations: Create cases in advance for high-volume processing.

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
label
string
required
Required string length: 1 - 255
​
file_labels
string[]
Required string length: 1 - 255

Response

Case created 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})$
​
is_locked
boolean
required
​
stream_url
string
required
​
files
object[]