Skip to main content

1. Setup your Environment

Before making your first API call, you’ll need an active Veridox account and an API key.
1

Create an Account

Follow our User Registration guide to sign up and receive administrator approval.
2

Generate an API Key

Once approved, log in to your regional dashboard (uk.veridox.ai or ca.veridox.ai):
  1. Navigate to Settings.
  2. Select the Organisation tab.
  3. Provide a Name and Expiry Date for the key.
  4. Click Generate API Key.
  5. Copy and securely store your key — it will only be shown once.
3

Verify Connectivity

Use the Authentication Status endpoint to ensure your key is valid and you can reach our servers.

2. Process your First Document

The core Veridox workflow involves creating a case, uploading your document, and retrieving the forensic results.
1

Create a Case Container

Initialise a new verification case. This generates a secure, pre-signed upload URL for your file. Case labels must be unique per user (case-insensitive), so pick a label that you are not already using.
curl -X POST "https://api.{region}.veridox.ai/cases" \
  -H "X-API-Key: vdx_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{ "label": "Initial Test Case", "file_labels": ["document.pdf"] }'
2

Upload the Document

Upload your document directly to the sas_url provided in the previous step using an HTTP PUT request.
3

Retrieve Forensic Intelligence

Once analysis is complete, fetch the comprehensive report to see risk scores and tampering indicators.
curl -X GET "https://api.{region}.veridox.ai/files/{file_id}/analysis" \
  -H "X-API-Key: vdx_your_api_key"

Next Steps