monitoring

Create a monitor

Changed on

Creates one standing watch: one product (sex-offender or criminal) and one predicate (person or location). Watching the same person in both datasets is two monitors. channels must carry at least one email address or a webhookUrl. product: "criminal" with type: "location" creates nothing and returns 200 with status: "not_yet_available".

post/v1/monitors

Request

  • Base URL: https://api.offendersearch.app
  • URL: https://api.offendersearch.app/v1/monitors
  • Auth: API key in header X-API-Key

Request body

product'sex-offender' | 'criminal' required

The dataset this monitor watches.

type'person' | 'location' required

The predicate. person requires person; location requires location.

minConfidence'dob_match' | 'year_match' | 'age_match' | 'name_match' | 'any' nullable

The weakest match strength a person monitor alerts on. Unset (and any): year_match when person.dob is set, name_match when it is not.

labelstring nullable

Your own name for the monitor, echoed back.

Response

product: "criminal" with type: "location". No monitor was created and nothing is billed.

status'not_yet_available'
messagestring

A sentence you can show a user.

Changes

  • 72fe5b5ea612Revision changes
    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

  • a2bbdbc2b735Revision changes
    • info

      the endpoint scheme security BearerAuth was removed from the API