BankAccountValidation Interactive Validate (v2.00)

Validates the bank account and sort code for an UK bank account are correct. Returns details of the holding branch, IBAN and correct BACS account details.
Now includes faster payments and CHAPs availability information. We strongly recommend using HTTPS for these web services to ensure the information transmitted is secured.

Samples

Choose a sample

Select an end point

Try it

Enter your values in the form below to try the service for yourself. We've put some example values in already to get you started.

Name Value Type Default Description
AccountNumber * String The bank account number to validate.
SortCode * String The branch sort code for the account number.

Parameters

Each request to the web service requires a number of parameters, all of which are listed below. All requests require a key which was generated when you registered. You can create any number of keys, each of which can be reported on individually and have specific security settings.

Name Type Description Default Example
Key * String The key to use to authenticate to the service. AA11-AA11-AA11-AA11
AccountNumber * String The bank account number to validate. 12345678
SortCode * String The branch sort code for the account number. 00-00-99

Fields

The response from the web service is a table with the specification below. Where no items are found, the response will be empty (although all endpoints specify the columns). If an error occurs, the response will not follow this format. Instead the response will be an error table (see general and specific errors).

Name Type Description Values Example
IsCorrect Boolean Indicates whether the account number a sortcode are valid.
False
IsDirectDebitCapable Boolean Indicates whether the account can accept direct debits. Certain accounts (e.g. savings) will not accept direct debits.
False
StatusInformation String More detail about the outcome of the validation process. Describes reasons validation failed or changes made to pass validation. DetailsChanged indicates that the account and sortcode should be changed for BACs submission (check CorrectedAccountNumber and CorrectedSortCode). CautiousOK is set where the sortcode exists but no validation rules are set for the bank (very rare).
  • None
  • UnknownSortCode
  • InvalidAccountNumber
  • OK
  • CautiousOK
  • DetailsChanged
UnknownSortCode
CorrectedSortCode String The correct version of the SortCode. This will be 6 digits long with no hyphens. It may differ from the original sortcode.
CorrectedAccountNumber String The correct version of the AccountNumber. This will be 8 digits long and in the form expected for BACs submission.
IBAN String The correctly formatted IBAN for the account.
Bank String The name of the banking institution.
BankBIC String The banking institution's BIC, also know as the SWIFT BIC.
Branch String The name of the account holding branch.
BranchBIC String The branch's BIC.
ContactAddressLine1 String Line 1 of the branch's contact address. NB: This is the address to be used for BACs enquiries and may be a contact centre rather than the branch's address.
ContactAddressLine2 String Line 2 of the branch's contact address.
ContactPostTown String The branch's contact post town.
ContactPostcode String The branch's contact postcode.
ContactPhone String The branch's contact phone number.
ContactFax String The branch's contact fax number.
FasterPaymentsSupported Boolean Indicates that the account supports the faster payments service.
CHAPSSupported Boolean Indicates that the account supports the CHAPS service.

Response Errors

Below are the errors which are specific to this web service (more general errors are listed below). If an error occurs, an error table like the one below will be returned (developers should test for a 4 column table with columns "Error", "Description", "Cause" and "Resolution". An error response will only contain a single row.

ID Error Cause Resolution
1001 SortCode Required The SortCode parameter was not supplied. Please ensure that you supply the SortCode parameter and try again.
1002 SortCode Invalid The SortCode parameter was not valid. The SortCode parameter should be 6 digits in the form 00-00-00 or 000000. It should be prefixed with leading 0s if necessary.
1003 AccountNumber Required The AccountNumber parameter was not supplied. Please ensure that you supply the AccountNumber parameter and try again.
1004 AccountNumber Invalid The AccountNumber parameter was not valid. The AccountNumber parameter should contain only numbers. Account numbers must be between 6-10 digits long.

General Errors

These errors are general service errors and may be returned by any web service. Note that general errors are all below 100 while service specific errors start at 1000.

ID Error Cause Resolution
-1 Unknown error The cause of the error is unknown but details have been passed to our support staff who will investigate. These problems are typically short lived and are often resolved by trying again in a few minutes.
2 Unknown key The key you are using to access the service was not found. Please check that the key is correct. It should be in the form AA11-AA11-AA11-AA11.
3 Account out of credit Your account is either out of credit or has insufficient credit to service this request. Please check your account balance and top it up if necessary.
4 Request not allowed from this IP The request was disallowed from the IP address. Check the security settings on the key first. If they look fine, please contact support as it may be from an IP address on our blacklist.
5 Request not allowed from this URL The request was disallowed from the URL. Check the security settings on the key first. If they look fine, please contact support as it may be from a URL on our blacklist.
6 Web service not available on this key The requested web service is disallowed on this key. Check the security settings on the key first. You can limit a key to certain web services.
7 Web service not available on your plan The requested web service is not currently available on your payment plan. Some services are only available in specific regions due to licensing restrictions. Please contact us for more information.
8 Key daily limit exceeded The daily limit on the key has been exceeded. Alter the daily limit on the key. Check the usage details first to see if usage is normal.
9 Surge protector running The surge protector is currently enabled and has temporarily suspended access to the account. You can disable the surge protector at any time, but this is only recommended if you are running through a batch of requests.
10 Surge protector triggered An unusually large number of requests have been processed for your account so the surge protector has been enabled. You can disable the surge protector at any time but this is only recommended if you are running through a batch of requests.
11 No valid license available The request requires a valid license but none were found. Please check your purchase history. You may be using a license that is no longer valid or of an incorrect type.
12 Management key required To use this web service you require a management key. Management can be enabled on any key, but we advise you to use management keys with care. Sign in to the website and create a new management key or change an existing key.
13 Demo limit exceeded The daily demonstration limit for this service or account has been exceeded. The limit will be reset at midnight tonight. If you would like the limit increased, please contact us.
14 Free service limit exceeded You have used too many free web services. Our web services are designed to operate in stages. The first is usually a Find service followed by a Retrieve. If you use too many Finds without the corresponding number of Retrieves you will receive this error. For more information, please contact us.
15 Wrong type of key The type of key you're using isn't supported by this web service. This usually happens if you're using a user or server license with a web service that only supports transactional keys. Please use another key and try again.
16 Key expired The key you are trying to use has expired. Please check that you are using the right key. A new one may have been issued if you recently renewed your key. Contact us if you have any questions.
17 Key daily limit exceeded The daily limit on the key has been exceeded. Alter the daily limit on the key. Check the usage details first to see if usage is normal.