Mark images as inactive

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'

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.
Language
Credentials
Header
Click Try It! to start a request and see the response here!