Skip to content
Connect API Catalog/
/
/
Update Company Details In...

Global Monitoring (1.0.0)

The Global Monitoring API provides a suite of endpoints to Monitor changes to Company Information. Company changes can be retrieved by creating a Portfolio (a collection of companies) and configuring the eventRules (the criteria in which to trigger a change, e.g. company name changes, limit changes) on the portfolio. When a company in your Portfolio changes to satisfy an eventRule, a notificationEvent will be raised to inform you of the nature of the change. See here for Creditsafe's Global Monitoring capabilities.

OAS 3.0.4 Trial Availability

The OAS 3.0.4 version of this API specification is provided for trial purposes only. While every effort is made to ensure its accuracy, the OAS 3.1.0 version is the primary managed and maintained specification and is recommended for all integrations and production use.

Download OpenAPI description
globalMonitoring.json
globalMonitoring.yaml
Languages
Servers
Sandbox server

https://connect.sandbox.creditsafe.com/v1/

Production server

https://connect.creditsafe.com/v1/

Authentication

Endpoints to authenticate and generate an Authentication Token.

Operations

User Details

Endpoints to retrieve user-specific details, such as user profiles and permissions.

Operations

Create and View All Portfolios

Endpoints to create new portfolios and retrieve a list of all existing portfolios for monitoring.

Operations

Importing Portfolios

Endpoints to bulk manage portfolios by importing companies using files in supported formats (e.g., CSV).

Operations

User Management of Portfolios

Endpoints to manage portfolios at a user level, including updating/deleting portfolio details, managing associated notifications and share portfolios with other users.

Operations

Individual Portfolio Management

Endpoints to manage specific portfolios, such as adding or removing companies, applying event rules, and viewing portfolio-specific data.

Operations

Delete Company From Portfolio

Request

Endpoint to delete a company from a portfolio.

Security
bearerToken
Path
portfolioIdnumberrequired

The unique identifier of the portfolio, obtained from /portfolios.

companyIdstringrequired

A company Safe Number or Connect ID.

curl -i -X DELETE \
  'https://connect.sandbox.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/companies/{companyId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
correlationIdstring

A unique ID assigned to this request.

Example: "23921650-c073-11ea-860f-06bc8182190e"
messagestring

A message stating successful deletion.

Example: "Company removed"
Response
application/json
{
  "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
  "message": "Company removed"
}

Update Company Details In Portfolio

Request

Updates the company details in a specified portfolio.

Security
bearerToken
Path
portfolioIdnumberrequired

The unique identifier of the portfolio, obtained from /portfolios.

companyIdstringrequired

A company Safe Number or Connect ID.

Bodyapplication/json
personalReferencestringrequired

Field that can be used to add a personal reference against the company in a portfolio.

freeTextstringrequired

Field that can be used to add a free text note to when adding/updating a company to a portfolio.

personalLimitstringrequired

Field that can be used to add a personal limit number against the company in a portfolio. This needs to be a positive number but in string format.

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"
  }'

Responses

Bodyapplication/json
correlationIdstring

A unique ID assigned to this request.

Example: "23921650-c073-11ea-860f-06bc8182190e"
messagestring

A message stating successful update.

Example: "Company updated successfully"
Response
application/json
{
  "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
  "message": "Company updated successfully"
}

List Portfolio Event Rules

Request

Get all notification eventRules for the given portfolioId. Notification event rules allow you to control which events you wish to monitor for the companies contained within the given portfolio.

Security
bearerToken
Path
portfolioIdnumberrequired

The unique identifier for the portfolio that you wish to retrieve notification event rules for, obtained from /portfolios.

curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/eventRules' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/jsonArray [
isActiveboolean

Shows whether the notification event rule has been enabled for the given portfolio.

Example: 0
ruleCodenumber

The unique identifier for the notification event rule.

Example: 101
ruleCountryCodestring

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.

Example: "XX"
ruleTypenumber

The unique identifier of the ruleType for the notification event rule.

Example: 4
ruleTypeNamestring

A short description of the ruleType for the notification event rule.

Example: "Rating band change - 3 input"
namestring

The name for the notification event rule.

Example: "International Rating | Reduce by {0} Band(s) OR Less than Band {1}"
param0string

Some notification event rules may include input parameters used to tailor the notifications generated to your preference.

Example: "1"
param1string

Some notification event rules may include input parameters used to tailor the notifications generated to your preference.

Example: "A"
param2string

Some notification event rules may include input parameters used to tailor the notifications generated to your preference.

Example: "A"
]
Response
application/json
[
  {
    "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"
  }
]

Event Rules and Notifications

Endpoints to viewing event rules for monitoring and retrieve notifications triggered by changes in monitored companies.

Operations