Last updated

Global Monitoring Endpoints

Company Monitoring allows you to keep a close eye on your customers, suppliers, and competitors without the need to regularly check their company reports. Available for companies within 48 countries across multiple continents, Monitoring provides customisable alerts on both negative and positive company events, including credit risk indicators, company financials, company status, directors and many more.


Endpoints Overview

The Global Monitoring API provides the following key functionalities:

  1. Create and Manage Portfolios:
    Endpoints to create portfolios, update their details, and manage associated notifications.

  2. Add and Manage Companies in a Portfolio:
    Endpoints to add individual companies or bulk import companies into a portfolio. Includes functionality to sync portfolios by replacing all existing companies with new ones.

  3. Set Up and Manage Event Rules:
    Endpoints to configure event rules for monitoring specific changes, such as credit limit updates, company status changes, and more. Rules can be applied globally or to specific countries.

  4. Receive Notifications:
    Endpoints to retrieve notifications triggered by event rules, providing real-time updates on changes to monitored companies.

These endpoints work together to provide a comprehensive monitoring solution, enabling you to track critical changes and respond proactively.


Resources

The Product Documentation tab includes the following key resources:

  1. Global Monitoring Process:
    A detailed process flow outlines the steps required to:
    • Create, import, update portfolios
    • Add, update companies in a portfolio
    • Apply, update event rules on a portfolio
    • View notification events
  2. Monitoring Coverage:
    A list of available countries for Global Monitoring
  3. Import and Sync Multiple Companies:
    Detailed instructions on how to bulk manage companies within a portfolio using the Import and Sync functionalities:
    • Import: Adds unique companies from the supplied file to the portfolio without affecting existing entries.
    • Sync: Replaces all existing companies in the portfolio with the contents of the supplied file, effectively overwriting the portfolio.
  4. Special Event Rules:
    A detailed description of the Special Event Rules that require extra parameters and how to apply them.

API Documentation

The API Documentation tab provides the OpenAPI specification for this product. It includes:

  • Detailed endpoint definitions.
  • Code snippets for various programming languages.
  • Example requests and responses to help you integrate the API seamlessly.