Skip to content

Retrieve an existing International Criminal Search

Request

Returns an existing International Criminal Search with the input ID.

Security
basic_auth
Path
idstringrequired

ID of the International Criminal Search to retrieve.

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

Responses

International Criminal Search details

Bodyapplication/json
idstring(ResourceId)read-only

ID of the resource.

Example:"41007cffefb435cf7d701f75d8b86d"
objectstring
Value:"international_criminal_search"
uristring(ResourceURI)read-only

URI of the resource.

Example:"/v1/international_criminal_searches/41007cffefb435cf7d701f75d8b86d"
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"
recordsArray of objects(Record)

Array of CriminalRecord objects.

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": "41007cffefb435cf7d701f75d8b86d",
  "object": "international_criminal_search",
  "uri": "/v1/international_criminal_searches/41007cffefb435cf7d701f75d8b86d",
  "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",
  "records": [
    { … }
  ],
  "country": "FR",
  "pdf_url": "https://eu-west-1-checkr-staging.s3.eu-west-1.amazonaws.com/document.pdf"
}
© Checkr, Inc.