Getting Started

Quick Start

Get your first API call working in under 5 minutes.

1. Get your API key

Log into your ComplyPost dashboard → Settings → API Keys → Generate a new key. Keep it secret — it has full access to your organisation.

2. Make your first request

All requests use Bearer token authentication and return JSON.

curl https://api.complypost.co.uk/v1/clients \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

{
  "clients": [
    {
      "id": "cl_01HXYZ...",
      "name": "Johnson & Partners Ltd",
      "companyNumber": "12345678",
      "email": "[email protected]",
      "createdAt": "2025-01-15T10:00:00Z"
    }
  ],
  "total": 1,
  "page": 1
}

3. Upload a batch

curl https://api.complypost.co.uk/v1/batches \
  -X POST \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "file=@/path/to/scanned-post.pdf"

ComplyPost will split the PDF, run OCR and AI classification on each page, match letters to clients, and deliver them automatically.

4. Listen for events

Register a webhook endpoint to get notified in real time when letters are classified and delivered. See the Webhooks page.

Base URL

https://api.complypost.co.uk/v1

All endpoints require Authorization: Bearer YOUR_API_KEY. Responses are JSON. Dates are ISO 8601 UTC.