# Global Monitoring 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. {% admonition type="info" name="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. {% /admonition %} Version: 1.0.0 Metadata: - tags: ["Featured"] ## Servers Sandbox server ``` https://connect.sandbox.creditsafe.com/v1 ``` Production server ``` https://connect.creditsafe.com/v1 ``` ## Security ### bearerToken This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the `Authorization` header of each request. Type: http Scheme: bearer Bearer Format: JWT ## Download OpenAPI description [Global Monitoring](https://doc.creditsafe.com/_spec/connect-apis-catalog/product-catalog/GlobalMonitoring/@OAS3.1/globalMonitoring.yaml) ## Authentication Endpoints to authenticate and generate an Authentication Token. ### Authenticate - [POST /authenticate](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/authentication/authenticate.md): Supply username and password to generate Authentication Token. ## User Details Endpoints to retrieve user-specific details, such as user profiles and permissions. ### Monitoring User Details - [GET /monitoring/user/details](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/user-details/monitoringuserdetails.md): You would use this endpoint to retrieve the user details related to the Global Monitoring product, such as the user's information. ## Create and View All Portfolios Endpoints to create new portfolios and retrieve a list of all existing portfolios for monitoring. ### List All Portfolios - [GET /monitoring/portfolios](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/create-and-view-all-portfolios/listallportfolios.md): This endpoint allows you to manage portfolios. You can use the GET method to retrieve all portfolios associated with the user. ### Create Monitoring Portfolio - [POST /monitoring/portfolios](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/create-and-view-all-portfolios/createmonitoringportfolio.md): This endpoint to create a new Portfolio based on the supplied criteria. A portfolio can contain any number of companies that you wish to monitor changes to. The only required Body parameter is "name" for Connect users. ## Importing Portfolios Endpoints to bulk manage portfolios by importing companies using files in supported formats (e.g., CSV). ### Import A Portfolio File - [POST /monitoring/portfolios/{portfolioId}/import](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/importing-portfolios/importaportfoliofile.md): Endpoint allows you to import a list of companies to add to the selected portfolio along with some personal information for the company. Importing a portfolio will add the companies to the specified portfolio, duplicates in the import file will be ignored. You may also optionally add an email to the body of the request and get an email notification when the import is processed. : Detailed information on the structure of the CSV file and file size limits can be found in the help documentation: HERE ### Sync A Portfolio File - [POST /monitoring/portfolios/{portfolioId}/sync](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/importing-portfolios/syncaportfoliofile.md): Endpoint allows you to sync a portfolio file with your portfolio. Sync action will delete all companies in your specified portfolio, and then add the companies from the file into the portfolio. : Detailed information on the structure of the CSV file and file size limits can be found in the help documentation: HERE ## 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. ### Retrieve Portfolio By Id - [GET /monitoring/portfolios/{portfolioId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/user-management-of-portfolios/retrieveportfoliobyid.md): This endpoint allows you to retrieve the portfolio details from the portfolioId. ### Delete Portfolio - [DELETE /monitoring/portfolios/{portfolioId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/user-management-of-portfolios/deleteportfolio.md): This endpoint allows you to delete the portfolio using the portfolioId. ### Update Portfolio Details - [PATCH /monitoring/portfolios/{portfolioId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/user-management-of-portfolios/updateportfoliodetails.md): This endpoint allows you to update Portfolio details such as Name, email recipients, language and subject line. ### Copy Companies Between Portfolios - [POST /monitoring/portfolios/{portfolioId}/companies/copy](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/user-management-of-portfolios/copycompaniesbetweenportfolios.md): This endpoint allows you to copy companies from one portfolio to another. You can specify the source and destination portfolios to perform the copy operation. ### Move Companies Between Portfolios - [POST /monitoring/portfolios/{portfolioId}/companies/remove](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/user-management-of-portfolios/movecompaniesbetweenportfolios.md): This endpoint allows you to move companies from one portfolio to single (or) multiple portfolios. Removes the companies from the portfolio provided in the path parameter. ### Portfolio User Permissions - [GET /monitoring/portfolios/{portfolioId}/sharingPermissions](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/user-management-of-portfolios/portfoliouserpermissions.md): Retrieve user permissions within the customer for a portfolio. ### Share Portfolio With Users - [PATCH /monitoring/portfolios/{portfolioId}/sharingPermissions](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/user-management-of-portfolios/shareportfoliowithusers.md): Update/Create user permissions within the customer for portfolio. ## Individual Portfolio Management Endpoints to manage specific portfolios, such as adding or removing companies, applying event rules, and viewing portfolio-specific data. ### List Countries of Monitored Companies - [GET /monitoring/portfolios/{portfolioId}/countries](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management/listcountriesofmonitoredcompanies.md): This endpoint provides a list of distinct countries associated with the companies monitored within a specific portfolio. ### List Companies In A Portfolio - [GET /monitoring/portfolios/{portfolioId}/companies](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management/listcompaniesinaportfolio.md): This endpoints gets all companies from a specific portfolio based on the portfolio id, optionally filter with query parameters. ### Add Company To Portfolio - [POST /monitoring/portfolios/{portfolioId}/companies](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management/addcompanytoportfolio.md): Endpoint to add a company using a company id, into a portfolio provided in as a path parameter. Additional fields can be used to add a personalReference, freeText, and personalLimit. These fields need to be submitted in the requestBody but can be 'nulled' if not required. See the two examples of the submission with and without these fields. ### Clear Companies From Portfolio - [PATCH /monitoring/portfolios/{portfolioId}/companies/clear](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management/clearcompaniesfromportfolio.md): This endpoint allows for companies to be deleted from the specified portfolio. ### Get Company Details From A Portfolio - [GET /monitoring/portfolios/{portfolioId}/companies/{companyId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management/getcompanydetailsfromaportfolio.md): This endpoint allows you to get various company details from a portfolio. Requires a portfolioID and companyID in the PATH of the request. ### Delete Company From Portfolio - [DELETE /monitoring/portfolios/{portfolioId}/companies/{companyId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management/deletecompanyfromportfolio.md): Endpoint to delete a company from a portfolio. ### Update Company Details In Portfolio - [PATCH /monitoring/portfolios/{portfolioId}/companies/{companyId}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management/updatecompanydetailsinportfolio.md): Updates the company details in a specified portfolio. ### List Portfolio Event Rules - [GET /monitoring/portfolios/{portfolioId}/eventRules](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management/listportfolioeventrules.md): Get all notification for the given . Notification event rules allow you to control which events you wish to monitor for the contained within the given . ### List Portfolio Event Rules By Country - [GET /monitoring/portfolios/{portfolioId}/eventRules/{countryCode}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management/listportfolioeventrulesbycountry.md): 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. ### Update EventRules - [PUT /monitoring/portfolios/{portfolioId}/eventRules/{countryCode}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management/updateeventrules.md): 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 number of the eventRule you want to update, with an parameter. Some event rules may also contain specific parameters, which can be set with , and . parameters. Get the above information by calling the List All eventRules endpoint. It is recommended that any changes made to the are verified using the List Portfolio Event Rules Endpoint after the PUT call has been made. ### Set Portfolio Default Rules - [PUT /monitoring/portfolios/{portfolioId}/eventRules/setDefault](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management/setportfoliodefaultrules.md): Update a portfolios event rules to default state. In Connect, default state means all rules are turned off. ### Portfolio Risk Summary - [GET /monitoring/portfolios/{portfolioId}/riskSummary](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management/portfoliorisksummary.md): Get current portfolio risk summary information. ### List Portfolio Notifications - [GET /monitoring/portfolios/{portfolioId}/notificationEvents](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management/listportfolionotifications.md): Get all notificationEvents based on the portfolio id, optionally filter with query parameters. ### List Company Specific NotificationEvents - [GET /monitoring/portfolios/{portfolioId}/companies/{companyId}/notificationEvents](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/individual-portfolio-management/listcompanyspecificnotificationevents.md): List of notification events based on the company id,optionally filtered with query parameters. ## Event Rules and Notifications Endpoints to viewing event rules for monitoring and retrieve notifications triggered by changes in monitored companies. ### List Company Events - [GET /monitoring/companies/{id}/events](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/event-rules-and-notifications/listcompanyevents.md): Endpoint to return a collection of for the given company, optionally filtered on the supplied search criteria. Event information will only be returned if the company exists in at least one of your . ### All EventRules - [GET /monitoring/eventRules](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/event-rules-and-notifications/alleventrules.md): Get all available notification event rules. Notification event rules allow you to control which events you wish to monitor for the contained within a given . This endpoint returns all available notification event rules, including those that are not currently enabled for the specified portfolio. To view only the notification event rules that are currently available for a portfolio you have please use the Endpoint Portfolio Event Rules. ### Filtered EventRules - [GET /monitoring/eventRules/{countryCode}](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/event-rules-and-notifications/filteredeventrules.md): Get all available notification event rules for the given . Notification event rules allow you to control which events you wish to monitor for the contained within a given . ### All Notification Events - [GET /monitoring/notificationEvents](https://doc.creditsafe.com/connect-apis-catalog/product-catalog/globalmonitoring/globalmonitoring/event-rules-and-notifications/allnotificationevents.md): Get all notification events generated for companies monitored in your portfolios, based on the notification rules enabled. The notification events returned will be filtered based upon the supplied search criteria.