Skip to content
State Criminal Search/
Retrieve an existing Stat...

Retrieve an existing State Criminal Search

Request

Returns an existing State Criminal Search with the input ID.

Security
basic_auth
Path
idstringrequired

ID of the State Criminal Search to retrieve.

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

Responses

State Criminal Search details

Bodyapplication/json
idstring(ResourceId)read-only

ID of the resource.

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

URI of the resource.

Example:"/v1/state_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 Screening. This estimate will be based on the maximum turnaround time across all states searched.

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

State searched for these records.

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": "state_criminal_search",
  "uri": "/v1/state_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": "2014-01-18T12:34:00Z",
  "state": "CA",
  "records": [
    { … }
  ],
  "filtered_by_positive_adjudication_records": [
    { … }
  ],
  "screening_pointers": [
    [ … ]
  ]
}
© Checkr, Inc.