Monitoring

Create a company-record monitor

Creates a company-record monitor and runs its first usable baseline. It does not monitor authority-reported VAT-registration status. Idempotency-Key is required. A successful live baseline uses one check. A retry with the same key and body returns the exact completed response, including any webhook signing secret.

post/monitors

Request

  • Base URL: https://vatfind.com/v1
  • URL: https://vatfind.com/v1/monitors
  • Auth: HTTP bearer

Headers

Idempotency-Keystring required

Stable key for safe retries, scoped to workspace, environment, and operation.

Request body

identifier_type'vat_number' | 'tax_identifier' | 'registration_number' required
identifierstring required
country_codestring required
company_namestring
cadence'daily' | 'weekly' | 'monthly'
watched_fieldsMonitorWatchedField[]
webhook_urlstring uri

Public HTTPS endpoint. Credentials, IP literals, and local, test, internal, or localhost names are rejected.

client_referencestring
metadataobject

Example request

{
  "country_code": "GB"
}

Response

Active monitor and completed baseline

webhook_signing_secretstring

Example response

{
  "monitor": {
    "identifier": {
      "country_code": "GB"
    }
  },
  "baseline_check": {
    "identifier": {
      "country_code": "GB"
    },
    "company": {
      "country_code": "GB"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.