Skip to main content

Managing your portfolio

The api you have received is linked to a portfolio. This portfolio contains the companies you are monitoring. In the same way it works in the web application, you can add and remove companies from your portfolio. You can also change the settings for your portfolio. If you want to try it out, check out the Swagger UI.

Get all companies in your portfolio​

To get all companies in your portfolio, use the following endpoint:

GET https://api.creditchecken.nl/api/monitoring/companies

It will list all companies in your portfolio like this:

{
  "companies": [
    {
      "companyId": "nEm9MA1",
      "name": "Heineken N.V.",
      "countryCode": "NL"
    }
  ]
}

Add a company to your portfolio​

To add a company to your portfolio, use the following endpoint:

PUT https://api.creditchecken.nl/api/monitoring/companies/{companyId}

The companyId is the id of the company you want to add to your portfolio. You can find the companyId by using the search endpoints. If you want to add Heineken N.V. to your portfolio, you can use the following request:

PUT https://api.creditchecken.nl/api/monitoring/companies/nEm9MA1

If the company is successfully added to (or already in) your portfolio, you will receive a 204 OK response.

Remove a company from your portfolio​

To remove a company from your portfolio, use the following endpoint:

DELETE https://api.creditchecken.nl/api/monitoring/companies/{companyId}

For example if you want to remove Heineken N.V. from your portfolio, you can use the following request:

DELETE https://api.creditchecken.nl/api/monitoring/companies/nEm9MA1

If the company is successfully removed from (or not in) your portfolio, you will receive a 204 OK response.