Skip to content
Connect API Catalog/
/
/
Update EventRules

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

List Portfolio Event Rules By Country

Request

Endpoint 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.

For guidance on how to use event rules with PARAM prefixes and to understand rule parameters, see the documentation here: Special Event Rules. For example, global rule 101 may require specific PARAM values as described in the linked documentation.

Security
bearerToken
Path
portfolioIdnumberrequired

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

countryCodestring= 2 charactersrequired

Country code to show events for.
Please note that there is one exception in that PLC is the only 3-character that can be accepted here.

curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/eventRules/{countryCode}' \
  -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"
  }
]

Update EventRules

Request

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. For example, global rule 101 may require specific PARAM values as described in the Special Event Rules documentation. 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.

Security
bearerToken
Path
portfolioIdnumberrequired

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

countryCodestring= 2 charactersrequired

Country code to show events for

Bodyapplication/jsonrequired

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. Some rules, such as global rule 101, require specific PARAM values. Please refer to the Special Event Rules documentation for guidance on correct parameter usage.

Array [
ruleCodeintegerrequired

The unique ID of the EventRule.

isActiveintegerrequired

Flag to show if EventRule is active or not. 0 for false, 1 for true.

param0string or integer

Optional parameter used by some rules. Each rule type may use this property differently. For special event rules, consult the Special Event Rules documentation. For other rules, use the List Portfolio Event Rules endpoint to see available options.

Any of:

Optional parameter used by some rules. Each rule type may use this property differently. For special event rules, consult the Special Event Rules documentation. For other rules, use the List Portfolio Event Rules endpoint to see available options.

string

Optional parameter used by some rules. Each rule type may use this property differently. For special event rules, consult the Special Event Rules documentation. For other rules, use the List Portfolio Event Rules endpoint to see available options.

param1string or integer

Optional parameter used by some rules. Each rule type may use this property differently. For special event rules, consult the Special Event Rules documentation. For other rules, use the List Portfolio Event Rules endpoint to see available options.

Any of:

Optional parameter used by some rules. Each rule type may use this property differently. For special event rules, consult the Special Event Rules documentation. For other rules, use the List Portfolio Event Rules endpoint to see available options.

string

Optional parameter used by some rules. Each rule type may use this property differently. For special event rules, consult the Special Event Rules documentation. For other rules, use the List Portfolio Event Rules endpoint to see available options.

param2string or integer

Optional parameter used by some rules. Each rule type may use this property differently. For special event rules, consult the Special Event Rules documentation. For other rules, use the List Portfolio Event Rules endpoint to see available options.

Any of:

Optional parameter used by some rules. Each rule type may use this property differently. For special event rules, consult the Special Event Rules documentation. For other rules, use the List Portfolio Event Rules endpoint to see available options.

string

Optional parameter used by some rules. Each rule type may use this property differently. For special event rules, consult the Special Event Rules documentation. For other rules, use the List Portfolio Event Rules endpoint to see available options.

]
curl -i -X PUT \
  'https://connect.sandbox.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/eventRules/{countryCode}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "ruleCode": 101,
      "isActive": 1,
      "param0": 1,
      "param1": "A",
      "param2": true
    },
    {
      "ruleCode": 1802,
      "isActive": 1,
      "param0": "10"
    },
    {
      "ruleCode": 1815,
      "isActive": 0
    }
  ]'

Responses

No Content

Bodyapplication/json
messagestring
Response
application/json
{
  "message": "string"
}

Set Portfolio Default Rules

Request

Update a portfolios event rules to default state. In Connect, default state means all rules are turned off.

Security
bearerToken
Path
portfolioIdnumberrequired

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

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

Responses

No Content

Bodyapplication/json
messagestring
Response
application/json
{
  "message": "string"
}

Event Rules and Notifications

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

Operations