Skip to main content
POST
JavaScript

Create a monitor

Create a monitor to receive webhook notifications when a company or person is updated. Cost: 25 credits (50 credits for daily monitors)
Before creating monitors, you must configure a webhook URL in your OpenRegister dashboard. See the Monitoring guide for a full overview of how monitoring works.

Entity ID

The entity_id format depends on the entity_type:
  • Company — use the register ID, e.g. DE-HRB-F1103-267645. You can find this on the company page or via the search endpoints.
  • Person — use the person UUID returned by the person search or person endpoint.

Preferences

Preferences control which data categories trigger a webhook notification. You must provide at least one preference. All values must correspond to the given entity_type — mixing preferences across entity types returns a 400 Bad Request. Company (entity_type: company) Person (entity_type: person)

Update Frequency

The optional update_frequency field controls how often the monitored company is checked for register updates: If you omit the field, the monitor defaults to weekly.
update_frequency is only supported for company monitors. Including it when entity_type is person returns a 400 Bad Request validation error.

Use Cases

Compliance monitoring — Subscribe to basic, representation and ownership changes on counterparties or customers. Receive alerts on legal form conversions, address moves, or management changes as soon as they appear in the register. Ownership change alerts — Use the ownership and holdings preferences to detect when a company’s shareholder structure changes, keeping your KYC data current without manual re-checks. Financial filing alerts — Monitor the financials and documents preferences to be notified the moment new annual accounts or register publications are available, enabling automated document retrieval and archiving workflows. Due diligence pipelines — Add a monitor when onboarding a new counterparty. Receive ongoing notifications for the duration of the relationship and remove the monitor when the relationship ends.

Authorizations

Authorization
string
header
required

API Key Authentication Provide your API key as a Bearer token in the Authorization header.

Body

application/json

Request to create a webhook monitor item.

entity_type
enum<string>
required

Type of the entity to monitor.

Available options:
company,
person
entity_id
string
required

For company this is the register ID (e.g. DE-HRB-F1103-267645). For person this is the person UUID.

preferences
enum<string>[]
required

Preferences for the entity to monitor. Use WebhookMonitorCompanyPreference values when entity_type is company, and WebhookMonitorPersonPreference values when entity_type is person.

All possible monitor preference values across all entity types.

Which values are valid depends on entity_type:

Company (entity_type: company)

Person (entity_type: person)

Passing a value that does not apply to the given entity_type will result in a validation error.

Available options:
basic,
representation,
financials,
documents,
ownership,
holdings,
management_positions,
insolvencies
update_frequency
enum<string>
default:weekly

How often the monitored company is checked for register updates. Defaults to weekly if not provided.

Only supported when entity_type is company. Requests for person monitors that include this field are rejected with a validation error.

Daily monitors are billed at a premium: 50 credits at creation and 50 credits per month while active, instead of the standard 25.

Available options:
daily,
weekly

Response

Success

entity_type
enum<string>
required

Type of the entity to monitor.

Available options:
company,
person
entity_id
string
required

For company this is the register ID (e.g. DE-HRB-F1103-267645). For person this is the person UUID.

preferences
enum<string>[]
required

Preferences for the entity to monitor. Use WebhookMonitorCompanyPreference values when entity_type is company, and WebhookMonitorPersonPreference values when entity_type is person.

All possible monitor preference values across all entity types.

Which values are valid depends on entity_type:

Company (entity_type: company)

Person (entity_type: person)

Passing a value that does not apply to the given entity_type will result in a validation error.

Available options:
basic,
representation,
financials,
documents,
ownership,
holdings,
management_positions,
insolvencies
update_frequency
enum<string>
default:weekly
required

How often the monitored company is checked for register updates. Always weekly for person monitors.

Available options:
daily,
weekly
disabled
boolean
required

Whether the monitor item is disabled.