Skip to content
Connect API Catalog/Local Solutions/
/GB Bank Verification

Local Solutions (1.0.1)

Introduction

The Local Solutions API provides a suite of specialized endpoints designed to address region-specific business needs across multiple countries. It enables users to access a variety of local data services, such as land registry information, bank account verification, consumer and anti-money laundering checks, and company searches tailored to local requirements. The API supports operations in several regions, including Great Britain, France, Germany, the Netherlands, and the United States, offering targeted solutions for each market.

With secure authentication and a modular structure, Local Solutions allows businesses to integrate local compliance, verification, and data enrichment processes into their workflows efficiently.

The list of supported regions is always expanding and will not be limited to those currently available.

Download OpenAPI description
localSolutions.json
localSolutions.yaml
Languages
Servers
Sandbox server

https://connect.sandbox.creditsafe.com/v1/

Production server

https://connect.creditsafe.com/v1/

Authentication

This endpoint generates a Bearer JWT (Authentication Token), which is essential for accessing all other endpoints within the API.

To authenticate your requests, you MUST include this token in the Authorization header as proof of authenticity.

Please note that each token remains valid for 1 hour from the time of issuance and multiple tokens may exist concurrently. It is imperative to obtain and include a valid token in the Authorization header for every subsequent request made to the API.

Authenticate Help - Access Denied..

Operations

FR Bank Match

This endpoint provides tools for matching bank information in France.

Operations

DE NonLtd Companies

This endpoint provides the tools for searching non-limited companies in Germany and acquiring company reports.

Operations

NL KVK Extract

This endpoint provides tools for extracting information from the Dutch Chamber of Commerce (KVK).

Operations

GB Bank Match

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

Operations

GB Consumers and AML

This endpoint provides tools for consumer and anti-money laundering checks in Great Britain.

Operations

GB Bank Verification

This endpoint provides tools for verifying bank account information for individuals in Great Britain.

Operations

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
application/json
{
  "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": { … }
  }
}

Validate Bank Verification Request

Request

This endpoint will return whether the sort code and bank account number match the sort code and bank account number that was provided for the given single request.

Note:- A valid request requires all fields to exist in the request.

Security
bearerToken
Path
idstringrequired

request id to fetch details

Bodyapplication/json
bankAccountstringrequired

The bank account number you would like to check matches the bank account number you queried with the the supplier when making the request with request-id

sortCodestringrequired

The sort code you would like to check matches the sort code you queried with the the supplier when making the request with request-id

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

Responses

Bodyapplication/json
isValidboolean

The result of this endpoint is not a match result and is not indicative of whether the suppliers result. As such:-
This endpoint can return isValid as true for a No Match result.
This endpoint can return isValid as false for a Match result.

Response
application/json
{
  "isValid": true
}

Return Bank Branch Details Of A Given Sort Code

Request

This endpoint will return bank branch details of a given sort code.

Security
bearerToken
Path
idstringrequired

The sort code id of the bank branch.

curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/localSolutions/GB/bankVerification/sortCode/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/jsonArray [
sortCodestring

The sorting code of the bank office.

bankNamestring

The full name of the owning bank.

branchNamestring

The full bank office title.

addressobject
telephonestring

The telephone number of the bank office.

bicCodestring

The Bank Identifier Code (BIC) for the bank office.

chapsBicCodestring

A CHAPS BIC code refers to the Bank Identifier Code (BIC) of a financial institution that is a participant in the CHAPS payment system in the United Kingdom.

paymentTypesobject
]
Response
application/json
[
  {
    "sortCode": "string",
    "bankName": "string",
    "branchName": "string",
    "address": { … },
    "telephone": "string",
    "bicCode": "string",
    "chapsBicCode": "string",
    "paymentTypes": { … }
  }
]

GB Finance Agreements

This endpoint provides tools for acquiring and verifying finance agreement information.

Operations

GB Land Registry

This endpoint provides tools for accessing land registry information in Great Britain.

Operations

Verify

Verify is an exclusive add-on to Creditsafe's company credit reports, designed to assist businesses in making smarter, quicker, and more informed credit decisions. For new or small companies that lack a detailed financial footprint, Verify offers unparalleled insights by screening company directors and the individuals behind businesses for their personal financial stability and identity.

Using Verify, you can confidently assess a company's leadership, using trusted public datasets that highlight potential financial concerns, such as CCJs or Insolvencies and confirm that they reside at an address on the Electoral roll.

Operations

US Search Support

This endpoint provides support for searching in the United States for companies not immediately available in the Creditsafe database.

Operations