Mark images as inactive

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

Overview

Use this method to mark an uploaded image of a document as inactive. In effect, you make the image as if deleted from the applicant profile, but it is just not taken into account for verification. You can always revert the image activity by this same method.

Replacements for inactive images can then be requested anew in the Web or Mobile SDK.

👍

Use case

Use this method in scenarios where you want your applicants to re-upload documents approved previously in the SDK.

📘

Note

Making images inactive while the applicant is being processed (in the pending, prechecked, or queued review status) will result in error and the 304 HTTP status.

Request example

curl -X DELETE \
     'https://api.sumsub.com/resources/inspections/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

If the request is successfully sent and processed, you will get the following response:

{
  "ok": 1
}

If the request fails, you will receive an HTTP response containing an error code along with a message explaining the error.

For example:

{
  "description": "HTTP 404 Not Found",
  "code": 404,
  "correlationId": "b628a7fbdf4fa487b26406e79e76f3f7"
}
  • If you specify a non-existing imageId, nothing will be modified.
  • In case of HTTP response 200, you may ignore the response body.

Path Params
string
required

Unique combination of digits and characters to identify all actions with the applicant’s ID documents. It is automatically added when the applicant profile is created in the Sumsub system.

You can fetch this identifier by getting the applicant data.

string
required

Image identifier that represents the uploaded document.

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

Query Params
boolean
Defaults to false

Determine the activity of the image:

  • false (default) — to mark the image as inactive.
  • true — to revert the specified image back to the active state.

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