Download an ID check certificate as PDF

GET /api/v1/id-checks/{id_check_uuid}/pdf operationId: id-check.pdf

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

Returns a verification certificate PDF for a completed entity-bound ID check.

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

Status codes

200 - the PDF certificate is returned in the response body.
404 - either the ID check does not exist on the calling account, or the id_type is idpass (the idpass identity verification flow is hosted entirely on the idpass platform and does not produce a downloadable WatchEye certificate). Use the response message to distinguish the two cases.
409 - the ID check has not yet reached a terminal outcome (outcome is not pass or fail). Poll show ID check until outcome is set, then retry the download.

Field	Description
`id_check_uuid`required	string (uuid) The uuid of the ID check.

200

application/pdf

Binary PDF file

409

application/json

Field	Description
`message`	string Example: `The ID check has not completed yet. Wait for outcome to be 'pass' or 'fail' before downloading the certificate.`

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

Response

200 PDF certificate

No response body.

401 Unauthorized - the API key or account is inactive, expired, or not permitted from this IP address shared error response

{
    "message": "API Key Inactive",
    "api_reference": "00000000-0000-0000-0000-000000000000"
}

403 No access - No permission to process this request shared error response

{
    "message": "No access",
    "api_reference": "00000000-0000-0000-0000-000000000000"
}

404 Not Found - The requested resource does not exist or is not accessible by this account shared error response

{
    "message": "Entity not found",
    "api_reference": "00000000-0000-0000-0000-000000000000"
}

409 The ID check has not yet completed. Poll the show endpoint until outcome is pass or fail before retrying the download.

{
    "message": "The ID check has not completed yet. Wait for outcome to be 'pass' or 'fail' before downloading the certificate."
}

429 Rate limited - The request rate limit has been reached shared error response

{
    "message": "Rate limited",
    "api_reference": "00000000-0000-0000-0000-000000000000"
}

5XX Internal error - Internal system error shared error response

{
    "message": "Internal error",
    "api_reference": "00000000-0000-0000-0000-000000000000"
}