Bottomline PTX
API docs by Redocly

Account Verification (1.0.0)

Download OpenAPI specification:

Introduction

The CoP for Business API allows you to perform account and name verification for UK consumer and business bank and building society accounts.


URLs

Customer acceptance testing

Live

CoP for Business

Verify UK Bank Account

Verifies a UK bank account.

Example data to be used on CAT system

Note: On the live system the reason 'Sort code not supported at endpoint' may be returned but cannnot be tested on CAT.

checkTypesortCodeaccountNumbernameaccountTypesecondaryIdentifierReason
Payee99999600000001Miss Samantha SmythePersonalAccount name matches
Payee99999600000011Bridgford GardeningBusinessAccount name matches
Payee99999600000001Mr David SmythePersonalAccount name does not match
Payee99999600000001Miss Sam SmythePersonalThere may be a match on the account name
Payee99999600000011Bridgford GardeningPersonalBusiness account, name matches
Payee99999600000001Miss Samantha SmytheBusinessPersonal account, name matches
Payee99999600000011Pridgford GardeningPersonalBusiness account, name may be a match
Payee99999600000001Miss Sam SmytheBusinessPersonal account, name may be a match
Payee99999698989898Miss Samantha SmythePersonalIncorrect account number
Payee62325400000000Jane JonesPersonalABC123456Invalid customer reference
Payee99999600000062Not SupportedPersonalAccount type not supported for CoP
Payee99999600000048Johnson LogisticsBusinessOpted out of CoP Scheme
Payee99999600000016Switched AccountPersonalAccount has been switched
Payee99999700000001Miss Samantha SmythePersonalInvalid SortCode MI Reference:474
Payee900000001Miss Samantha SmythePersonalSortcode must be a 6 digit number
Payee00000001Miss Samantha SmythePersonal'sortCode' must not be empty.
Payee999996A0000001Miss Samantha SmythePersonalAccount number must be an 8 digit number
Payee999996Miss Samantha SmythePersonal'accountNumber' must not be empty.
Payee99999600000001Personal'name' must not be empty.
Payee99999600000001Miss Samantha Smythe'accountType' must not be empty.
99999600000001Miss Samantha SmythePersonal'checkType' must not be empty.
Payee99999600000001Miss Samantha SmythePersonal'secondaryIdentifier' must not be empty.
Payee16505000000001471 TestBusinessRequested account provider is not a CoP Participant and DCR is not possible. MI Reference:471

Authorizations:
Authorisation Code
header Parameters
x-correlation-id
string
Example: d2cb7c7f-e2b4-49eb-b88c-08a3d36964e6

Request unique identifier, related transaction GUID

Request Body schema: application/json
required
checkType
required
string
Enum: "Payee" "Payer"

Specifies the type of check (payee or payer).

sortCode
required
string = 6 characters ^[0-9]{6}$

6 digit sort code, hyphens not included.

accountNumber
required
string = 8 characters ^[0-9]{8}$

8 digit account number.

name
required
string [ 1 .. 140 ] characters ^.{1, 140}$

Name to be be validated.

accountType
required
string
Enum: "Business" "Personal"

Specifies the type of account (business or personal).

secondaryIdentifier
string [ 0 .. 140 ] characters ^.{1, 140}$

Optional identifier assigned by an institution to identify an account. This identifier is known by the account owner, e.g. roll number. This should not be sent if there is no data for the property.

Responses

Request samples

Content type
application/json
{
  • "checkType": "Payee",
  • "sortCode": "999996",
  • "accountNumber": "00000001",
  • "name": "MISS SAMANTHA SMYTHE",
  • "accountType": "Personal",
  • "secondaryIdentifier": ""
}

Response samples

Content type
application/json
{
  • "match": true,
  • "originalName": "Miss Samantha Smythe",
  • "name": "",
  • "reasonCode": "",
  • "reason": ""
}