Monitoring¶
Companies and individuals can be registered or deregistered for monitoring via these business cases, and an overview of monitoring orders can be obtained.
Retrieve monitoring directory¶
Resource: https://api.crediconnect.ch/v3/monitorings
The GET resource is used to retrieve your list of monitoring orders. Various filters can be defined:
| Field | Description | Example |
|---|---|---|
| MonitoringFilter.OrderId | Order number of the monitoring order. | 560483217 |
| MonitoringFilter.CrefoId | Crefo number of the company/person in monitoring. | 406635386 |
| MonitoringFilter.ProductCode | Product code of the selected monitoring product. | 7101APLUS |
| MonitoringFilter.Reference1 | Business reference of the monitoring order. | Test0815 |
| MonitoringFilter.StartDate | Start date of the monitoring job. | 30-01-2026 |
| MonitoringFilter.EndDate | End date of the monitoring job. | 31-12-2099 |
| MonitoringFilter.State | Status of monitoring jobs: - Void: not specified - Active: active monitoring - Expired: expired monitoring - Future: future monitoring |
Active |
| PageSize | Number of entries per page | 10 |
| LastId | Last ID number | 1 |
Monitoring Registration¶
*Resource: https://api.crediconnect.ch/v3/monitorings
A new monitoring request is transmitted using the Post resource. The following information can be transmitted:
| Field | Description | Example |
|---|---|---|
| CrefoId | Crefo number of the company/person | 406635386 |
| ProductCode | Product code of the selected monitoring product. | 7101APLUS |
| Reference1 Reference2 |
Business reference 1 and 2 of the monitoring order. | Test0815 Management |
| ReasonOfInquiry | Reason for enquiry: Creditworthiness / Contract / Claim / Competitor |
Claim |
| StartDate | Desired start date of monitoring. | 2026-02-03 |
| EndDate | Desired end date of monitoring. | 2027-12-31 |
Monitoring cancellation¶
Resource: https://api.crediconnect.ch/v3/monitorings/{id}/cancellation
The patch resource can be used to terminate an existing monitoring job with immediate effect.