SUsumsub

Simulate review response in Sandbox

post/resources/applicants/{applicantId}/status/testCompleted

Request

Path parameters

applicantIdstring required

Unique applicant identifier in the Sumsub system. <br><br>This identifier is a random combination of 24 digits and lowercase Latin characters. It is automatically generated when the applicant is created on the Sumsub side, and can be found in the Dashboard. <br><br>If the applicantId is unknown to you, use the Get applicant data (externalUserId) method to fetch it.

Request body

reviewAnswer'GREEN' | 'RED' required
<p>Label under which you want to simulate the response.</p><p><ul><li><code>GREEN</code> — to simulate a positive response as if the applicant is approved.</li><li><code>RED</code> — to simulate a negative response as if the applicant is rejected.</li></ul></p><p>For more information about receiving results via the <code>applicantReviewed</code> webhooks, see <a href="/docs/receive-and-interpret-results-via-api">this article</a>.</p>
rejectLabelsstring[]

Add rejection labels to specify the reason for rejection. Each string stands for a single label. <br><br>Rejection labels are required only if reviewAnswer is RED.

reviewRejectType'RETRY' | 'FINAL'
<p>If <code>reviewAnswer</code> is <code>RED</code>, indicate the type of rejection.</p><p><ul><li><code>FINAL</code> — <b>Rejected</b> status in case of major violations. The applicant cannot resubmit the documents for verification.</li><li><code>RETRY</code> — <b>Resubmission requested</b> status in case of minor violations. The applicant has a chance to upload new documents or resubmit correct data.</li></ul></p>
clientCommentstring

A human-readable comment that explains the reasons for rejection in detail. This comment must not be shown to the applicant.

moderationCommentstring

A human-readable comment that explains the reasons for rejection in detail. This comment can be shown to the applicant.

Changes

No recorded changes to this operation across all 2 revisions of this API.