Skip to content

Download Image ​

Retrieves a previously uploaded image by its image_id. The response body is the raw image, not JSON.

Endpoint ​

http
POST /v1/images/<image_id>
Content-Type: application/json

Parameters:

ParamTypeRequiredDefaultDescription
image_idstringYes—The unique ID of the image, supplied as a path segment.

Returns: image/jpeg binary body

Sample Request ​

bash
curl -X POST \
  '<BASE_URL>/v1/images/8dd701de-8c61-4b9b-9cc1-67553e9cbd5b' \
  -H 'Authorization: ATV <ACCESS_ID>:<SIGNATURE>' \
  -H 'X-TV-Timestamp: <TIMESTAMP>' \
  -H 'Content-Type: application/json' \
  --data ''

Response ​

On success the response Content-Type is image/jpeg and the body is the image itself. On failure the response is JSON:

json
{
  "errors": [],
  "success": false,
  "code": 0,
  "message": "string"
}
FieldTypeDescription
errorsarrayDetail of why the download failed.
successboolfalse when the image could not be returned.
codeintNumeric status code.
messagestringStatus message.

WARNING

Downloaded images are customer identity documents and biometric data. Serve them only to authenticated internal callers, never proxy the endpoint to a public client, and apply your own retention policy to any copy you store.

Errors ​

CodeMessage
2001010Access ID not found.
2001014Register rate limit exceeded.
2001015Register brute force limit exceeded.
401100You are not authorized to perform the action.
4001000Input parameter violates a constraint.
4001001The X-TV-Timestamp header is expired, need a newer one.
5001000Some unexpected error occurs while processing the request.

Next Steps ​

  • Upload Image — how an image_id is created in the first place

Developers