Quickstart

Get your API Key

Before making API requests, you’ll need an API key.

Organisation owners

Sign in to your Veridox Dashboard
Navigate to Settings → API Keys
Click Generate API Key
Copy and securely store your key — it won’t be shown again

Your key will look like: vdx_abc123...

Team members

Contact your organisation administrator to obtain an API key. Only organisation owners can generate and manage API keys.

Keep your API key secure. Never commit it to version control or expose it in client-side code.

Create a case and upload files

A case is a container for documents you want to analyse. Here’s how to create one and upload files.

Step 1: Create a case with file placeholders

curl -X POST https://api.uk.neo.veridox.ai/cases \
  -H "X-API-Key: vdx_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "label": "Application #12345",
    "reference_label": "CLM-2025-00142",
    "file_labels": ["passport.pdf", "bank_statement.pdf"]
  }'

Field	Description
`label`	A human-readable name for the case (e.g., application name, filename)
`reference_label`	Your internal reference number (e.g., claim number, policy number)
`file_labels`	Names for each file you’ll upload — one SAS URL is generated per label

Response:

{
  "case_id": "01945abc-def0-7123-4567-89abcdef0123",
  "is_locked": true,
  "stream_url": "/cases/01945abc-def0-7123-4567-89abcdef0123/progress",
  "files": [
    {
      "file_id": "01945abc-def0-7123-4567-89abcdef0124",
      "label": "passport.pdf",
      "sas_url": "https://storage.blob.core.windows.net/...",
      "expires_at": "2025-01-17T12:00:00.000Z"
    },
    {
      "file_id": "01945abc-def0-7123-4567-89abcdef0125",
      "label": "bank_statement.pdf",
      "sas_url": "https://storage.blob.core.windows.net/...",
      "expires_at": "2025-01-17T12:00:00.000Z"
    }
  ]
}

Each file includes a sas_url — a pre-signed URL for direct upload to Azure Blob Storage. These URLs expire after 1 hour.

Step 2: Upload your files

Upload each file directly to its sas_url using a PUT request. Files are uploaded directly to cloud storage, not through the Veridox API.

curl -X PUT "https://storage.blob.core.windows.net/..." \
  -H "x-ms-blob-type: BlockBlob" \
  -H "Content-Type: application/pdf" \
  --data-binary @passport.pdf

Set the Content-Type header to match your file type (e.g., application/pdf, image/jpeg, image/png).

Step 3: Monitor analysis progress

Once files are uploaded, Veridox automatically begins analysis. You can monitor progress using Server-Sent Events (SSE) for real-time updates, or HTTP polling as a fallback.

Server-Sent Events (recommended)
HTTP Polling

SSE provides real-time progress updates with minimal latency.

const eventSource = new EventSource(
  `https://api.uk.neo.veridox.ai/cases/${caseId}/progress/stream?access_token=${accessToken}`
);

eventSource.onmessage = (event) => {
  const data = JSON.parse(event.data);
  console.log('Progress:', data);

  // Close connection when analysis completes
  if (data.type === 'case.analysis.completed') {
    eventSource.close();
  }
};

eventSource.onerror = () => {
  eventSource.close();
};

SSE currently requires a session access token (JWT). API key support for SSE is coming soon.

Poll the progress endpoint periodically to check status.

curl https://api.uk.neo.veridox.ai/cases/{case_id}/progress/poll \
  -H "X-API-Key: vdx_your_api_key"

Response:

{
  "events": [
    {
      "type": "file.analysis.progress",
      "id": "evt_123",
      "fileId": "01945abc-def0-7123-4567-89abcdef0124",
      "stage": "document_extraction",
      "progress": 45
    }
  ],
  "has_more": true
}

When has_more is false, analysis is complete. Use the lastEventId query parameter to fetch only new events on subsequent polls.

Webhooks available — Organisation administrators can configure webhooks to receive real-time notifications when analysis completes. See Webhooks for setup instructions.

Regional API endpoints

Veridox is available in multiple regions. Use the endpoint closest to your data:

Region	API Base URL	Dashboard
United Kingdom	`https://api.uk.neo.veridox.ai`	uk.neo.veridox.ai
Canada	`https://api.ca.neo.veridox.ai`	ca.neo.veridox.ai

Getting started

Get your API Key

Create a case and upload files

Step 1: Create a case with file placeholders

Step 2: Upload your files

Step 3: Monitor analysis progress

Regional API endpoints

What’s next?

API Reference

Webhooks

Getting started

​Get your API Key

​Create a case and upload files

​Step 1: Create a case with file placeholders

​Step 2: Upload your files

​Step 3: Monitor analysis progress

​Regional API endpoints

​What’s next?

API Reference

Webhooks

Get your API Key

Create a case and upload files

Step 1: Create a case with file placeholders

Step 2: Upload your files

Step 3: Monitor analysis progress

Regional API endpoints

What’s next?