Batch Bank Validation

cURL

curl --request GET \
  --url https://api.addressy.com/BankAccountValidation/Batch/Validate/v1.00/json6.ws

{
  "Items": [
    {
      "OriginalAccountNumber": "12345678",
      "OriginalSortCode": "112233",
      "IsCorrect": "False",
      "IsDirectDebitCapable": "False",
      "StatusInformation": "UnknownSortCode",
      "CorrectedSortCode": "",
      "CorrectedAccountNumber": "",
      "IBAN": "",
      "Bank": "",
      "BankBIC": "",
      "Branch": "",
      "BranchBIC": "",
      "ContactAddressLine1": "",
      "ContactAddressLine2": "",
      "ContactPostTown": "",
      "ContactPostcode": "",
      "ContactPhone": "",
      "ContactFax": ""
    }
  ]
}

GET

BankAccountValidation

Batch

Validate

v1.00

json6.ws

cURL

curl --request GET \
  --url https://api.addressy.com/BankAccountValidation/Batch/Validate/v1.00/json6.ws

{
  "Items": [
    {
      "OriginalAccountNumber": "12345678",
      "OriginalSortCode": "112233",
      "IsCorrect": "False",
      "IsDirectDebitCapable": "False",
      "StatusInformation": "UnknownSortCode",
      "CorrectedSortCode": "",
      "CorrectedAccountNumber": "",
      "IBAN": "",
      "Bank": "",
      "BankBIC": "",
      "Branch": "",
      "BranchBIC": "",
      "ContactAddressLine1": "",
      "ContactAddressLine2": "",
      "ContactPostTown": "",
      "ContactPostcode": "",
      "ContactPhone": "",
      "ContactFax": ""
    }
  ]
}

This method will consume credit.

We don’t support API connections using HTTP - all calls should use HTTPS.

Query Parameters

Key

string

required

The key to use to authenticate to the service.

AccountNumbers

string[]

required

The bank account number to validate.

SortCodes

string[]

required

The branch sortcode for the account number.

Response

Success

Items

object[]

Show child attributes

Items.OriginalAccountNumber

string

The original AccountNumber passed to validate, excluding any non numeric characters.

Items.OriginalSortCode

string

The original SortCode passed to validate, excluding any non numeric characters.

Items.IsCorrect

boolean

Indicates whether the account number and sortcode are valid.

Items.IsDirectDebitCapable

boolean

Indicates whether the branch associated with this account can accept direct debits.

Items.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).

Items.CorrectedSortCode

string

The correct version of the SortCode. This will be 6 digits long with no hyphens. It may differ from the original sortcode.

Items.CorrectedAccountNumber

string

The correct version of the AccountNumber. This will be 8 digits long and in the form expected for BACs submission.

Items.IBAN

string

The correctly formatted IBAN for the account.

Items.Bank

string

The name of the banking institution.

Items.BankBIC

string

The banking institution's BIC, also know as the SWIFT BIC.

Items.Branch

string

The name of the account holding branch.

Items.BranchBIC

string

The branch's BIC.

Items.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.

Items.ContactAddressLine2

string

Line 2 of the branch's contact address.

Items.ContactPostTown

string

The branch's contact post town.

Items.ContactPostcode

string

The branch's contact postcode.

Items.ContactPhone

string

The branch's contact phone number.

Items.ContactFax

string

The branch's contact fax number.

Individual Phone Validation

Individual Bank Validation

⌘I

Getting started

Endpoints

Batch Bank Validation

Query Parameters

Response