Get document images

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Overview

Use this method to receive the final verification images.

📘

Note

Since applicants can re-upload images and change the uploaded types of documents, it might be tricky for you to understand which images actually made the applicant pass or fail.

Required permissions

To use the method, you must have a role with the View applicant’s personal data permission.

Request example

curl -X GET \
     'https://api.sumsub.com/resources/applicants/5f649369aee05c75ea54c80a/resources/1045510331' \
     -H 'X-App-Token: <your-app-token>' \
     -H 'X-App-Access-Sig: <your-signature>' \
     -H 'X-App-Access-Ts: <unix-timestamp>'

Response explained

The response will contain a binary content representing the document. The Content-Type response header precisely describes the response mime-type. See our FAQ for a full list of mime-types and file formats.

Path Params
string
required

Unique applicant identifier in the Sumsub system.

This identifier is a random combination of 24 digits and lowercase Latin characters. It is automatically generated when the applicant is created on the Sumsub side, and can be found in the Dashboard.

If the applicantId is unknown to you, use the Get applicant data (externalUserId) method to fetch it.

string
required

Image identifier that represents the uploaded document.

You can get this identifier by using the following API method.

Query Params
boolean

If set to true, returns an image preview instead of the original image.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here!