Retrieve an existing National Criminal Search

Request

Returns an existing National Criminal Search with the input ID.

Security

basic_auth

Path

idstringrequired

ID of the National Criminal Search to retrieve.

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

Responses

National Criminal Search details

Bodyapplication/json

idstring(ResourceId)read-only

ID of the resource.

Example:"e44aa283528e6fde7d542194"

objectstring

Value:"national_criminal_search"

uristring(ResourceURI)read-only

URI of the resource.

Example:"/v1/national_criminal_searches/539fd88c101897f7cd000006"

statusstring(ScreeningStatusNonReportable)

Status of the screening.

Enum:"complete""pending"

Example:"complete"

resultstring or null

Result of the screening.

Note: The result parameter will always return a null value because this is a non-reportable screening.

Enum:"clear""consider"

Example:null

created_atstring, (date-time)

Time at which the screening was created.

Example:"2014-01-18T12:34:00Z"

completed_atstring, (date-time)

Time at which the screening was completed.

Example:"2014-01-18T12:35:30Z"

turnaround_timeinteger

Number of seconds the screening took to complete, calculated from created_at to completed_at.

Example:90

cancellation_reasonstring

See cancellation reasons section for possible values.

Example:null

cancellation_reason_descriptionstring

See cancellation reasons section for possible values.

Example:null

recordsArray of objects(Record)

Array of CriminalRecord objects.

Response

{
  "id": "e44aa283528e6fde7d542194",
  "object": "national_criminal_search",
  "uri": "/v1/national_criminal_searches/539fd88c101897f7cd000006",
  "status": "complete",
  "result": null,
  "created_at": "2014-01-18T12:34:00Z",
  "completed_at": "2014-01-18T12:35:30Z",
  "turnaround_time": 90,
  "cancellation_reason": null,
  "cancellation_reason_description": null,
  "records": [
    { … }
  ]
}