Skip to content

Retrieve an existing County Criminal Search

Request

Returns an existing County Criminal Search with the input ID.

Security
basic_auth
Path
idstringrequired

ID of the County Criminal Search to retrieve.

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

Responses

County Criminal Search details

Bodyapplication/json
idstring(ResourceId)read-only

ID of the resource.

Example:"e44aa283528e6fde7d542194"
objectstring
Value:"county_criminal_search"
uristring(ResourceURI)read-only

URI of the resource.

Example:"/v1/county_criminal_searches/539fdcf335644a0ef4000001"
statusstring(ScreeningStatus)

Status of the screening.

Enum:"complete""pending"
Example:"complete"
resultstring or null(ScreeningResult)

Result of the screening.

Enum:"clear""consider"
Example:"consider"
assessmentstring or null(AssessmentAttribute)

The assessment for this screening. This field will be non-null only for Assess-enabled accounts. For accounts with Assess enabled, it will be null for reports completed before Assess was enabled, and null for a short time after report completion while the account's Assess rules are applied.

Enum:"eligible""review""escalated"
Example:"eligible"
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:100800
cancellation_reasonstring or null

See cancellation reasons section for possible values.

Example:"complete_now_customer_requested"
cancellation_reason_descriptionstring or null

See cancellation reasons section for possible values.

Example:"Customer requested Complete Now prior to screening completion"
estimated_completion_timestring, (date-time)

Estimated time of completion for the Search. This estimate will be based on the maximum turnaround time across all counties searched.

Example:"2019-03-13T16:31:07Z"
estimated_completion_datestring, (date)

Estimated date of completion for the Search.

Example:"2019-03-13"
countystring

County in which the record was recorded.

Example:"SAN FRANCISCO"
statestring

State in which the record was recorded.

Example:"CA"
recordsArray of objects(Record)

Array of CriminalRecord objects.

filtered_by_positive_adjudication_recordsArray of objects(Record)

Array of CriminalRecord objects filtered out by your account’s Positive Adjudication Matrix or by your account’s Assess configuration.

screening_pointersArray of strings

Array of screening_pointers associated with the screening.

Response
{ "id": "e44aa283528e6fde7d542194", "object": "county_criminal_search", "uri": "/v1/county_criminal_searches/539fdcf335644a0ef4000001", "status": "complete", "result": "consider", "assessment": "eligible", "created_at": "2014-01-18T12:34:00Z", "completed_at": "2014-01-18T12:35:30Z", "turnaround_time": 100800, "cancellation_reason": "complete_now_customer_requested", "cancellation_reason_description": "Customer requested Complete Now prior to screening completion", "estimated_completion_time": "2019-03-13T16:31:07Z", "estimated_completion_date": "2019-03-13", "county": "SAN FRANCISCO", "state": "CA", "records": [ { … } ], "filtered_by_positive_adjudication_records": [ { … } ], "screening_pointers": [ [ … ] ] }