Skip to content

Retrieve referee report

Method GET
Path /v1/reports/{check_id}/referees/{referee_id}{?t}

Downloads the completed PDF report for an individual referee on a reference check.

Use the signed checks[].references[].report_pdf_url from GET /v1/requests/{id}, or call this endpoint directly with check_id, referee_id, and standard authentication headers.

Request

Headers

X-Xref-API-Key: <api-key>
X-Xref-User-Email: <user@yourcompany.com>
Accept: application/pdf

Parameters

Name Example / default Required Type Description
check_id 5f0c2d8e-0000-0000-0000-000000000000 Yes string The public check ID (checks[].id in GET /v1/requests/{id}).
referee_id 1234567 Yes string The referee ID (checks[].references[].referee_id in GET /v1/requests/{id}).
t token_value No string Signed token from report_pdf_url. Valid for 1 hour; allows access without authentication headers. Tokens are specific to the associated referee report.

Response

200 — application/pdf

Binary PDF content

Errors

Status status_message Description
401 client_error Required authentication headers are missing or invalid, or the signed t token is invalid or expired.
403 client_error The Xref user is not an active member of the organisation associated with the API key, the user cannot access the request's package, or is a Contributor and did not create the request.
404 client_error The report could not be found, is not yet available, or is not associated with the organisation.
429 client_error API key rate limit exceeded for requests using authentication headers.
5xx server_error An internal server error occurred while retrieving the report.

See Errors and status codes for more information.