International Global Watchlist Search

A comprehensive search of multiple U.S. and International government watchlists which include the FBI’s Most Wanted list, Interpol's Most Wanted lists, Office of Foreign Asset Control Sanction lists, Denied Persons lists, Department of State Sanction lists, and the Specially Designated Nationals List. Refer to International Screenings for more details.

Operations

Retrieve an existing International Global Watchlist Search

Request

Returns an existing International Global Watchlist Search with the input ID.

Security

basic_auth

Path

idstringrequired

ID of the International Global Watchlist Search to retrieve.

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

Responses

International Global Watchlist Search details

Bodyapplication/json

idstring(ResourceId)read-only

ID of the resource.

Example:"41007cffefb435cf7d701f75d8b87a"

objectstring

Value:"international_global_watchlist_search"

uristring(ResourceURI)read-only

URI of the resource.

Example:"/v1/international_global_watchlist_searches/41007cffefb435cf7d701f75d8b87a"

statusstring

Status of the screening.

Enum:"pending""complete""canceled""suspended"

Example:"complete"

resultstring or null

Result of the 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:"complete_now_customer_requested"

cancellation_reason_descriptionstring

See cancellation reasons section for possible values.

Example:"Customer requested Complete Now prior to screening completion"

countrystring

ISO country code of the jurisdiction where the search was run

Example:"FR"

pdf_urlstring

URL to PDF document containing screening result details

Example:"https://eu-west-1-checkr-staging.s3.eu-west-1.amazonaws.com/document.pdf"

Response

{
  "id": "41007cffefb435cf7d701f75d8b87a",
  "object": "international_global_watchlist_search",
  "uri": "/v1/international_global_watchlist_searches/41007cffefb435cf7d701f75d8b87a",
  "status": "complete",
  "result": "clear",
  "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",
  "country": "FR",
  "pdf_url": "https://eu-west-1-checkr-staging.s3.eu-west-1.amazonaws.com/document.pdf"
}