Overview

Use this method in Sandbox mode to simulate changing the applicant review status to GREEN as if the applicant is approved, or RED as if the applicant is rejected.

This method can be helpful if, for example, you are practising automated testing and want to make sure that nothing will be broken when updating your code.

In effect, you simulate a positive or negative review answer and receive results via the applicantReviewed webhooks.

🚧

Attention

For the method to work, make sure to use the App token and Secret key pair that was created in Sandbox mode. The applicant profiles for testing must be created in Sandbox mode as well.

Request examples

curl -X POST \
  'https://api.sumsub.com/resources/applicants/5bb8cca10a975a624903cf65/status/testCompleted' \
  -H 'content-type: application/json' \
  -d '{
        "reviewAnswer" : "GREEN",
        "rejectLabels": []
      }
  '

curl -X POST \
  'https://api.sumsub.com/resources/applicants/5bb8cca10a975a624903cf65/status/testCompleted' \
  -H 'content-type: application/json' \
  -d '{
        "reviewAnswer": "RED",
        "rejectLabels": [
          "UNSATISFACTORY_PHOTOS",
          "SCREENSHOTS"
        ],
        "reviewRejectType": "RETRY",
        "clientComment": "Screenshots are not accepted.",
        "moderationComment": "We do not accept screenshots. Please upload an original photo."
      }
  '

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": "This method is only supported on sandbox env",
  "code": 400,
  "correlationId": "9183e216fd0550ae0db9a93cbbbbbb4e"
}

📘

Note

In case of HTTP response 200, you may ignore the response body.