Skip to content
Connect API Catalog/
/
/
BBAN Company Search

Creditsafe Connect (1.10.9)

Introduction

This is the full Connect API and contains all available endpoints. For additional information, integration processes, and supplementary documentation, please use the targeted product

The Creditsafe Connect API is a REST API that provides access to the Creditsafe Global Company Database. This allows you to:

  • Control your master data
  • Utilize up-to-date Business and Director information, enhancing your onboarding and qualification processes
  • Receive alerts when your customer's and supplier's Credit Report changes

Quick Start

To start your Creditsafe Connect API integration you will need to have activated your account and set a password by following the instructions in your Welcome Email. If you have not received a Welcome Email please contact your Creditsafe Account Manager.

By default, you will have been setup on our Sandbox environment.

Using a REST API client construct an /authenticate POST request and enter your username & password (case-sensitive) into the POST body. A successful response will return an authentication token.

Use the authentication token in an Authorization header on all other Creditsafe Connect calls as proof of your authenticity.

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

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

Production server

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

Authentication

Endpoints for user authentication into the Connect API.

Operations

User Administration

Endpoints for user management.

Operations

Instance Management

Endpoints for managing decision engine instances, including retrieval, and updating.

Operations

Decision Trees

Endpoints for accessing and managing pre-configured decision trees used for automated credit decisions.

Operations

Decision Logs

Endpoints for retrieving and managing logs of past decisions.

Operations

Run Decision

Endpoints for executing decision trees to automate credit decisions.

Operations

Decision Outcome

Endpoints for retrieving the outcomes of executed decisions, including detailed results.

Operations

Bank Match

Bank Match provides a secure and efficient way to verify and match company and personal bank account details using IBAN or BBAN formats. This API supports compliance, fraud prevention, and onboarding processes by enabling you to validate bank account information for both companies and individuals.

Operations

IBAN Company Search

Request

Gets search for bankmatch IBAN company matching

Security
bearerToken
Query
countrystringrequired

An ISO Alpha-2 country code of the company

languagestring= 2 characters

The language code to specify the desired language of the response. Please use the /IBAN/company/searchCriteria endpoint to confirm available languages. If unsupported language is passed, the system defaults to English (EN).

bankCountrystring

An ISO Alpha-2 country code used to specify the country for company bank matching criteria

regNostring

Company registration number for bank matching criteria

ibanstring

International Bank Account Number (IBAN) for bank matching criteria

curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/compliance/bankMatch/IBAN/company?country=string&language=st&bankCountry=string&regNo=string&iban=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
idstring

Unique identifier for the bank match search.

classificationstring

Classification result of the search (e.g., 'NO').

statusstring

Status of the search process (e.g., 'SUCCEEDED').

entityobject

Contains details about the entity associated with the IBAN.

inputobject

Input details used for the search.

reasonsArray of strings

List of reason codes for the result.

sepamailVerificationStatusstring

Status of the SepaMail verification.

reasonLabelsobject

Labels describing the reasons for the result.

lastMatchVerificationDetailobject

Details about the last match verification.

Response
application/json
{
  "id": "string",
  "classification": "string",
  "status": "string",
  "entity": {
    "paymentIdentity": { … },
    "company": { … }
  },
  "input": {
    "paymentIdentity": { … },
    "company": { … }
  },
  "reasons": [
    "string"
  ],
  "sepamailVerificationStatus": "string",
  "reasonLabels": {
    "property1": "string",
    "property2": "string"
  },
  "lastMatchVerificationDetail": {
    "status": "string",
    "date": "2019-08-24T14:15:22Z",
    "additionalData": {}
  }
}

BBAN Company Search

Request

Gets search for bankmatch BBAN company matching

Security
bearerToken
Query
countrystringrequired

An ISO Alpha-2 country code of the company

languagestring= 2 characters

The language code to specify the desired language of the response. Please use the /BBAN/company/searchCriteria endpoint to confirm available languages. If unsupported language is passed, the system defaults to English (EN).

bankCountrystringrequired

An ISO Alpha-2 country code used to specify the country for company bank matching criteria

regNostring

Registration number of the company for bank matching criteria

bbanstring

Basic Bank Account Number (BBAN) for bank matching criteria

bicstring

Bank Identifier Code (BIC) for BBAN company matching

routingCodestring

Routing code for BBAN company matching

curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/compliance/bankMatch/BBAN/company?country=string&language=st&bankCountry=string&regNo=string&bban=string&bic=string&routingCode=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
idstring

Unique identifier for the bank match search.

classificationstring

Classification result of the search (e.g., 'NO').

statusstring

Status of the search process (e.g., 'SUCCEEDED').

entityobject

Contains details about the entity associated with the BBAN.

inputobject

Input details used for the search.

reasonsArray of strings

List of reason codes for the result.

sepamailVerificationStatusstring

Status of the SepaMail verification.

reasonLabelsobject

Labels describing the reasons for the result.

Response
application/json
{
  "id": "string",
  "classification": "string",
  "status": "string",
  "entity": {
    "paymentIdentity": { … },
    "company": { … }
  },
  "input": {
    "paymentIdentity": { … },
    "company": { … }
  },
  "reasons": [
    "string"
  ],
  "sepamailVerificationStatus": "string",
  "reasonLabels": {
    "property1": "string",
    "property2": "string"
  }
}

IBAN Person Search

Request

Gets search for bankmatch IBAN person matching

Security
bearerToken
Query
languagestring= 2 characters

The language code to specify the desired language of the response. Please use the /IBAN/person/searchCriteria endpoint to confirm available languages. If unsupported language is passed, the system defaults to English (EN).

bankCountrystringrequired

An ISO Alpha-2 country code used to specify the country for person bank matching criteria

firstNamestring

First name of the person for bank matching criteria

lastNamestring

Last name of the person for bank matching criteria

birthDatestring

Birth date of the person in the format DD/MM/YYYY for bank matching criteria

Example: birthDate=28/04/1978
ibanstring

International Bank Account Number (IBAN) for bank matching criteria

curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/compliance/bankMatch/IBAN/person?language=st&bankCountry=string&firstName=string&lastName=string&birthDate=28%2F04%2F1978&iban=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
idstring

Unique identifier for the bank match search.

classificationstring

Classification result of the search (e.g., 'NO').

statusstring

Status of the search process (e.g., 'SUCCEEDED').

entityobject

Contains details about the entity associated with the IBAN.

inputobject

Input details used for the search.

reasonsArray of strings

List of reason codes for the result.

sepamailVerificationStatusstring

Status of the SepaMail verification.

reasonLabelsobject

Labels describing the reasons for the result.

lastMatchVerificationDetailobject

Details about the last match verification.

Response
application/json
{
  "id": "string",
  "classification": "string",
  "status": "string",
  "entity": {
    "paymentIdentity": { … },
    "company": { … }
  },
  "input": {
    "paymentIdentity": { … },
    "physicalPersonIdentifier": { … }
  },
  "reasons": [
    "string"
  ],
  "sepamailVerificationStatus": "string",
  "reasonLabels": {
    "property1": "string",
    "property2": "string"
  },
  "lastMatchVerificationDetail": {
    "status": "string",
    "date": "2019-08-24T14:15:22Z",
    "additionalData": {}
  }
}

Search And Report Schemas/Criteria

Operations

Companies

Endpoints to search for Companies in the Creditsafe Global Company Database. Companies are uniquely identified by the connectId - the identifier used to order a Company Credit Report. The Company Credit Report is a JSON object comprising of key business and financial data points such as Credit Score & Limit, Industry Code, Directors, Balance Sheet and Negative Information. A full list of Company data points can be found in the Data Matrix, in the help resources.

Order a Company Credit Report

Operations

People/Directors

Endpoints to find People/Directors and order Director Reports. A Director Report will contain a person's registered information and Active & Previous Directorships, where available. This endpoint is not advised to get a list of directors for a specific Company. Instead, order a Company Credit Report using the Companies Report Endpoint, and use the directors section in the report response.

Operations

GB Consumers and AML

Operations

Images

Endpoints to order official Company Image/Filing Documents from

source. Company Filings such as Annual Account Statements, Annual Returns,

Liquidations and Changes of Registered Information can be downloaded as

PDFs, and are typically used as a resource in extended company

auditing/compliance.

Operations

Fresh Investigations

Endpoints to manage Fresh Investigation requests. With the need for accurate data, you can check on any company that is not available within our instant online database by placing a Fresh Investigation (Offline Order). Depending on the market, the information we obtain will vary. Using official sources and registries we are able to quickly answer questions about a company's stability and financial health. Where official information is not available we will conduct a direct interview with the business.

Operations

Create and View All Jobs

Create a Data Cleaning job and view all jobs in the system.

Operations

Individual Job Management

Manage individual Data Cleaning jobs. Including updating required mappings and enrichment processes.

Operations

User Details

Operations

Create and View All Portfolios

Operations

Importing Portfolios

Operations

User Management of Portfolios

Operations

Individual Portfolio Management

Operations

Event Rules and Notifications

Operations

Administrator Resources

Operations

Audit

Operations

Profile Management

Operations

Profile Updates

Operations

Profile Key Parties

Operations

Batch Uploads

Operations

Profile Business / Individual Details

Operations

AML Screening - Profile Management

Operations

AML Screening - Businesses

Operations

AML Screening - Individuals

Operations

AML Bulk Screening

Operations

AML Monitoring Management

Operations

Async AML

Operations

Global Monitoring

Operations

Reporting

Operations

GB Bank Match

Operations

GB Bank Verification

Operations

GB Land Registry

Operations

GB Finance Agreements

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

US Search Support

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

Audit (Legacy)

Operations

IDV (Legacy)

Operations

Consumers

Update this description.

Operations