v4

latestSwagger 2.02026-08-033766226.9 KB

BankAccounts

Verifies bank account details.

post/api/bank-accounts/verify

Headers

apikeystring required

ApiKey supplied.

Request body

regEntryIdstring uuid required

Example request

{
  "address": {
    "addressLine1": "10 Downing St",
    "addressLine2": "Westminster",
    "addressLine3": null,
    "city": "London",
    "postcode": "SW1A2AA",
    "county": null,
    "country": "United Kingdom"
  },
  "person": {
    "forename": "Angela",
    "middleName": null,
    "surname": "UK Specimen"
  },
  "accountDetails": {
    "sortcode": "123456",
    "accountNumber": "12345678"
  },
  "regEntryId": "141dbb24-c4ff-4658-9556-15ea25428d48"
}

Response

Success

checkIdstring uuid

checkDatestring date-time

sortcodestring

accountNumberstring

referenceIdstring

errorboolean

accountValidboolean

sortcodeValidation0 | 1 | 2 | 3 | 4

Unknown = 0, NoMatch = 1, Valid = 2, Invalid = 3, FiveDigitsMatched = 4

sortcodeValidationTextstring

accountNumberValidation0 | 1 | 2 | 3 | 4 | 5

Unknown = 0, NoMatch = 1, Valid = 2, Invalid = 3, SevenDigitsMatched = 4, SixDigitsMatched = 5

accountNumberValidationTextstring

nameValidation0 | 1 | 2

Unknown = 0, NoMatch = 1, Valid = 2

nameValidationTextstring

addressValidation0 | 1 | 2 | 3 | 4

Unknown = 0, NoMatch = 1, CurrentAddress = 2, PreviousAddress = 3, ForwardingAddress = 4

addressValidationTextstring

accountStatus0 | 1 | 2 | 3

Unknown = 0, NoMatch = 1, Live = 2, ClosedOrSettled = 3

accountStatusTextstring

checkStatus0 | 1 | 2 | 3

Unknown = 0, Pass = 1, Refer = 2, Fail = 3

hasBeenOverriddenboolean

Forenamestring

MiddleNamestring

Surnamestring

Address1string

Citystring

PostCodestring

All 37 operations