Download an IDPass image
/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.
Example Request
GETRequest Schema
idpass_uuid
image_type
The image file type, as listed in the `images` array of the show response.
Available Response Data
3 Data PointsImage bytes
image/jpeg or image/png, returned as raw bytes, not JSON
The captured document or selfie image for the requested image_type
404 if the IDPass was not found, or no image of that type is held for it
API Data Scale & Coverage tag
Unmatched data depth to power your compliance and verification workflows.
Sandbox Environment
Build and test against a sandbox account. Sandbox is a separate account with its own UUID and its own API keys, and the environment is fixed at the account level, so you cannot switch an existing key between live and sandbox with a parameter or header. Both share the same base URL, so the account behind your key is what determines which environment you are in. GET /v1/account returns an environment field of live or sandbox, and that is the authoritative answer.
Calls on a sandbox key are not billed. Every endpoint, response shape, error envelope, idempotency and rate-limit behaviour mirrors live, so the only change when you move to production should be the credentials. Sandbox accounts are provisioned by your Global Data account manager.
Identity verification works end to end in sandbox using the same endpoints and response shapes as live. No real SMS is sent for an IDPass delivered by SMS on a sandbox account; the message is recorded instead of delivered.
Technical Use Cases tag
Render captured images in your own review screen
Retrieve the captured document or selfie image as raw bytes and display it in your own review interface.
Evidence for a disputed verification
Where image retention is enabled, the captured frames are the material a dispute or audit turns on.
Availability follows your retention setting
Images are only available while the retention period allows. A 404 means the image is not held for that IDPass.
Compliance & Security tag
Enterprise-grade infrastructure audited against the standards your regulators require.
Common Questions tag
Everything you need to know about implementation details and compliance infrastructure.
rocket_launch Implementation
What does this endpoint return?
add
What does this endpoint return?
Raw bytes, not JSON. The success response carries the file itself, so treat the body as binary and write it straight to storage instead of parsing it.
Error responses are still JSON. A 404 means the record was not found or no file of that type is available for it.
rocket_launch Implementation
What are the rate limits?
add
What are the rate limits?
600 requests per minute by default, enforced with a 60-second fixed window. Every response carries X-RateLimit-Limit and X-RateLimit-Remaining.
Exceeding the limit returns 429 Too Many Requests with a Retry-After header giving the number of seconds to wait, and X-RateLimit-Reset giving the reset timestamp. Schedule retries from Retry-After instead of a fixed sleep, and slow down before you hit zero, not after.
Higher limits can be arranged case by case through WatchEye support.
Ready to integrate Download an IDPass image?
Talk to our team about credentials, sandbox access and the right combination of endpoints for your workflow.