Skip to content

Reports

Reports return the PDF rendering of a completed check — the same document the dashboard downloads. One endpoint serves every supported check family: pass an instant criminal check or a driver check ID. GET /v1/checks/{check_id}/report is an equivalent path.

Operations

Download report (PDF)

Request

Download a PDF report for a single check. check_id accepts either an Instant Criminal Check or a Driver Check (Driver License Status / Motor Vehicle Report) ID. The file is returned as an attachment (Content-Disposition: attachment) with a suggested filename of {first_name} {last_name} - check results.pdf. When first or last name is unavailable, {check_id} - check results.pdf is used instead.

The PDF reflects the same result shaping as the JSON check resource (GET /v1/checks/{check_id} or GET /v1/driver_checks/{driver_check_id}, whichever family the ID belongs to).

This endpoint is equivalent to GET /v1/checks/{check_id}/report; both accept the same IDs and return the same document.

Availability: Returns 422 Unprocessable Content with a JSON body when the check has not finished and results are not yet available (no completed results).

Security
get-bearer-token-using-oauth2
Path
check_idstring, (uuid)required

the uuid identifying the check whose report to download

Example:2b8313e8-4efd-45a1-b578-952b8313e890
curl -i -X GET \
  https://api.checkrtrust.com/v1/reports/2b8313e8-4efd-45a1-b578-952b8313e890 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

PDF document

Headers
Content-Dispositionstring

Attachment with suggested filename {first_name} {last_name} - check results.pdf.

Example:"attachment; filename=\"Jane Doe - check results.pdf\""
Bodyapplication/pdf
string, (binary)
Response
string