Skip to content
Connect API Catalog/Creditsafe Connect/
/GB Bank Match

GB Bank Match

This endpoint provides tools for matching business bank account information in Great Britain.

Operations

Bank Match

Request

The Bank Verification tool allows customers to instantly verify that small and medium sized companies you are working with are providing correct bank details, to reduce fraud and avoid delays in your on boarding process. The bank data for these companies is provided to Creditsafe by various financial providers, including major banks. When you provide us with a company number and their bank details, we are able to perform instant checks to verify that those bank details are associated with that company and return -
Match – We have bank information on the company, and the data provided by the customer matches the company records
No Match – We have bank information on the company, but the data provided does not match any of the company records
Data Unavailable - We do not have bank information on the company.

Security
bearerToken
Query
checkTypeanyrequired

Validation uses an algorithm to determine if a SCAN or IBAN exists, but does not let you know if that SCAN or IBAN actually belongs to the company who has provided it. Verification takes this a step further and checks the Creditsafe database for a match on the SCAN/IBAN, and tells you if the bank details actually belong to the company, so you can be assured that you are sending your money to the correct entity.

Enum:"Both""Validate""Verify"
companyIdstringrequired

The connectId or safeNumber of the company to check against.

Example:companyId=GB-0-X9999999
sortCodestring

Sort Code to check - Must be passed in with Account Number to form a SCAN Result

Example:sortCode=089997
accountNumberstring

Account Number to check - Must be passed in with Sort Code to form a SCAN Result

Example:accountNumber=66374958
ibanstring

IBAN to check

Example:iban=GB55TEST08999966374957
vatNumberstring

VAT Number to check

curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/localSolutions/GB/bankmatch?checkType=Both&companyId=GB-0-X9999999&sortCode=089997&accountNumber=66374958&iban=GB55TEST08999966374957&vatNumber=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Indicates the check has been made successfully and contains the result of the Verification/Validation. A 200 response alone does not immediately indicate the bank account is valid, only that the check was made in the correct format. Check the SCAN text and IBAN text fields for the result of the Check.

Bodyapplication/json
totalSizeinteger
Example:1
bankMatchResultsArray of objects
Response
{
  "totalSize": 1,
  "bankMatchResults": [
    { … }
  ]
}