Skip to content

Retrieve an existing Federal Civil Search

Request

Returns an existing Federal Civil Search with the input ID.

Security
basic_auth
Path
idstringrequired

ID of the Federal Civil Search to retrieve.

Query
excludestring

Indicates whether to return district screenings in pointer search payload

Example:exclude=district
curl -i -X GET \
  -u '<username>:<password>' \
  'https://docs.checkr.com/_mock/apis/openapi/federal_civil_searches/{id}?exclude=district'

Responses

Federal Civil Search details

Bodyapplication/json
idstring(ResourceId)read-only

ID of the resource.

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

URI of the resource.

Example:"/v1/federal_civil_searches/625487abdc27f729a9997f50"
statusstring(ScreeningStatus)

Status of the screening.

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

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:"clear"
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.

records_hidden_by_assessArray of objects(Record)

Array of CriminalRecord objects filtered out by your account’s Assess configuration.

filtered_by_positive_adjudication_recordsArray of objects(Record)

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

Response
{
  "id": "e44aa283528e6fde7d542194",
  "object": "federal_civil_search",
  "uri": "/v1/federal_civil_searches/625487abdc27f729a9997f50",
  "status": "complete",
  "result": "clear",
  "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": [
    { … }
  ],
  "records_hidden_by_assess": [
    { … }
  ],
  "filtered_by_positive_adjudication_records": [
    { … }
  ]
}
© Checkr, Inc.