/v1/sessions/{id}/media

Updated
  • Updated on May 2, 2025
Get
/v1/sessions/{id}/media

Returns a list of media objects associated with the specific sessionId = {id}

The list of objects are sorted based on their accuracy (e.g., does an image match the required image type) and their quality. The order is determined by the automation system.

→ See the Context types (image, video)[↗] for additional info about the values of images.context

Note that the request will return the media objects of the most recent attempt. If you require the media of a certain attempt, you should: 

  1. Call the list of attemptId-s from the GET sessions/{sessionId}/attempts endpoint
  2. Use the GET attempts/{attemptId}/media to get the media of a specific attempt

Also, when this request is done in a test integration, it is expected behaviour that no video is returned.

Note: always ensure that you use the correct API URL to send requests. See the API URL section for more info.


Security
API Key
Header parameter namex-auth-client

Your integration's API key (occasionally referred to the "Token", "API public key" or "Publishable key")

Header parameters
x-hmac-signature
stringRequired

Session id signed with the shared secret key

Path parameters
id
stringRequired

Session id

Responses
200
Expand All
object
status
string

API request status

Examplesuccess
images
Array of object (VerificationSessionImageUpload)
object
id
string (uuid)

UUID v4 which identifies the uploaded media

Exampled69a07cf-4434-4d36-be6c-d22af7dc01fb
name
string

Name which identifies the uploaded media

Valid values[ "\"document-and-face\"", "\"document-and-face-pre\"", "\"document-back\"", "\"document-back-pre\"", "\"document-front\"", "\"document-front-pre\"", "\"document-front-with-signature\"", "\"document-front-with-signature-pre\"", "\"face\"", "\"face-pre\"", "\"face-nfc\"", "\"face-reference\"", "\"face-cropped\"", "\"address-front\"", "\"document-front-face-cropped\"", "\"registry-face\"" ]
Exampledocument-front
context
string

Context type of the uploaded media

Valid values[ "\"document-and-face\"", "\"document-and-face-pre\"", "\"document-back\"", "\"document-back-pre\"", "\"document-front\"", "\"document-front-pre\"", "\"document-front-with-signature\"", "\"document-front-with-signature-pre\"", "\"face\"", "\"face-pre\"", "\"face-nfc\"", "\"face-reference\"", "\"face-cropped\"", "\"address-front\"", "\"document-front-face-cropped\"", "\"registry-face\"" ]
Exampledocument-front
timestamp
string Deprecated

*Always returns None/null

Examplenull
size
number

Size of the uploaded media, in bytes

Example12345
mimetype
string

File type of the uploaded media, one of .jpg, .jpeg, .png, .heif, .heic, .webp or .pdf

Exampleimage/jpeg
url
string

Download URL of the media

Examplehttps://api.veriff.com/v1/media/d69a07cf-4434-4d36-be6c-d22af7dc01fb
sessionId
string

UUID v4 of the verification session the uploaded media belongs to

Exampled69a07cf-4434-4d36-be6c-d22af7dc01fb
videos
Array of object (VerificationSessionVideoUpload)
object
id
string (uuid)

UUID v4 which identifies the uploaded media

Exampled69a07cf-4434-4d36-be6c-d22af7dc01fb
name
string

Name which identifies the uploaded media

Valid values[ "\"document-and-face\"", "\"document-and-face-pre\"", "\"document-back\"", "\"document-back-pre\"", "\"document-front\"", "\"document-front-pre\"", "\"document-front-with-signature\"", "\"document-front-with-signature-pre\"", "\"face\"", "\"face-pre\"", "\"face-nfc\"", "\"face-reference\"", "\"face-cropped\"", "\"address-front\"", "\"document-front-face-cropped\"", "\"registry-face\"" ]
Exampleselfid_video
context
string

Context type of the uploaded media

Valid values[ "\"document-and-face\"", "\"document-and-face-pre\"", "\"document-back\"", "\"document-back-pre\"", "\"document-front\"", "\"document-front-pre\"", "\"document-front-with-signature\"", "\"document-front-with-signature-pre\"", "\"face\"", "\"face-pre\"", "\"face-nfc\"", "\"face-reference\"", "\"face-cropped\"", "\"address-front\"", "\"document-front-face-cropped\"", "\"registry-face\"" ]
Exampleselfid_video
timestamp
string Deprecated

*Always returns None/null

Examplenull
size
number

Size of the uploaded media, in bytes

Example12345
mimetype
string

File type of the uploaded media

Examplevideo/mp4
url
string

Download URL of the media

Examplehttps://api.veriff.com/v1/media/d69a07cf-4434-4d36-be6c-d22af7dc01fb
sessionId
string

UUID v4 of the verification session the uploaded media belongs to

Exampled69a07cf-4434-4d36-be6c-d22af7dc01fb
duration
number (integer)

Duration of the uploaded media, in seconds

Example12345
400

Bad request

object
status
string
Valid values[ "\"fail\"" ]
Examplefail
code
string
Example1101
message
string
ExampleValidation failed
401

Unauthorized

object
status
string
Valid values[ "\"fail\"" ]
Examplefail
code
string
Example1101
message
string
ExampleMandatory X-AUTH-CLIENT header containing the API key is missing from the request.
404

Session not found

object
status
string
Valid values[ "\"fail\"" ]
Examplefail
code
string
Example1101
message
string
ExampleResource not found
500

Internal server error

object
status
string
Valid values[ "\"fail\"" ]
Examplefail
code
string
Example1101
message
string
ExampleSomething went wrong



Document Versioning

Article Versioning

Date

Description

May 2, 2025

face-cropped image context type added


Mar 12, 2025

Documentation published