Getting Started
Authentication
All authenticated API requests require a Bearer token in the Authorization header.
Bearer token
Include your API token in every request as a Bearer token in the Authorization header. Tokens are issued via your ComplyPost dashboard and are included automatically when using the web app.
bash
curl -H "Authorization: Bearer YOUR_TOKEN" \
https://api.complypost.co.uk/lettersGenerating API tokens
For automation workflows (n8n, Zapier, Make), generate a long-lived API token from your dashboard:
- 1Go to Settings → API & Integrations in the ComplyPost dashboard.
- 2Click Generate new token. Give it a descriptive name (e.g. “n8n integration”).
- 3Copy the token immediately — it is shown only once. Store it securely in your environment variables or secrets manager.
- 4Revoke tokens at any time from the same settings page.
Token scopes and permissions
API tokens inherit the permissions of the user account that generated them. Tokens generated by an Owner or Admin have full read/write access. Tokens generated by an Operator cannot access billing or user management endpoints.
| Role | Read letters | Manage webhooks | Manage clients | Billing |
|---|---|---|---|---|
| Owner | ✓ | ✓ | ✓ | ✓ |
| Admin | ✓ | ✓ | ✓ | — |
| Operator | ✓ | — | — | — |
| Viewer | ✓ | — | — | — |
Authentication errors
401
UNAUTHORIZEDThe Authorization header is missing, malformed, or contains an invalid/expired token.
403
PLAN_LIMITThe authenticated user's plan does not include API access. Upgrade to Pro or Enterprise.