KausateKausate Docs

Create a monitor

Start monitoring a company. Name the company and, optionally, the categories or event codes to watch.

When to use it

Create a monitor to keep a company under watch after onboarding instead of re-ordering reports. Each check compares the company with the previous one and records an event for every change. Events are delivered to your webhooks and listed by GET /v2/monitors/{monitorId}/events. Narrow what you receive with categoriesFilter or eventCodesFilter; ask GET /v2/events/taxonomy which codes a country can raise.

Example

curl -X POST https://api.kausate.com/v2/monitors \
  -H "X-API-Key: your_api_key" \
  -H "Kausate-Version: 2026-08-01" \
  -H "Content-Type: application/json" \
  -d '{
    "kausateId": "co_zz_4O3wnpE5u1K5AXnkARuhp",
    "eventCodesFilter": [
      "NAME_CHANGED",
      "REGISTERED_ADDRESS_CHANGED",
      "ACTIVITIES_CHANGED",
      "DIRECTOR_ADDED",
      "DIRECTOR_REMOVED",
      "SHAREHOLDING_PERCENTAGE_CHANGED"
    ],
    "metadata": {"caseId": "CASE-12345"}
  }'
{
  "monitorId": "00000000-0000-4000-8000-000000000002",
  "kausateId": "co_zz_4O3wnpE5u1K5AXnkARuhp",
  "companyName": "Sandbox Logistics GmbH",
  "categoriesFilter": [
    "all"
  ],
  "eventCodesFilter": [
    "NAME_CHANGED",
    "REGISTERED_ADDRESS_CHANGED",
    "ACTIVITIES_CHANGED",
    "DIRECTOR_ADDED",
    "DIRECTOR_REMOVED",
    "SHAREHOLDING_PERCENTAGE_CHANGED"
  ],
  "scheduleCron": "0 0 1 * *",
  "metadata": {
    "caseId": "CASE-12345"
  },
  "createdAt": "2026-11-21T13:00:00Z",
  "apiUrl": "/v2/monitors/00000000-0000-4000-8000-000000000002"
}

Leave both filters out to receive every event available for the company. A filter naming a code the company's country does not return is rejected with a 422.

scheduleCron is a five-field cron expression in UTC and defaults to monthly (0 0 1 * *). A monitor may be checked at most once a month and at least once a year. The first check records the starting point; changes are reported from the second check onward. Each scheduled check consumes credits, whether or not a change is detected; delivering its events is included. See choosing a schedule for what a check includes.

  • Monitoring: categories, event codes, schedules and delivery
  • Webhooks: register an endpoint and verify signatures
  • Sandbox: companies that change on every check
POST
/v2/monitors
X-API-Key<token>

Sign up at Kausate.com to get an API key

In: header

Header Parameters

Kausate-Version?string
Default"2026-08-01"
Formatdate

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://api.kausate.com/v2/monitors" \  -H "X-API-Key: $KAUSATE_API_KEY" \  -H "Kausate-Version: 2026-08-01" \  -H "Content-Type: application/json" \  -d '{  "kausateId": "co_zz_4O3wnpE5u1K5AXnkARuhp"}'
{
  "monitorId": "075fef10-8522-4c43-ac39-f1796133943e",
  "kausateId": "string",
  "companyName": "string",
  "categoriesFilter": [
    "status"
  ],
  "eventCodesFilter": [
    "NAME_CHANGED"
  ],
  "scheduleCron": "string",
  "metadata": {
    "property1": "string",
    "property2": "string"
  },
  "createdAt": "2019-08-24T14:15:22Z",
  "apiUrl": "string"
}
{
  "detail": "API key is required",
  "code": "auth.unauthorized",
  "request_id": "req_01J8Z5V4Q2X9N7B3C6D1E0F2G4"
}
{
  "detail": "Invalid API key",
  "code": "auth.forbidden",
  "request_id": "req_01J8Z5V4Q2X9N7B3C6D1E0F2G4"
}
{
  "detail": "Company not found",
  "code": "company.not_found",
  "request_id": "req_01J8Z5V4Q2X9N7B3C6D1E0F2G4"
}
{
  "detail": [
    {
      "loc": [
        "body",
        "kausateId"
      ],
      "msg": "Field required",
      "type": "missing"
    }
  ],
  "code": "request.invalid",
  "request_id": "req_01J8Z5V4Q2X9N7B3C6D1E0F2G4"
}
{
  "detail": "An unexpected error occurred. If this persists, please contact support@kausate.com",
  "code": "internal.unexpected",
  "request_id": "req_01J8Z5V4Q2X9N7B3C6D1E0F2G4"
}

Last updated on