Skip to content
Connect API Catalog/
/
/
List Portfolio Event Rule...

Creditsafe Connect (1.10.9)

Introduction

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 (opens in new tab). 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

Quick Start

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.

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

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

Production server

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

Authentication

Endpoints for user authentication into the Connect API.

Operations

User Administration

Endpoints for user management.

Operations

Instance Management

Endpoints for managing decision engine instances, including retrieval, and updating.

Operations

Decision Trees

Endpoints for accessing and managing pre-configured decision trees used for automated credit decisions.

Operations

Decision Logs

Endpoints for retrieving and managing logs of past decisions.

Operations

Run Decision

Endpoints for executing decision trees to automate credit decisions.

Operations

Decision Outcome

Endpoints for retrieving the outcomes of executed decisions, including detailed results.

Operations

Search And Report Schemas/Criteria

Endpoints to retrieve the structure of the Company and Director Search Criteria, Report Schemas, and available Report Languages for a specific country.

These endpoints provide the necessary information to validate responses, understand search parameters, and determine localization options for reports.

Operations

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.

Order a Company Credit Report

Operations

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 Report Endpoint, and use the directors section in the report response.

Operations

GB Consumers and AML

This endpoint provides tools for consumer and anti-money laundering checks in Great Britain.

Operations

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.

Operations

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.

Operations

Create and View All Jobs

Create a Data Cleaning job and view all jobs in the system.

Operations

Individual Job Management

Manage individual Data Cleaning jobs. Including updating required mappings and enrichment processes.

Operations

User Details

Operations

Create and View All Portfolios

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

Operations

Importing Portfolios

Operations

User Management of Portfolios

Operations

Individual Portfolio Management

Operations

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"
param2boolean

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

Example: true
]
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": true
  }
]

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"
param2boolean

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

Example: true
]
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": true
  }
]

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

Event Rules and Notifications

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

Operations

Administrator Resources

Endpoints for user management.

Operations

AML Bulk Screening

Endpoints to perform bulk AML screenings for multiple businesses or individuals in a single request.

Operations

AML Monitoring Management

Endpoints to set up and manage ongoing AML monitoring for profiles, including receiving alerts for changes or risks.

Operations

AML Screening - Businesses

Endpoints to perform AML screening for businesses, including risk assessments and compliance checks.

Operations

AML Screening - Individuals

Endpoints to perform AML screening for individuals, including identity verification and risk assessments.

Operations

AML Screening - Profile Management

Endpoints to manage AML screening profiles, including creating, updating, and retrieving screening results.

Operations

Async AML

Endpoints to return asynchronous AML jobs, such as bulk screenings or monitoring tasks.

Operations

Audit

Endpoints to retrieve audit logs and track activity related to profiles, searches, and monitoring actions.

Operations

Batch Uploads

Endpoints to upload and process batch files for profiles or searches, including retrying failed uploads and downloading error reports.

Operations

Compliance Alerts

Endpoints to manage and retrieve compliance alerts related to companies via a connectId.

Operations

Global Monitoring

Endpoints to monitor changes to company information globally, including event rules and notifications.

Operations

Profile Business / Individual Details

Endpoints to retrieve detailed information about businesses or individuals associated with a profile.

Operations

Profile Key Parties

Endpoints to manage key parties associated with a profile, such as directors, shareholders, or UBOs.

Operations

Profile Management

Endpoints to create, retrieve, and manage profiles.

Operations

Profile Updates

Endpoints to update existing profiles with new information, such as addresses, notes, or attachments.

Operations

Reporting

Endpoints to generate and retrieve reports, including compliance reports and risk assessments.

Operations

Searches

Endpoint to review performed searches for businesses or individuals, including retrieving search results and downloading reports.

Operations

GB Bank Match

This endpoint provides tools for matching business bank account information in Great Britain.

Operations

GB Bank Verification

This endpoint provides tools for verifying bank account information for individuals in Great Britain.

Operations

GB Land Registry

This endpoint provides tools for accessing land registry information in Great Britain.

Operations

GB Finance Agreements

This endpoint provides tools for acquiring and verifying finance agreement information.

Operations

FR Bank Match

This endpoint provides tools for matching bank information in France.

Operations

DE NonLtd Companies

This endpoint provides the tools for searching non-limited companies in Germany and acquiring company reports.

Operations

NL KVK Extract

This endpoint provides tools for extracting information from the Dutch Chamber of Commerce (KVK).

Operations

US Search Support

Operations

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.

Operations

Audit (Legacy)

Operations

IDV (Legacy)

Operations

Consumers

Update this description.

Operations