Endpoints for user authentication into the Connect API.
Metadata
| Key | Value |
|---|---|
| tags | Full Connect API |
| Key | Value |
|---|---|
| tags | Full Connect API |
Creditsafe Connect is a REST API that provides access to the Creditsafe Global Company Database. This allows you to:
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.
Endpoints to retrieve the structure of the Company and Director Search Criteria's and Reports.
The JSON schema is a blueprint of the data structure that will be returned in the response of the Company and Director Report endpoints. The schema can be used to validate the response data and understand the structure of the data returned. The schema is available for all countries and is a superset of all country's JSON schemas.
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.
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.
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.
curl -i -X GET \
'https://creditsafe-connect-api.redocly.app/_mock/connect-apis-catalog/product-catalog/connect-api-full/connectapi/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" } ]
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.
curl -i -X GET \
'https://creditsafe-connect-api.redocly.app/_mock/connect-apis-catalog/product-catalog/connect-api-full/connectapi/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" } ]
Endpoint to update an eventRule in a portfolio. Must provide a portfolio unique identifier and a country code in the URL of the PUT request. The Body of the request must contain the ruleCode number of the eventRule you want to update, with an isActive parameter. Some event rules may also contain specific parameters, which can be set with param0, param1 and param2. parameters. Get the above information by calling the List All eventRules endpoint.
Important Note
It is recommended that any changes made to the Event Rules are verified using the List Portfolio Event Rules Endpoint after the PUT call has been made.
To ensure optimal processing efficiency when updating live event rules—whether for removal, addition, or status change—it is best practice to update the entire list of rules in a single operation.
curl -i -X PUT \
'https://creditsafe-connect-api.redocly.app/_mock/connect-apis-catalog/product-catalog/connect-api-full/connectapi/monitoring/portfolios/{portfolioId}/eventRules/{countryCode}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '[
{
"ruleCode": 101,
"isActive": 1,
"param0": true,
"param1": "15",
"param2": "10"
},
{
"ruleCode": 1802,
"isActive": 1,
"param0": "10"
},
{
"ruleCode": 1815,
"isActive": 0
}
]'