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 CORSopen in new window 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

KeyTypeRequiredDescription
keystring✔️Your unique access token.
sortCodestring✔️The UK bank sort code you want to verify.
accountNumberstringThe UK bank account number you want to verify.
{
	"key":"<<your access token>>",
	"sortCode": "000000",
	"accountNumber": "00000000"
}

Response

KeyTypeDescription
generalobjectDetails of the bank from the sort code.
fullOwningBankNamestringThe name of the bank the account belongs to.
subBranchSuffixstringThe suffix of the bank sub branch.
lastChangeDatestringThe date of the last change made to the account.
printIndicatorstringThe print indicator.
owningBankCodestringThe code of the bank the account belongs to.
shortBranchTitlestringThe name of the bank account type.
nationalCentralBankCountryCodestringThe national central bank country code.
shortOwningBankNamestringThe shortened name of the bank the account belongs to.
bicBranchstringThe BIC branch.
supervisoryBodystringThe supervisory body of the bank.
deletedDatestringThe date the account was deleted.
bicBankstringThe BIC bank.
errorstringProvides a reason, if the input values weren't valid.
sortCodestringThe input sort code.
successfulbooleanIf the value is TRUE, the validation was performed successfully.
bankValidateobjectDetails of the account number and validation response.
sortCodeListedbooleanIf the value is TRUE, the sort code is listed.
validationPerformedbooleanIf the value is TRUE, the validation was performed successfully.
invalidAccountNumberbooleanIf the value is TRUE, the provided account number does not match the sort code.
accountNumberstringThe input account number.
sortCodestringThe input sort code.
isCorrectbooleanIf the value is TRUE, the provided bank details are correct.
{
	"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
	}
}