registercheckby openlaw group
API referenceMonitors

Create a monitor

POST
/monitors

Starts watching a company, or new companies and changes matching a search.

A company monitor: register changes of the chosen event types are listed by GET /events?monitor_id= and delivered to your destinations (/destinations); GET /deliveries lists what was sent where. Name the company by subject_id, or by its register identity in register ({"court": "München", "type": "HRB", "number": "999999"}, the shape of company.register) and skip the search. An identity that matches no visible company answers 404; one that matches several answers 409 listing every candidate. A monitor belongs to the key's workspace, and every key of that workspace sees it. A person can monitor a company once in each workspace: creating a second monitor on it with a key of the same person and workspace answers 409 with the existing monitor's id in existing_id.

A search monitor (prompt or filter) is the workspace's saved search: it is matched, debited and delivered as the app's searches are -- instantly, by e-mail to the key owner -- and it is served only once the workspace's saved searches are on, else 422 operation_not_allowed with nothing created. A prompt is read as POST /companies/find reads it; a filter or a prompt naming criteria a search cannot hold answers 422 filter_not_monitorable naming each one. GET /events?monitor_id= does not list a search monitor's matches: they are delivered.

Costs 10 credits, once to create a company monitor; a search monitor is free to create, and each match it delivers costs 1 credit, charged as the app's saved searches charge theirs. Credits from the free plan do not pay for a company monitor.

Through a connection of the Registercheck MCP server a monitor costs and counts as one created with an API key: the same 10 credits, and it does not count against the companies your plan monitors. It is held to your account inbox's check speed, like a monitor created in the dashboard: it reports a change at its next check, not as soon as it is detected. A 503 means the monitor was not created and nothing was charged; retry after the seconds in Retry-After.

Authorization

bearerAuth
AuthorizationBearer <token>

Your API key, sent as Authorization: Bearer rc_prod_….

In: header

Header Parameters

Idempotency-Key?string

Makes a retry safe. A request repeated with the same key within 24 hours returns the first successful response (with Idempotent-Replayed: true) instead of acting twice; an error is not stored, so its retry runs again. Reusing a key with a different body returns 422; retrying while the first request is still running returns 409. A response that carries a webhook's signing secret is not stored: retrying such a POST /destinations answers 409 with existing_id. Use a random UUID.

Length1 <= length <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

A new monitor. Name exactly one subject: the company by subject_id, the company by register (its register identity), a written request for companies as prompt, or the criteria themselves as filter. A prompt or filter makes a search monitor: the workspace's saved search, matched and delivered as the app's searches are, free to create and 1 credit per delivered match -- served only once the workspace's saved searches are on, else 422 operation_not_allowed. A search monitor holds only the criteria a search can: 422 filter_not_monitorable names the rest, and it carries no metadata (a non-empty one answers 400). company_id, the name before the October 2026 release, is refused with a 400.

Monitor one company, by its id.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://api.registercheck.de/v1/monitors" \  -H "Authorization: Bearer $REGISTERCHECK_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "register": {      "court": "München",      "type": "HRB",      "number": "999999"    },    "event_types": [      "representation",      "capital"    ],    "metadata": {      "crm_id": "0015g00000XyZ"    }  }'
{  "object": "monitor",  "id": "mon_3wksk7jx1583f98jz0fz0zj2q7",  "subject": {    "object": "company",    "id": "cmp_01hxn3rys1fh58w4d1pb1x9s81",    "name": "Beispiel Reisen GmbH"  },  "event_types": [    "company.capital.changed",    "company.role.added",    "company.role.removed",    "company.representation_rule.changed"  ],  "unavailable_event_types": [],  "status": "active",  "metadata": {    "crm_id": "0015g00000XyZ"  },  "check_schedule": "daily",  "next_check_at": "2024-05-22T05:00:00Z",  "paused_at": null,  "counts_toward_limit": true,  "created_at": "2024-05-21T07:55:12Z",  "updated_at": "2024-05-21T07:55:12Z"}