Overview

Use this method to restore (reactivate) an uploaded document image that was previously marked as inactive.

After a successful call:

• The image is active again. It is shown among the applicant's active documents in API responses and in the Dashboard, and it is used in verification.
• If the document contains an address, the address is added back to the applicant's data (marking an image as inactive removes it).
• The applicant's review status may be re-evaluated, the same way as after an image is marked as inactive.
• An entry about the image presence change (status activated) is added to the applicant's activity log. Note that the log entry is written only when the image actually changes state, so a repeat call on an already-active image adds nothing.

Use case

Use this method when you need to bring back document images that were deactivated (for example, after an applicant reset) without asking the applicant to upload them again.

Required permissions

To use this method, your app token must have the Change applicant's personal data permission.

Rate limit

This method is limited to 60 requests per 60 seconds. Requests over the limit are rejected with the 429 HTTP status.

Request example

curl -X POST \
     'https://api.sumsub.com/resources/applicants/5b594ade0a975a36c0000000/resources/1234567890/restore' \
     -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, when the applicant is currently in review:

{
  "description": "Unable to delete image while applicant in review",
  "code": 1013,
  "correlationId": "b628a7fbdf4fa487b26406e79e76f3f7"
}

Possible errors