Skip to content
Connect API Catalog/
/
/
Single Request

Single Request

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.

Security
bearerToken
Bodyapplication/json
customerNamestringrequired

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

bankAccountstringrequired

Must be numeric and a length of 8 characters

sortCodestringrequired

Must be numeric and a length of 6 characters

accountTypestringrequired

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

secondaryReferencestring

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

customerReferencestring

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

curl -i -X POST \
  https://connect.sandbox.creditsafe.com/v1/localSolutions/GB/bankVerification/search \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "customerName": "string",
    "bankAccount": "string",
    "sortCode": "string",
    "accountType": "string",
    "secondaryReference": "string",
    "customerReference": "string"
  }'

Responses

Bodyapplication/json
supplierRequestDataobject
customerReferencestring

Your Customer reference as described in the requestBody

supplierResponseobject
requestDatetimestring

The date time this request was returned

requestIdstring

A unique reference to your request used for querying the below endpoints where {id} is required

sortCodeDetailsobject(SortCodeCheckResponse)

Provides additional information about the returned sort code. This property is only returned when an additional service line is active. Please contact your account manager for details about availability and enabling this feature.

Response
{
  "supplierRequestData": {
    "customerName": "string",
    "bankAccount": "string",
    "sortCode": "string",
    "accountType": "string",
    "secondaryReference": "string"
  },
  "customerReference": "string",
  "supplierResponse": {
    "customerName": "string",
    "bankAccount": "string",
    "sortCode": "string",
    "returnedCustomerName": "string",
    "result": true,
    "resultText": "string",
    "nameMatchResult": "string",
    "accountTypeResult": true,
    "reasonCode": "string"
  },
  "requestDatetime": "string",
  "requestId": "string",
  "sortCodeDetails": {
    "sortCode": "string",
    "bankName": "string",
    "branchName": "string",
    "address": { … },
    "telephone": "string",
    "bicCode": "string",
    "chapsBicCode": "string",
    "paymentTypes": { … }
  }
}