API Quickstart

Welcome to Quick Start for the Validate API 

The user interfaces have been built on top of the APIs. This means that you can do anything that the user interface can do and much more with the Validate API using our RESTful web services. 

This quick start will guide you to get your API running as fast as possible. 

You must follow 3 simple steps: 

1. Create an authentication token using a POST call. 
2. Copy the token into a validation call to check the details you have submitted with the details you wish to validate. 
3. Submit the details you wish to validate 

Create an authentication token using a POST call 

The Validate API REST services require users to be authenticated before validating bank details and retrieving data from the system. The tokens are time limited and we recommend that you generate a new token with each call. 

This begins with an HTTP POST request to the authenticate endpoint. All POST requests require the Content-Type header to be used along with a JSON body.  

curl "https://api.validate.bankersalmanac.com/authenticate"\
{
-H "Content-Type: application/json" \ 
--data-raw '{"username":"my username","password":"some password"}' 
 
The response will contain a token field with the token. 

{  
"status":"PASS", 
"comment":"", "token":"Ht2ippXbld1iid61CipvPxGtLQiiXy7jrDMyS3YZ5vLFITNoGTlnsq8g1F"  
} 

Parameters 

The entry parameters are username and password and the fields are case sensitive. These are the username which was created for you by your service administrator and the password you created when you activated the user account. 

Request parameters 

Response parameters 

Retrieving Data  

Data is retrieved by sending an HTTP POST request to the endpoint needed. The request is passed in the body as JSON, whereas the authentication token gets passed into the Authorization header as a bearer token. 

curl -X POST "https://api.validate.bankersalmanac.com/conversion" \ 
-H "Content-Type: application/json" \
-H "Authorization: Bearer Ht2ippXbld1iid61CipvPxGtLQiiXy7jrDMyS3YALA7DJip7JY5ckm4XWe" \
}

The response will contain many fields, which can be found on Swagger, along with the required fields for each endpoint.

For more information on the endpoints please see – API ENDPOINTS

Swagger UI 

Swagger UI displays the documentation in an interactive way to describe request and response parameters of each endpoint. 

https://api.validate.bankersalmanac.com/swagger-ui/index.html 

Validation Call 

Validate the bank details, either with the bank code and account number or by using the IBAN or BBAN. 

For example, for the UK you can submit bank details in the following formats: 

The call will check the details you submit and respond with a status of: 

• PASS 
• CAUTION  
• FAIL  

We always respond with a recommendation for the format of bank code and account number that you entered to make the payment.