Skip to main content
POST
/
v1
/
monitor
JavaScript
import Openregister from 'openregister';

const client = new Openregister({
  apiKey: process.env['OPENREGISTER_API_KEY'], // This is the default and can be omitted
});

const monitor = await client.monitor.create({
  entity_id: 'entity_id',
  entity_type: 'company',
  preferences: ['basic'],
});

console.log(monitor.entity_id);
{
  "entity_type": "company",
  "entity_id": "<string>",
  "preferences": [
    "basic"
  ],
  "disabled": true
}

​
Create a monitor

Create a monitor to receive webhook notifications when a company or person is updated. Cost: 10 credits
Early Access. Only available to select API users and enterprise customers. Request access to get started.
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)
ValueWhat triggers a notification
basicCore firmographic data — name, registered address, legal form, or status
representationDirectors, officers, managing partners, or authorised signatories
financialsAnnual accounts or financial statements filed
documentsNew documents or publications filed with the register
ownershipDirect owners (shareholders) of the company
holdingsCompanies in which this company holds a stake
Person (entity_type: person)
ValueWhat triggers a notification
management_positionsBoard or management roles the person holds across any company
holdingsCompanies in which this person holds a stake

​
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)

ValueDescription
basicCore firmographic data (name, address, legal form, status)
representationDirectors, officers, and authorised signatories
financialsAnnual accounts and financial statements
documentsFiled documents and publications
ownershipDirect owners of the company
holdingsCompanies in which this company holds a stake

Person (entity_type: person)

ValueDescription
management_positionsBoard and management roles the person holds
holdingsCompanies in which this person holds a stake

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

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)

ValueDescription
basicCore firmographic data (name, address, legal form, status)
representationDirectors, officers, and authorised signatories
financialsAnnual accounts and financial statements
documentsFiled documents and publications
ownershipDirect owners of the company
holdingsCompanies in which this company holds a stake

Person (entity_type: person)

ValueDescription
management_positionsBoard and management roles the person holds
holdingsCompanies in which this person holds a stake

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
​
disabled
boolean
required

Whether the monitor item is disabled.