Overview

Use this method to set an applicant status to Approved.

When invoked, the applicant status is updated in the Dashboard to Approved, and the API response reflects the following state changes:

• reviewStatus: "completed"
• reviewResult.reviewAnswer: "GREEN"

📘

Notes

• You can approve applicants via API regardless of their current status.
• This method approves an applicant without altering the status of verification steps, documents, images, or other associated data.
• Notes and tags are optional. You can send an empty request body.

Request example

curl -X POST \
     'https://api.sumsub.com/resources/applicants/687fb2373fc85ad66b5d8744/-/approve' \
     -H 'content-type: application/json' \
     -d '{
          "note": "This is an example note",
          "tags": [
            "First tag",
            "Second tag"
          ]
        }'

Response explained

If the request is sent and processed successfully, you will receive a JSON response representing the applicant profile with augmented and structured information.

You can see the response structure, possible content with descriptions, and examples of response on the following page.

If the request fails, you will receive an HTTP response containing an error code and a message explaining the error.
For example:

{
   "code": 409,
   "description": "When approving an applicant reasons must not be provided",
   "correlationId": "99d449b1e90a371c482dffa48fa0d6f5"
}