API Reference
API ReferenceChangelogFAQDashboard

Get signed document (QES)

get
https://api.sumsub.com/resources/applicants//esign/resources/
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Overview

Use this method to receive the signed client documents after Qualified Electronic Signature Verification.

Request example

curl -X GET \
     'https://api.sumsub.com/resources/applicants/applicantId/esign/resources/imageId' \
     -H 'accept: application/json' \
     -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 signed 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. Example response:

HTTP/1.1 200 OK
Date: Wed, 13 Nov 2024 10:44:38 GMT
Content-Type: application/pdf
Content-Length: 239371
Connection: keep-alive
x-correlation-id: 85e3033ee12d196b8400322e03e47b36
Content-Encoding: identity
content-disposition: attachment; filename=Terms+And+Conditions.pdf

<Binary content representing the signed document>

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 signed document.

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

Responses

Updated about 2 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago