Cancel an existing Continuous Check

Request

Cancels an existing Continuous Check.

Security

basic_auth

Path

idstringrequired

The Continuous Check's ID.

curl -i -X DELETE \
  -u '<username>:<password>' \
  'https://docs.checkr.com/_mock/apis/openapi/continuous_checks/{id}'

Responses

Continuous Check was successfully canceled

Bodyapplication/json

idstring(ResourceId)read-only

ID of the resource.

Example:"e44aa283528e6fde7d542194"

objectstringread-only

Value:"continuous_check"

typestring

Type of Continuous Check.

Enum:"criminal""mvr"

Example:"criminal"

created_atstring, (date-time)

Time at which the Continuous Check was created.

Example:"2015-05-14T17:45:34Z"

candidate_idstring

ID of the Candidate enrolled in Continuous Check.

Example:"551564b7865af96a28b13f36"

nodestring

Custom ID of the Node associated with the Continuous Check.

Example:"zpy8orej4r614ize"

work_locationsArray of objects(WorkLocation)

Array of work locations associated with the Continuous Check.

Response

{
  "id": "e44aa283528e6fde7d542194",
  "object": "continuous_check",
  "type": "criminal",
  "created_at": "2015-05-14T17:45:34Z",
  "candidate_id": "551564b7865af96a28b13f36",
  "node": "zpy8orej4r614ize",
  "work_locations": [
    { … }
  ]
}