Download an IDPass image
/api/v1/idpasses/{idpass_uuid}/images/{image_type}
operationId: idpass.image
Base: https://portal.watcheye.com.au/api/v1/idpasses/{idpass_uuid}/images/{image_type}
Returns a single IDPass image as its raw bytes, mirroring the
download IDPass PDF endpoint. The Content-Type is the image's
stored MIME type (typically image/jpeg) and a Content-Disposition header suggests an
inline filename. The image_type is one of the file types listed in the images array of
the show IDPass response (e.g. licence_front, id_photo,
probe_image); that array is also where the per-image title and mime_type metadata live.
Images are only retained when the IDPass was launched with return_verification_images
set to true. Unknown or unavailable types return 404.
Path parameters
| Field | Description |
|---|---|
idpass_uuidrequired |
string (uuid) The uuid of the IDPass. |
image_typerequired |
string The image file type, as listed in the |
Responses
The requested image, returned as raw bytes
image/jpeg
image/png