Bank Validation API New!

The JSON API provides capability to verify your customers' UK bank account details, such as the sort code and the account number. It supports CORS and can return data as JSON or JSONP.

Request

https://api.craftyclicks.co.uk/bank/1.1/validate

The service accepts POST / GET requests.

Parameters

Key	Type	Required	Description
key	string	✔️	Your unique access token.
sortCode	string	✔️	The UK bank sort code you want to verify.
accountNumber	string		The UK bank account number you want to verify.

{
	"key":"<<your access token>>",
	"sortCode": "000000",
	"accountNumber": "00000000"
}

Response

Key	Type	Description	Results
general	object	Details of the bank from the sort code.
fullOwningBankName	string	The name of the bank the account belongs to.
subBranchSuffix	string	The suffix of the bank sub branch.
lastChangeDate	string	The date of the last change made to the account.
printIndicator	string	The print indicator.
owningBankCode	string	The code of the bank the account belongs to.
shortBranchTitle	string	The name of the bank account type.
nationalCentralBankCountryCode	string	The national central bank country code.
shortOwningBankName	string	The shortened name of the bank the account belongs to.
bicBranch	string	The BIC branch.
supervisoryBody	string	The supervisory body of the bank.
deletedDate	string	The date the account was deleted.
bicBank	string	The BIC bank.
error	string	Provides a reason, if the input values weren't valid.
sortCode	string	The input sort code.
successful	boolean	Whether the validation process was performed successfully. NOTE : This is the validation process success, not an indication of the validity of the sortcode and account number.	true, false
bankValidate	object	Details of the account number and validation response.
sortCodeListed	boolean	Whether the sort code was present in the EISCD data.	true, false
validationPerformed	boolean	Whether any meaningful modulus checking was performed.	true, false
invalidAccountNumber	boolean	Whether the sort code and account number combination is invalid. 1. It is not possible to determine if an account is genuinely valid. 2. The validation specification from Vocalink dictate that the account is assumed to be potentially valid unless proven otherwise.	true, false
accountNumber	string	The input account number.
sortCode	string	The input sort code.
isCorrect	boolean	Whether the sort code and account number are assumed to be correct.	true, false

{
	"general": {
		"fullOwningBankName": "Santander UK plc",
		"subBranchSuffix": "00",
		"lastChangeDate": "01\/01\/2021",
		"printIndicator": "0",
		"owningBankCode": "0000",
		"shortBranchTitle": "BANK ACCOUNT",
		"nationalCentralBankCountryCode": "",
		"shortOwningBankName": "Santander",
		"bicBranch": "",
		"supervisoryBody": "A",
		"deletedDate": "",
		"bicBank": ""
	},
	"sortCode": "000000",
	"successful": true,
	"bankValidate": {
		"sortCodeListed": true,
		"validationPerformed": true,
		"invalidAccountNumber": false,
		"accountNumber": "00000000",
		"sortCode": "000000",
		"isCorrect": true
	}
}

Bank Validation Process

The flowchart below shows our bank validation process: