Monitor¶
The API provides the ability to monitor companies from the Netherlands for certain events. After activating a company, we monitor it for a period of one year. It’s possible to extend it with another year every time it will expire. This option, automatic renewal, can be changed at any time.
Report types¶
Add or update an entry¶
To add or update an entry, make a PUT request to the https://inquiry.creditandcollection.nl/api/monitor/entries/:reg_number endpoint.
Note
A valid :reg_number consists of 8 digits (KvK-number).
HTTP Request¶
PUT https://inquiry.creditandcollection.nl/api/monitor/entries/97123456
Request Body¶
A description of the available attributes.
reference¶
- type:
string
- required:
no
- max length:
50
continue¶
- type:
boolean
- required:
no
- default:
true
Flag for automatic renewal.
Example¶
curl \
--user username:password \
--request PUT \
--header 'Content-Type: application/json' \
--data '{"continue": true}' \
'https://inquiry.creditandcollection.nl/api/monitor/entries/97123456'
Response¶
See EntryItemResponse schema for more information about the response format.
{
"item": {
"name": "Groesman International B.V.",
"reg_number": "97123456",
"reference": "",
"startdate": "2015-09-25",
"enddate": "2016-09-24",
"continue": true,
"created_at": "2015-09-25T12:00:00Z",
"updated_at": "2015-09-25T12:00:00Z",
"refs": {
"self": "/api/monitor/entries/97123456"
}
}
}
Delete an entry¶
To delete an entry, make a DELETE request to the https://inquiry.creditandcollection.nl/api/monitor/entries/:reg_number endpoint.
Note
A valid :reg_number consists of 8 digits (KvK-number).
HTTP Request¶
DELETE https://inquiry.creditandcollection.nl/api/monitor/entries/97123456
Example¶
curl \
--user username:password \
--request DELETE \
'https://inquiry.creditandcollection.nl/api/monitor/entries/97123456'
Browse entries¶
To browse entries, make a GET request to the https://inquiry.creditandcollection.nl/api/monitor/entries endpoint.
HTTP Request¶
GET https://inquiry.creditandcollection.nl/api/monitor/entries
Query Parameters¶
Parameter |
Default |
|---|---|
term |
|
page |
1 |
limit |
10 |
The items are sorted by created_at in descending order.
Note
Limit must be between 1 and 100.
Example¶
curl \
--user username:password \
--get \
--data-urlencode 'term=Groesman' \
'https://inquiry.creditandcollection.nl/api/monitor/entries'
Response¶
See EntryListResponse schema for more information about the response format.
{
"list": [
{
"name": "Groesman International B.V.",
"reg_number": "97123456",
"reference": "",
"startdate": "2015-09-25",
"enddate": "2016-09-24",
"continue": true,
"created_at": "2015-09-25T12:00:00Z",
"updated_at": "2015-09-25T12:00:00Z",
"refs": {
"self": "/api/monitor/entries/97123456"
}
}
],
"meta": {
"items": 1,
"current_page": 1,
"more_items": false
}
}
Delete an entry¶
To delete an entry, make a DELETE request to the https://inquiry.creditandcollection.nl/api/monitor/entries/:reg_number endpoint.
HTTP Request¶
DELETE https://inquiry.creditandcollection.nl/api/monitor/entries/97123456
Example¶
curl \
--user username:password \
--request DELETE \
'https://inquiry.creditandcollection.nl/api/monitor/entries/97123456'
Browse alerts¶
To browse alerts, make a GET request to the https://inquiry.creditandcollection.nl/api/monitor/alerts endpoint.
HTTP Request¶
GET https://inquiry.creditandcollection.nl/api/monitor/alerts
Query Parameters¶
Parameter |
Default |
|---|---|
year |
|
month |
|
day |
|
page |
1 |
limit |
10 |
The items are sorted by created_at in descending order.
Note
Not possible to use month without year.
Not possible to use day without month.
Limit must be between 1 and 100.
Example¶
curl \
--user username:password \
--get \
--data-urlencode 'year=2015' \
--data-urlencode 'month=09' \
'https://inquiry.creditandcollection.nl/api/monitor/alerts'
Response¶
See AlertListResponse schema for more information about the response format.
{
"list": [
{
"id": "1",
"reg_number": "97123456",
"reference": "",
"type": "REVIEW_INCREASE",
"created_at": "2015-09-26T00:00:00Z",
"refs": {
"self": "/api/monitor/alerts/1",
"report": "/api/monitor/alerts/1/report"
}
}
],
"meta": {
"items": 1,
"current_page": 1,
"more_items": false
}
}
Fetch an alert report¶
To fetch an alert report, make a GET request to the https://inquiry.creditandcollection.nl/api/monitor/alerts/:id/report endpoint.
HTTP Request¶
GET https://inquiry.creditandcollection.nl/api/monitor/alerts/1/report
Example¶
curl \
--user username:password \
'https://inquiry.creditandcollection.nl/api/monitor/alerts/1/report'
Response¶
See ReportResponse schema for more information about the response format.
{
"review": {
"score": 6.2,
"limit_advice": "EUR 2.500",
"rating": "B-"
},
"contact_info": {
"name": "Groesman International B.V.",
"address_office": {
"address": "Breitnerlaan 7",
"zipcode": "1098LE",
"city": "Amsterdam",
"country": "NL"
}
},
"registration": {
"reg_type": "KvK-nummer",
"reg_number": "97123456"
}
}
Schemas¶
The following schemas represent the formats of the HTTP responses, returned by the API, which are described on this page.