Creditsafe Connect (1.10.9)
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
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.
https://connect.sandbox.creditsafe.com/v1/
https://connect.creditsafe.com/v1/
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.
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/{id} endpoint, and use the directors section in the response.
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.
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.
Field that can be used to add a personal reference against the company in a portfolio.
Field that can be used to add a free text note to when adding/updating a company to a portfolio.
- Sandbox server
https://connect.sandbox.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/companies/{companyId}
- Production server
https://connect.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/companies/{companyId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
'https://connect.sandbox.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/companies/{companyId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"personalReference": "personal reference",
"freeText": "Some useful text",
"personalLimit": "40"
}'{ "correlationId": "23921650-c073-11ea-860f-06bc8182190e", "message": "Company updated successfully" }
- Sandbox server
https://connect.sandbox.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/eventRules
- Production server
https://connect.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/eventRules
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://connect.sandbox.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/eventRules' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Shows whether the notification event rule has been enabled for the given portfolio.
The ISO/Alpha 2 format country code for the notification event rule. "XX" is used for global rules that apply to companies from all countries.
A short description of the ruleType for the notification event rule.
The name for the notification event rule.
Some notification event rules may include input parameters used to tailor the notifications generated to your preference.
Some notification event rules may include input parameters used to tailor the notifications generated to your preference.
Some notification event rules may include input parameters used to tailor the notifications generated to your preference.
[ { "isActive": 0, "ruleCode": 101, "ruleCountryCode": "XX", "ruleType": 4, "ruleTypeName": "Rating band change - 3 input", "name": "International Rating | Reduce by {0} Band(s) OR Less than Band {1}", "param0": "1", "param1": "A", "param2": "A" } ]
Request
Endpoint to that lists all the eventRules, their status and parameters based on a portfolio Id, filtered by country. Newly created portfolios are without any notification event rules by default, but you can switch rules on/off per country or on a global basis. There are different rules available for each country due to the different type of change event data that's available. The following GET request lists all the available rules for a portfolio.
- Sandbox server
https://connect.sandbox.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/eventRules/{countryCode}
- Production server
https://connect.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/eventRules/{countryCode}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://connect.sandbox.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/eventRules/{countryCode}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Shows whether the notification event rule has been enabled for the given portfolio.
The ISO/Alpha 2 format country code for the notification event rule. "XX" is used for global rules that apply to companies from all countries.
A short description of the ruleType for the notification event rule.
The name for the notification event rule.
Some notification event rules may include input parameters used to tailor the notifications generated to your preference.
Some notification event rules may include input parameters used to tailor the notifications generated to your preference.
Some notification event rules may include input parameters used to tailor the notifications generated to your preference.
[ { "isActive": 0, "ruleCode": 101, "ruleCountryCode": "XX", "ruleType": 4, "ruleTypeName": "Rating band change - 3 input", "name": "International Rating | Reduce by {0} Band(s) OR Less than Band {1}", "param0": "1", "param1": "A", "param2": "A" } ]
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.