Download an IDPass certificate as PDF

GET /api/v1/idpasses/{idpass_uuid}/pdf operationId: idpass.pdf

Base: https://portal.watcheye.com.au/api/v1/idpasses/{idpass_uuid}/pdf

Returns the verification certificate PDF for a completed IDPass.

This endpoint does not bill - the certificate is generated from the on-record IDPass data.

Status codes

200 - the PDF certificate is returned in the response body.
404 - the IDPass does not exist on the calling account.
409 - the IDPass has not yet reached a terminal status. Poll show IDPass until status is terminal, then retry the download.

Field	Description
`idpass_uuid`required	string (uuid) The uuid of the IDPass.

200

application/pdf

Binary PDF file

409

application/json

Field	Description
`message`	string Example: `The IDPass has not completed yet. Wait for a terminal status 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 IDPass has not yet completed. Poll the show endpoint until status is terminal before retrying the download.

{
    "message": "The IDPass has not completed yet. Wait for a terminal status 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"
}