Creditsafe Connect 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
Check the status of Creditsafe Services HERE
Use the buttons below to let us know what you think of this documentation. Please leave comments in your feedback for the author to consider for future versions.
Selecting one of the buttons above will open a new tab to the feedback portal.
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.
Production Environment baseurl: https://connect.creditsafe.com/v1 Sandbox Test Environment baseurl: https://connect.sandbox.creditsafe.com/v1
| Item | Description |
|---|---|
| A Front End Demo Site | Opens a friendly UI to test the Connect API |
| Open API Spec | This will allow you to view the documentation in the swagger portal - this will be discontinued |
| Help Articles | Opens the Help Hub with a list of common questions and answers |
| Data Dictionaries | The connect documentation shows the general use case, the data dictionaries include the additional specific data that is returned by individual countries |
| Data Availability per Country | The Data Matrix is a document that outlines all the fields that are available in the company report for an online territory |
| Creditsafe Online Country Feature Availability | This matrix displays what features are available with the online Creditsafe Countries and the partner network |
| Connect Report Templates | The document identifies the templates available for specific parts of the Company Credit Report, avoiding the need to order the full report object in one API call. |
| Connect API Response Codes | Opens up a basic table of response codes, provides a link to a more detailed response code list |
Non-Breaking Changes
Non-breaking changes will generally include additive functions or bug fixes. It is crucial for the integration of the code to be done in such a way that it does not depend on the sequence in which items are returned. This ensures that updates can be applied seamlessly without affecting the existing functionality.
Breaking Changes
Breaking changes refer to any modifications to the API's functionality that could disrupt the current contract of the API. Such changes necessitate communication with stakeholders and will lead to a major version number update, indicating the significant nature of these changes.