The Company Monitoring Check Object

A company_monitoring check watches a company's registry record after onboarding and moves to
need_review when data in a monitored category changes.

It targets companies only, is created with is_internal set to true, and is read-only over the
API.

Product documentation: Company monitoring.

Creation

company_monitoring is the only check type with no create endpoint. A check of this type is
created either by a template attached to a case — template_key on
Create a case, or Run a template — or from the
company's page in the console. An integration that requires monitoring on every company it
onboards configures it in the template.

Retrieve a company monitoring check

GET /v1/checks/company-monitoring/{id} — the path segment is hyphenated, not
company_monitoring. See
Retrieve a company monitoring check.

curl https://api.dotfile.com/v1/checks/company-monitoring/$CHECK_ID \
  -H "X-DOTFILE-API-KEY: $DOTFILE_API_KEY"

List checks locates the check. The filter value is the check type as it appears
on the object, company_monitoring, with an underscore:

curl -G https://api.dotfile.com/v1/checks \
  -H "X-DOTFILE-API-KEY: $DOTFILE_API_KEY" \
  -d type.eq=company_monitoring \
  -d status.eq=need_review

See Filtering, sorting and pagination.

Response

data.settings.alert_categories contains values from: financial_changes,
legal_and_compliance, company_status, operational_changes, debt_and_collection,
shareholder_changes, other.

The alerts themselves are not exposed over the API. A detected change moves the check to
need_review and emits Check.ReviewNeeded — see Webhooks — but the content
of the alert is available only in the console. This check type has no review endpoint; alerts are
resolved there.

subtype is always null on a company_monitoring check.

Deactivation

Monitoring cannot be started over the API, but data.vendor.is_monitored is set to false by any
of the following, several of which are API-driven:

Approving a case does not deactivate monitoring; closing it does. Read
data.vendor.is_monitored to confirm the current state.

Related

• The Check object — the shared envelope, statuses and review mechanics
• Templates — the API-driven route to creating this check