Skip to main content

Retrieving recorded images

Usually, recorded images will be provided along the ident data. But in some cases, it might be useful to split that up and request the images separately.

Requirements

The order must be finally processed. For a list of final status see the List of Status Codes.

Method and URL

[GET] https://customer.identity.tm/api/2.10/getImages/[OrderID]

Response Data

ElementParentTypeLenOccDescription
Images[ROOT]ADepOnly if images were recorded
ImageImagesSBase64 encoded Data
FilenameImagesS100Filename for the data

HTTP Codes

200 OK, JSON document in response body

400 Bad request, error description in body

401 Authentication failed, please check username and password

404 Order not found

Example Request

[GET] https://customer.identity.tm/api/2.10/getImages/99921269855041

Example Response

{
"Images": [
{
"Image": "/9j/4AAQSkZJRgABAQAASABIAAD/...",
"Filename": "back_20211008-091705-123.jpg"
},
{
"Image": "/9j/4AAQSkZJRgABAQAASABIAAD/...",
"Filename": "front_20211008-091623-123.jpg"
}
]
}