Skip to content
Connect API Catalog/Local Solutions/
/Verify

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

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

Company Search

Request

Endpoint to search for Companies according to the provided Search Criteria. To get the most relevant results, it is recommended to use a unique identifier such as regNo where available. If a unique identifier is not available, use a combination of the companies registered postCode and name for the next best hit rate.

Security
bearerToken
Query
pageinteger

Starting page number.

Default 1
pageSizeinteger

Specifies the number of items to be displayed per page. Allowed values are between 1 and 100.

countriesstring(CreditsafeGlobalDataCountryCode)required

comma-separated list of iso-2 country codes.
The code PLC can be used here to search for companies of this type across all countries.

Enum"AF""AX""AL""DZ""AS""AD""AO""AI""AQ""AG"
Example: countries=GB,FR
languagestring or null= 2 characters

Only used for Countries where more than one Company Name exists for different languages e.g. Japanese Kanji and English.
Country - Languages Available
Japan [JP] - EN & JA

Default null
idstring or null

connectId - The primary Company identifier that is used to uniquely identify all companies across Creditsafe's Universe and Partner Network. This is returned on all Company Search Results. Use this field to use in other operations such as Ordering Company Credit Report by Id, and Adding Company to Monitoring Portfolio.

Default null
safeNostring or null

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

regNostring or null

Local Company Identifier - The Company identifier associated with it's Domestic Filing Agency. i.e. French SIREN/SIRET, United Kingdom Companies House CRN.

vatNostring or null

Company VAT Number

namestring or null

Company Name

tradeNamestring or null

Trade Name of the Company, typically used in Countries where Name is not uniquely registered.

acronymstring or null

A (non-unique) identifier to look for Companies by their more commonly known acronym rather than their lesser known full name. Acronym is predominantly available on French Companies.

exactboolean or null

Provide as true to find Companies matching a Name exactly.
A list of countries this is available at company search exact parameter availability.

addressstring or null
streetstring or null

Address part identifier - Street of the Company

Default null
houseNostring or null

Address part identifier - House/Building Number of the Company

citystring or null

Address part identifier - City of the Company

postCodestring or null

Address part identifier - Postcode/Zip Code of the Company. Can be provided partially to extend to a region with a * as a wildcard. I.e. CF* can represent all postcodes starting with CF.

provincestring or null

Address part identifier - Province/State of the Company

callRefstring or null

This parameter allows users to assign a unique identifier to their API queries. By using a callRef, it facilitates easier tracking and logging within Connect. If you provide a callRef, the Connect team can later retrieve and identify the specific requests associated with that identifier, enabling detailed tracing of interactions.

Default null
officeTypestring or null(CreditsafeGlobalDataOfficeType)
Enum"Registered""Trading""HeadOffice""Branch""Subsidiary""Franchise""Franchisor""SingleOffice""Other"
phoneNoArray of strings or null

Provides Array of phone numbers or Null

statusstring or null(CreditsafeGlobalDataCompanyStatus)

High-level status. Values include "Active", "NonActive", "Pending" and "Other". Note - “Pending” indicates that the entity has entered into a legal process such as insolvency or liquidation, and “Other” indicates an unknown status.

Enum"Active""NonActive""Pending""Other"
typestring(CreditsafeGlobalDataCompanyType)

NonLtdNonReg is only available for countries in Norway.

Enum"NotSet""Ltd""NonLtd""NonLtdNonReg"
websitestring or null
customDatastring or null

Not currently used.

curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/companies?page=1&pageSize=0&countries=GB%2CFR&safeNo=string&regNo=string&vatNo=string&name=string&tradeName=string&acronym=string&exact=true&address=string&houseNo=string&city=string&postCode=string&province=string&officeType=Registered&phoneNo=string&status=Active&type=NotSet&website=string&customData=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
One of:
correlationIdstring

A unique ID assigned to this request.

messagesArray of objects(CreditsafeGlobalDataMessage)
totalSizeinteger(int32)
companiesArray of objects(CreditsafeGlobalDataCompany)
Response
application/json
{
  "correlationId": "string",
  "messages": [
    { … }
  ],
  "totalSize": 0,
  "companies": [
    { … }
  ]
}

Return Indicator Based On Company Identifier

Request

Returns an indicator as to whether verify information is available on a business.

Security
bearerToken
Path
idstring/^(GB|IE)-[01]-.+$/irequired

Unique identifier for the company.

Query
reasonForSearchstringrequired

Reason for performing the search.

Enum"AM""AV""BS""CA""DC""DS""EC""GI""QS""TV"
curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/localSolutions/GB/verify/company/{id}?reasonForSearch=AM' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
companyIDstring

Unique identifier for the company.

verifyMatchboolean

Indicates if the verification matches the company.

Response
application/json
{
  "companyID": "string",
  "verifyMatch": true
}

Company Credit Report

Request

Orders a Company Credit Report by connectId.

To acquire a PDF version of the report use the optional request in 'Header'.

This request will provide a 'Base64-encoded' script to convert to a PDF, this will appear at the end of the JSON response.

Security
bearerToken
Path
connectIdstringrequired

The connectId (optionally Safe Number where available) of the Company required to order their Credit Report. Obtained from /companies search results.

Example: GB-0-03836192
Query
languagestring or null^[a-zA-Z]{2}$

Report Language - The JSON structure of the Report is language invariant, but field content will return as the given language, where available.

Default "en"
templatestring or null

Optional parameter to request a Templated Company Report. A Template adds/reduces sections of the Credit Report depending on your subscription. Do not include this parameter if you have not been given a template to use.
Connect report templates glossary and availability

Default "full"
includeIndicatorsboolean

Optional parameter to include the indicator scores in to a company report -fsi = Financial Strength , pbi = Payment Behaviour Indicator, eti = Estimated Turnover, pei = Payment Expectation Indicator

Addition information on indicator acronyms can be found report indicator definitions

Addition information on understanding indicators can be found indicator guidance in the Scores and Indicators tab

Default false
customDatastring or null

Additional Report Parameters e.g. German Report Reason Code value is de_reason_code::1 . Use /reportcustomdata/{country} endpoint to see all values.

callRefstring or null

This parameter allows users to assign a unique identifier to their API queries. By using a callRef, it facilitates easier tracking and logging within Connect. If you provide a callRef, the Connect team can later retrieve and identify the specific requests associated with that identifier, enabling detailed tracing of interactions.

Default null
Headers
Acceptstring

Applies request for PDF link to Company Report.

Example: application/json+pdf
curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/companies/GB-0-03836192?language=en&template=full&includeIndicators=false&customData=string' \
  -H 'Accept: application/json+pdf' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Body
correlationIdstring

A unique ID assigned to this request.

failedSectionsArray of strings(CreditsafeGlobalDataReportsReportSection)
Items Enum"CompanySummary""CompanySummaryExtra""AlternateSummary""CompanyIdentification""CompanyIdentificationExtra""CreditScore""CreditScoreExtra""ContactInformation""ContactInformationExtra""ShareCapitalStructure"
reportobject(CreditsafeGlobalDataReportsCompanyReport)
companyIdstring
dateOfOrderstring(date-time)
languagestring
userIdinteger
Response
{
  "correlationId": "string",
  "failedSections": [
    "CompanySummary"
  ],
  "report": {
    "companyId": "string",
    "language": "OM",
    "companySummary": { … },
    "companyIdentification": { … },
    "creditScore": { … },
    "contactInformation": { … },
    "indicators": [ … ],
    "shareCapitalStructure": { … },
    "directors": { … },
    "directorships": { … },
    "otherInformation": { … },
    "groupStructure": { … },
    "extendedGroupStructure": [ … ],
    "financialStatements": [ … ],
    "localFinancialStatements": [ … ],
    "negativeInformation": {},
    "additionalInformation": {},
    "directorsExtra": {},
    "extendedGroupStructureExtra": {},
    "paymentData": {},
    "paymentDataExtra": {},
    "alternateSummary": {},
    "negativeInformationExtra": {},
    "exceptions": [ … ]
  },
  "companyId": "string",
  "dateOfOrder": "2019-08-24T14:15:22Z",
  "language": "string",
  "userId": 0
}

US Search Support

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

Operations