Mintly EISCD API (v2) (2.0.0)
Download OpenAPI specification:YAMLJSON
The Mintly EISCD API gives your application direct access to the Extended Industry Sort Code Directory — the reference database of UK sort codes. The weekly plan provides the complete EISCD snapshot in all four published formats, plus the weekly delta files listing what changed.
The API is RESTful, using predictable, resource-oriented URLs with standard HTTP methods and status codes. It is OpenAPI 3.0 compliant, so it integrates cleanly with any tooling that understands the OpenAPI standard.
Questions? Email us at support@mintly.uk.
Authentication
Every request must carry an X-API-KEY header set to your organisation's
unique key. Keep this secret.
X-API-KEY: YOUR_API_KEY
Environment
Production is at https://api.mintly.uk/eiscd/v2. There is no sandbox
environment for this API.
New EISCD data files are published every Friday from 12:00 GMT, and the data should be treated as valid from the following Monday.
Status codes
We use standard HTTP status codes, including but not limited to:
| Status | Meaning |
|---|---|
200 OK |
The request succeeded. The response body is the file. |
403 Forbidden |
The API key is missing, invalid or disabled. |
404 Not found |
The requested file is not available. |
429 Too many requests |
You have exceeded the rate limit. Wait, then retry. |
500 Server error |
Something went wrong on our side — get in touch so we can look into it. |
Every non-200 response has a JSON body with a Status and a Message
field:
{
"Status": "Invalid",
"Message": "File not found"
}
A file that does not exist and a file that is not part of your plan both
return 404, and are deliberately indistinguishable.
What changed in v2
v2 changes how failures are reported, and that is a breaking change.
| v1 | v2 | |
|---|---|---|
| Base URL | https://api.mintly.uk/eiscd |
https://api.mintly.uk/eiscd/v2 |
| Failed download status | 200 |
403, 404, 429 or 500 |
| Error body | XML | JSON (Status, Message) |
If your integration inspects the response body or Content-Type to work out
whether a download failed, it can rely on the status code instead. Nothing
else about the endpoints, parameters or file formats has changed.
Version 1 remains available and unchanged for existing integrations.
Backwards compatibility
The API is designed to be backwards compatible, so changes should not disrupt existing integrations. We follow semantic versioning for API releases. Build your integration to handle non-breaking changes gracefully. If a breaking change ever becomes necessary, we will give advance notice and a clear migration path, and keep the existing version available for a defined deprecation period.
AI agent skill
Install the Mintly EISCD agent skill for AI-assisted integration help inside
your editor. Once installed, invoke /eiscd-api to generate client code,
process delta files, and schedule automated data syncs.
Built on the Agent Skills open standard, it works with Claude Code, VS Code (GitHub Copilot), OpenAI Codex, Cursor, Gemini CLI, and many more.
Endpoints
Mintly EISCD API (v2) v2.0.0 exposes 5 endpoints, documented in full below.
| Method | Endpoint | Description |
|---|---|---|
| GET | /delta-files/{year}/{week}/eiscd-delta.txt | Fetches the changes since the previous EISCD data file |
| GET | /eiscd-text.zip | Fetches the entire EISCD data file in tab delimited text format. |
| GET | /eiscd-xml.zip | Fetches the entire EISCD data file in XML format. |
| GET | /eiscd-csv.zip | Fetches the entire EISCD data file in CSV format. |
| GET | /eiscd-xlsx.zip | Fetches the entire EISCD data file in XLSX Excel format. |