Overview

Use this method to roll the applicant review status back to init (Documents requested). In effect, it means that documents uploaded by the applicant are marked as inactive and all statuses previously assigned are deleted.

Using this endpoint can be quite beneficial in scenarios where an applicant makes a support request to re-pass verification from scratch with new documents. This might be necessary if the applicant’s previous documents are outdated, incorrect, or if there have been significant changes in the applicant data that require re-verification.

❗️

Warning

Avoid resetting applicants with a final rejection. Such cases may involve restricted countries or potentially fraudulent applicants.

🚧

Attention

• You cannot reset applicants that are currently being checked and are in pending, queued, or prechecked review status.
• Let us know if you are going to use this method, as we may be able to suggest a better flow for your case.

📘

Note

The Change applicant status to init method also returns the applicant to init but is only intended for onHold cases with at least one grey Requested step. It allows to request missing documents without resetting previously uploaded files or completed steps.

😀

Did you know?

You can also reset an applicant profile from the Dashboard.

Request example

curl -X POST \
  'https://api.sumsub.com/resources/applicants/5d6f821b0a975a0b8aa27b27/reset'

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": "Invalid id '12313213'",
  "code": 400,
  "correlationId": "36d4c16cd06b6f673976b30000000000"
}

👍

Tip

You can trace the applicant profile has been reset in the Events section of the applicant page in the Dashboard.