Single Request

This endpoint will perform a search with the supplied data against a bank or building society.

NOTE:- This endpoint will charge when a successful request is made to a bank or building society. This endpoint will charge when a result is returned. This includes charging if the no match is found.

All property fields need to be submitted with the request, if information for a specific property is not needed, it is required to pass an empty string.

SecuritybearerToken
Request
Request Body schema: application/json
customerName
required
string

This field is for the name on the account you are matching against with the bankAccount, sortCode and secondaryReference fields

bankAccount
required
string

Must be numeric and a length of 8 characters

sortCode
required
string

Must be numeric and a length of 6 characters

accountType
required
string

field must be either Business or Personal, it can not be blank or any other value

secondaryReference
string

Should not be used unless you have been advised to use this by a bank or building society
This field will affect the results data

customerReference
string

Field is for text input and does not affect the search result
This field can be used for filtering your past results at a later date

Responses
200
400
401
post/localSolutions/GB/bankVerification/search
Request samples
application/json
{
  • "customerName": "string",
  • "bankAccount": "string",
  • "sortCode": "string",
  • "accountType": "string",
  • "secondaryReference": "string",
  • "customerReference": "string"
}
Response samples
application/json
{
  • "supplierRequestData": {
    },
  • "customerReference": "string",
  • "supplierResponse": {
    },
  • "requestDatetime": "string",
  • "requestId": "string"
}
➔ Next to Validate Bank Verification Request