Retrieve an existing Drug & Alcohol Clearinghouse Search

Request

Returns an existing Drug & Alcohol Clearinghouse Search with the input ID.

Security

basic_auth

Path

idstringrequired

ID of the Drug & Alcohol Clearinghouse Search to retrieve.

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

Responses

Drug & Alcohol Clearinghouse Search details

Bodyapplication/json

idstring(ResourceId)read-onlyrequired

ID of the resource.

Example:"e44aa283528e6fde7d542194"

report_idstring

The ID of the Report.

Example:"539fd88c101897f7cd000007"

query_resultstring or null

The result of the Drug & Alcohol Clearinghouse query.

Enum:"Driver Not Prohibited""Driver Prohibited"

Example:"Driver Not Prohibited"

query_typestring or null

The type of Drug & Alcohol Clearinghouse query conducted. Screenings created before this field was introduced return pre_hire.

Enum:"pre_hire""post_hire"

Example:"pre_hire"

statusstring

The status of the screening.

Enum:"pending""complete""canceled"

Example:"complete"

cancellation_reasonstring or null

The reason the screening was canceled.

Enum:"candidate_missing_consent""request_withdrawn"

Example:"candidate_missing_consent"

cancellation_reason_descriptionstring or null

Description of the cancellation_reason for the screening.

Enum:"Candidate consent not provided""Request withdrawn"

Example:"Candidate consent not provided"

Response

{
  "id": "e44aa283528e6fde7d542194",
  "report_id": "539fd88c101897f7cd000007",
  "query_result": "Driver Not Prohibited",
  "query_type": "pre_hire",
  "status": "complete",
  "cancellation_reason": "candidate_missing_consent",
  "cancellation_reason_description": "Candidate consent not provided"
}