Monitoring API enums

Every closed vocabulary the API accepts or returns, with every value and where it appears.

How to read the Monitoring API enums

Every closed vocabulary the Monitoring API accepts or returns, generated from the same reference data as the endpoint and object tables. Direction says whether a value is something you send, something you receive, or both. Treat a value you do not recognise as other and log it: values are added over time and announced on the changelog, never removed or renamed.

Fields whose values are the source's own text (for example a criminal record's currentStatus or a charge's disposition) are not enums and are not listed here; their closed twins live in the normalized object and are listed.

Monitoring API enums — every value

Field	Where	Direction	Values	Default
`minConfidence` The weakest match strength a person monitor alerts on, strongest first: `dob_match`, `year_match`, `age_match`, `name_match`. Unset or `any` applies the default floor: `year_match` when `person.dob` is set, `name_match` when it is not. Location monitors alert on every record in the radius and do not read this field. Any other value is a `422`.	Create monitor request	request	`dob_matchyear_matchage_matchname_matchany`	—
`product` The dataset this monitor watches. One product per monitor: watching one person in both datasets is two monitors, billed separately.	Create monitor request	request	`sex-offendercriminal`	—
`type` The predicate. `person` watches a name (and date of birth); `location` watches a radius around a point. `criminal` with `location` returns `200` `not_yet_available` and creates nothing.	Create monitor request	request	`personlocation`	—
`status` Always `not_yet_available`.	POST /v1/monitors · 200	response	`not_yet_available`	—
`status` Always `canceled`.	DELETE /v1/monitors/{monitorId} · 200	response	`canceled`	—
`event` Present only on a `removed` event, always `"removed"`.	The AlertRecord object — the matched record in an alert	both	`removed`	—
`event` The event: `new`, `changed` or `removed`. Same meaning as the alert's `eventType`.	The monitor.alert webhook payload object	both	`newchangedremoved`	—
`eventType` The latest event for this person: `new` (the person newly matches), `changed` (a fact about them changed while matching — an address, an offense field, a status, a new booking), `removed` (they no longer match — no longer listed in that registry, or outside a location monitor's radius). A registry renumbering a listing is not an event.	The alert object	both	`newchangedremoved`	—
`matchLabel` How the record matched: `dob_match`, `year_match`, `age_match` or `name_match` on a person monitor, `in_radius` on a location monitor. `null` on a `removed` event.	The alert object	both	`dob_matchyear_matchage_matchname_matchin_radius`	—
`matchLabel` How the record matched — the same value as the alert's `matchLabel`. Absent on a `removed` event.	The AlertRecord object — the matched record in an alert	both	`dob_matchyear_matchage_matchname_matchin_radius`	—
`minConfidence` The alert floor exactly as you set it. `null` when you did not set one, in which case the default floor applies (`year_match` with a `dob`, `name_match` without).	Fields — every field on the Monitor object	both	`dob_matchyear_matchage_matchname_matchany`	—
`product` The dataset this monitor watches.	Fields — every field on the Monitor object	both	`sex-offendercriminal`	—
`product` The monitor's dataset.	The monitor.alert webhook payload object	both	`sex-offendercriminal`	—
`status` `active`: evaluated and billed. `canceled`: no longer evaluated, and not charged on any invoice prepared after the cancel; the monitor and its alerts stay readable.	Fields — every field on the Monitor object	both	`activecanceled`	—
`type` The predicate: which of `person` or `location` this monitor carries.	Fields — every field on the Monitor object	both	`personlocation`	—
`type` Always `monitor.alert`.	The monitor.alert webhook payload object	both	`monitor.alert`	—