Browse endpoints

Download an adhoc check as PDF

GET /api/v1/adhoc-checks/{adhoc_check_uuid}/pdf operationId: adhoc-check.pdf

Base: https://portal.watcheye.com.au/api/v1/adhoc-checks/{adhoc_check_uuid}/pdf

Returns a printable PDF report for the adhoc check, suitable for inclusion in customer-facing files. The PDF mirrors the on-screen quick-check report in the portal: subject snapshot, configuration in force, per-match details and a results summary.

The response is application/pdf with a Content-Disposition header naming the file after the check's check_number (e.g. adhoc-check-Q-A1B2CD.pdf).

This endpoint does not bill - PDF generation reuses the existing on-record check data.

Note: PDF rendering is performed on demand and typically takes between 10 and 60 seconds depending on the size of the check (number of matches, embedded fonts, etc.). Increase your HTTP client's read / response timeout accordingly - the default 30 second timeouts in most libraries (curl, Guzzle, axios, requests) are not enough for the larger reports.

Path parameters

FieldDescription
adhoc_check_uuidrequired string (uuid)

The adhoc check UUID

Responses

200

PDF report

application/pdf

Binary PDF file

Standard error responses: 401 403 404 429 5XX See common error responses