Create a new Continuous Check

Request

Creates a new Continuous Check resource.

Security

basic_auth

Path

candidate_idstringrequired

The Candidate's ID.

Bodyapplication/jsonrequired

typestringrequired

Defines the screening type(s) for this Continuous Check.

Enum:"criminal""mvr"

Example:"criminal"

nodestring

Required for hierarchy-enabled accounts with Nodes.

custom_id of the associated node.

work_locationsArray of objects(WorkLocation)

Required for hierarchy-enabled accounts.

Array of locations described using country, state, and city. When country is not specified defaults to US. State is required for US candidates. Country is required for non-US candidates.

mvr_enrollment_typestring

Applies when type is mvr.

Specifies the Continuous MVR enrollment type. Use commercial for commercial driver's license (CDL) holders. When omitted, Checkr derives the enrollment type from the candidate's most recent completed MVR, or defaults to standard.

Enum:"commercial""standard"

Example:"commercial"

curl -i -X POST \
  -u '<username>:<password>' \
  'https://docs.checkr.com/_mock/apis/openapi/candidates/{candidate_id}/continuous_checks' \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "criminal",
    "node": "string",
    "work_locations": [
      {
        "country": "US",
        "state": "CA",
        "city": "San Francisco"
      }
    ],
    "mvr_enrollment_type": "commercial"
  }'

Responses

Continuous Check was successfully created

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": [
    { … }
  ]
}