EISCD API Documentation
Introduction
The Mintly EISCD API allows you to connect your application with the EISCD. With a subscription you can use it to obtain the Extended Industry Sort Code Directory, the database of UK sort codes.
Our API is RESTful, using predictable and resource orientated URLs with standard HTTP methods and status codes. The Mintly EISCD API is OpenAPI 3.0 compliant, and easily integrates with third-party tools that handle OpenAPI standards.
API requests are authorised using a unique API key for your organisation, which must be presented in the HTTP header of each request.
If you have any questions about our API, we'd love to hear from you. Please get in touch via email
Authentication
Your code must pass an HTTP header along with every request to the Mintly API. This header must be called X-API-KEY and have the value set to your organisation's unique key. You must keep this secret.
Security
All our APIs are secure, using HTTPS with TLS 1.2 to encrypt data in transit.
Production Environment
Our production environment is available at https://api.mintly.uk. There is no sandbox environment for this API.
API Methods
This API only uses one HTTP method.
| Method | Usage |
|---|---|
GET (read) | Returns details of the requested object. |
API Status Codes
We use standard HTTP status codes in the response header, including, but not limited to, the following:
| HTTP Status | Meaning |
|---|---|
200 - OK | The request succeeded. |
400 - Bad request | Something was wrong with the request. For more details, check the error message included in the response. |
401 - Unauthorised | Your authentication credentials are invalid, or have expired. |
403 - Forbidden | Your authentication failed, either API key has expired or is not provided in the request header. |
429 - Too Many Requests | Your integration has made too many requests, wait and try again later. |
500 - Server Error | Something went wrong on our side - get in touch so we can look into it. |
Example Request
The following example request demonstrates the usage of our API to obtain the base EISCD file.
curl --location --request \
GET 'https://api.mintly.uk/eiscd/eiscd-text.zip' \
--header 'X-API-KEY: YOUR_API_KEY'Backwards Compatibility
Our API is designed to be backwards compatible, meaning that any changes we make should not disrupt existing integrations. We follow semantic versioning when releasing new versions of our API.
We recommend that your integration is built to gracefully handle non-breaking changes, such as the addition of new fields or optional parameters.
In the event that a breaking change is necessary, we will provide advance notice and a clear migration path. Additionally, the existing version of the API will remain available for a defined deprecation period to give you time to update your integration.