Skip to content
Connect API Catalog/
/GB Finance Agreements/
Request Finance Agreement...

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

GB Finance Agreements

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

Operations

Request Finance Agreements

Request

This tool provides a detailed view of data supplied via the CCDS scheme(Commercial Credit Data Sharing ). It's tailored for users needing immediate access to current and accurate financial agreement information, enhancing decision-making with up-to-date data insights.

1. Full CCDS Access - Gain in-depth insights with access to up to 48 months of historical data on current accounts, loans, and credit card facilities. This tool is perfect for comprehensive long-term financial analysis, offering a thorough understanding of credit history and trends.

2. Financial Footprint - Get a summarized view of non performance related credit activity data. This tool simplifies the complex data into an easily understandable summary, ideal for quick assessments and initial screenings.

3. Finance Performance Indicator - A predictive tool that evaluates the likelihood of a company defaulting on payments within the next 90 days. This tool is crucial for risk assessment and mitigation, offering foresight and preparation for potential financial challenges.

Security
bearerToken
Path
companyIdstringrequired

The connectId or safeNumber of the company

Example: GB-0-X9999999
Query
excludeCutOffDateboolean
Default false
curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/localSolutions/GB/CCDS/GB-0-X9999999?excludeCutOffDate=false' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful response

Bodyapplication/json
One of:
correlationIdstring

A unique ID assigned to this request.

safeNumberstring

Safe Number - Identifier for Companies in Creditsafe's Home Countries.

Example: "UK08368892"
creditSafeobject
overallAggregationsobject

A summarisation of the companies account details.

Example: {"totalAccounts":-1,"totalBalance":0,"totalOverdraftOrCreditLimit":0,"remainingBalance":0,"totalAverageBalance":0}
historyArray of objects(ConnectCcdsHistory)

List of accounts connected to the company, snapshot of account at point in time each month.

Example: [{"businessTypeIndicator":"L","businessName":"POTS & CO LTD","businessAddress":{"line1":"UNIT 3&7 DAN HOUSE","line2":"ELVEDEN ROAD","line3":"LONDON","line4":"","line5":"","line6":"","postcode":"NW10 7ST"},"additionalTradingStyle":null,"businessTelephoneNumber":null,"companyRegistrationNumber":null,"vatNumber":null,"specialInstructionIndicator":null,"startDateOfAgreement":"2017-05-15T00:00:00","currentBalance":0,"currentBalanceCreditIndicator":null,"actualCurrentBalance":0,"facilityStatus":"0","originalDefaultBalance":0,"creditOrOverdraftLimit":0,"flagSettings":"","transferredToConsolidatedDebtAccount":null,"repaymentPeriod":0,"paymentAmount":0,"paymentFrequencyIndicator":null,"numberOfCashAdvances":0,"valueOfCashAdvances":0,"minimumBalance":0,"minimumBalanceCreditIndicator":null,"actualMinimumBalance":0,"maximumBalance":0,"maximumBalanceCreditIndicator":null,"actualMaximumBalance":0,"averageBalance":0,"averageBalanceCreditIndicator":null,"actualAverageBalance":0,"creditTurnover":0,"creditTurnoverNetOrGrossIndicator":null,"debitTurnover":0,"debitTurnoverNetOrGrossIndicator":null,"rejectedPayments":0,"maximumDurationOfExcess":0,"currentAccountReportingLevelIndicator":null,"facilityType":"01","facilityTypeCategory":"LOAN","batchDate":"20220131","date":"20220131","facilityId":"baffec1bd22b1f30ec6ebce04c9c1ad158d7fce6c9f693c53f880b5db631dd9a"}]
footprintDataobject

A version of a summarisation of companies account details which omits any sensitive data and can be shown to non-CCDS members.

Example: {"2023":{"10":{"loans":{"ActiveAccounts":10,"SettledAccounts":1,"EarliestStartDate":"2016-08-17T00:00:00","LatestStartDate":"2019-09-18T00:00:00"},"currentAccounts":{"ActiveAccounts":1,"SettledAccounts":0,"EarliestStartDate":"2012-07-03T00:00:00","LatestStartDate":"2012-07-03T00:00:00"},"all":{"activeAccounts":11,"settledAccounts":1,"earliestStartDate":"2012-07-03T00:00:00","latestStartDate":"2019-09-18T00:00:00"},"creditCards":{"activeAccounts":0,"settledAccounts":0}},"11":{"loans":{"ActiveAccounts":1,"SettledAccounts":0,"EarliestStartDate":"2012-07-03T00:00:00","LatestStartDate":"2012-07-03T00:00:00"},"currentAccounts":{"ActiveAccounts":1,"SettledAccounts":0,"EarliestStartDate":"2012-07-03T00:00:00","LatestStartDate":"2012-07-03T00:00:00"},"all":{"activeAccounts":1,"settledAccounts":1,"earliestStartDate":"2012-07-03T00:00:00","latestStartDate":"2019-09-18T00:00:00"},"creditCards":{"activeAccounts":0,"settledAccounts":0}}}}
indicatorDataobject
Example: {"2023":{"10":{"30_day_pod":0,"30_day_indicator":0,"60_day_pod":0,"60_day_indicator":0,"90_day_pod":0,"90_day_indicator":0},"11":{"30_day_pod":0,"30_day_indicator":0,"60_day_pod":0,"60_day_indicator":0,"90_day_pod":0,"90_day_indicator":0}}}
Response
application/json
{
  "correlationId": "string",
  "safeNumber": "UK08368892",
  "creditSafe": {
    "creditSafeCompanyId": "NI008172"
  },
  "overallAggregations": {
    "totalAccounts": -1,
    "totalBalance": 0,
    "totalOverdraftOrCreditLimit": 0,
    "remainingBalance": 0,
    "totalAverageBalance": 0
  },
  "history": [
    { … }
  ],
  "footprintData": {
    "2023": { … }
  },
  "indicatorData": {
    "2023": { … }
  }
}

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