Bank Account Checker API Documentation
Introduction
The Mintly Bank Account Checker API allows you to connect your application with our comprehensive database of sort codes, bank contact and payment type details, and account number modulus algorithms. With a subscription you can use it to check unlimited numbers of UK and Ireland sort codes and bank account numbers, plus unlimited IBAN and SWIFT.
Our API is RESTful, using predictable and resource orientated URLs with standard HTTP methods and status codes. All responses are in JSON format. The Mintly API is Swagger/OpenAPI 3.0 compatible.
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 feedback 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. Every request sent to this environment counts towards your monthly API usage. For example, if your plan includes 10,000 free checks, that is 10,000 requests.
Sandbox Environment
Our sandbox environment can be used during development of your integration to ensure you are able to handle the error statuses that our API provides. To use the sandbox, simply change the URL to https://sandbox.mintly.uk. You will still be required to provide your API key, however any requests to the sandbox will not be counted towards your billed requests. Note that the sandbox had a predefined set of responses and cannot be used for real account checks.
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 and processed OK resulting in a valid check. |
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. |
403 - Forbidden | Your authentication failed, probably because the API key has expired. |
404 - Not Found | The requested resource does not exist, therefore an invalid result. |
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
curl --location --request \
GET 'https://api.mintly.uk/bankAccount/v1/sortcode/XXXXXX/account/YYYYYYYY' \
--header 'X-API-KEY: YOUR_API_KEY'