New!
Bank Validation APIThe 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 |
---|---|---|
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 | If the value is TRUE, the validation was performed successfully. |
bankValidate | object | Details of the account number and validation response. |
sortCodeListed | boolean | If the value is TRUE, the sort code is listed. |
validationPerformed | boolean | If the value is TRUE, the validation was performed successfully. |
invalidAccountNumber | boolean | If the value is TRUE, the provided account number does not match the sort code. |
accountNumber | string | The input account number. |
sortCode | string | The input sort code. |
isCorrect | boolean | If 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
}
}