Monitoring

Subscribe a company to monitoring

Subscribe a company (by numeric company_id from /companies/search) to ongoing monitoring. Alerts fire on new corporate events, status changes, dissolution, and new sanctions matches. If webhook_url is set, alerts POST to it (HMAC-SHA256 signed via X-Prometiam-Signature using the returned webhook_secret) and appear in GET /monitor. A dissolution alert fires when the company gets a dissolution date or, where the register gives none (Canada, Israel, Singapore, Taiwan, Romania, many US registrations), when its status becomes closed; the latter is dated by the check that first sees the closure and carries detail.date_basis = first_seen_closed (register when the register's date is used). Available for ES, GB, IE, PL, NO, FI, SE, BE, HR, DK, EE, SK, CH, LV, CY, RO, LT, CA, AU, JP, IL, SG, CO, TW, BR, CZ, DE and US (every live country except FR) — ES has the full corporate-event stream; GB alerts on status, dissolution, sanctions and corporate events (Companies House filings and Gazette notices); IE/PL/NO alert on register-change events (none before 14 Oct 2026) as well as status, dissolution and sanctions; FI/SE/BE/HR/DK/EE/SK/CH/LV/CY/RO/LT/CA/AU/JP/IL/SG/CO/TW/BR/CZ/DE/US alert on register-change events (dated when first seen in the register data (for the United States, the weekly read of the registers that first sees it)) as well as status, dissolution and sanctions.

post/monitor

Request

  • Base URL: https://api.prometiam.com/functions/v1/risk-api
  • URL: https://api.prometiam.com/functions/v1/risk-api/monitor
  • Auth: HTTP bearer

Request body

company_idinteger required

Numeric company id from /companies/search, as that country returned it.

country'ES' | 'GB' | 'IE' | 'PL' | 'NO' | 'FI' | 'SE' | 'BE' | 'HR' | 'DK' | 'EE' | 'SK' | 'CH' | 'LV' | 'CY' | 'RO' | 'LT' | 'CZ' | 'DE' | 'US' | 'CA' | 'AU' | 'JP' | 'IL' | 'SG' | 'CO' | 'TW' | 'BR'

Country of the company: every served country except FR, which is not yet monitorable. When omitted, the country the company_id names (ids carry a country offset), else ES.

webhook_urlstring uri

https:// endpoint to POST alerts to. Optional — alerts are always pollable via GET /monitor.

labelstring

Your own reference for this subscription.

eventsstring[]

Which change types to alert on. Defaults to all applicable for the country (ES: corporate_event, status_change, sanctions_match; GB/IE/PL/NO/FI/SE/BE/HR/DK/EE/SK/CH/LV/CY/RO/LT/CA/AU/JP/IL/SG/CO/TW/BR/CZ/DE/US: status_change, dissolution, sanctions_match, corporate_event).

Response

Monitor created (webhook_secret shown once)

Changes

No recorded changes to this operation across all 3 revisions of this API.