Global Watchlist Search

The Global Watchlist Search searches known domestic and international terrorist watchlists as well as the records of the Office of Inspector General (OIG), Excluded Parties List (EPL) and additional domestic and international agency lists.

For more information, please see Global Watchlist Search in the Checkr Help Center.

Operations

Retrieve an existing Global Watchlist Search

Request

Returns an existing Global Watchlist Search with the input ID.

Security

basic_auth

Path

idstringrequired

ID of the Global Watchlist Search to retrieve.

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

Responses

Global Watchlist Search details

Bodyapplication/json

idstring(ResourceId)read-only

ID of the resource.

Example:"e44aa283528e6fde7d542194"

objectstring

Value:"global_watchlist_search"

uristring(ResourceURI)read-only

URI of the resource.

Example:"/v1/global_watchlist_searches/539fd88c101897f7cd000008"

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:90

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"

recordsArray of objects(Record)

Array of CriminalRecord objects.

Response

{
  "id": "e44aa283528e6fde7d542194",
  "object": "global_watchlist_search",
  "uri": "/v1/global_watchlist_searches/539fd88c101897f7cd000008",
  "status": "complete",
  "result": "consider",
  "assessment": "eligible",
  "created_at": "2014-01-18T12:34:00Z",
  "completed_at": "2014-01-18T12:35:30Z",
  "turnaround_time": 90,
  "cancellation_reason": "complete_now_customer_requested",
  "cancellation_reason_description": "Customer requested Complete Now prior to screening completion",
  "records": [
    { … }
  ]
}