get https://api.sumsub.com/resources/applicants//status
Returns the applicant review status.
Overview
Use this method when utilizing the WebSDK or MobileSDK to get the review status. Both SDKs will show the rejection reasons and associated moderation comments.
To fetch the rejection comments, use this method.
Response explained
The response is a JSON file which includes the details of the current applicant verification status and check result.
Root variables
Root variables are the core applicant review data items. Some of them may include their own attributes and element fields.
| Field | Type | Description |
|---|---|---|
reviewId | String | A unique identifier of the applicant review in the Sumsub system. |
levelName | String | The name of the verification level an applicant has to go through. |
attemptId | String | A unique identifier of the current verification attempt. Applicants may initiate several attempts to get verified if, for example, they failed once or changed/added the documents, or you could change the verification level to start another check. |
attemptCnt | Integer | The counting number of the current verification attempt on the same verification level. |
elapsedSincePendingMs | Integer | Elapsed time since the applicant verification passed to the pending status. |
createDate | Date | Date and time (UTC) the applicant profile was created in the Sumsub system. |
reviewDate | Date | Date and time (UTC) the applicant check was completed. |
reviewResult | Object | Contains extra details of the applicant verification result. |
reviewStatus | String | Indicates the applicant review status. |
reviewResult attributes
reviewResult attributesThe following table includes the reviewResult attributes explaining the applicant verification result details.
| Field | Type | Description |
|---|---|---|
reviewAnswer | String | Explains the review result.
|
rejectLabels | Array of strings | Includes one or more reasons for rejection. The field is available if reviewAnswer returns RED.For more details, see Temporary rejection and Final rejection clarification. |
reviewRejectType | String | Indicates the type of rejection.
For more details, see Temporary rejection and Final rejection clarification. |
clientComment | String | A human-readable comment that explains the reasons for rejection in detail, and that must not be shown to the applicant. |
moderationComment | String | A human-readable comment that explains the reasons for rejection in detail, and that can be shown to the applicant. |
buttonIds | Array of strings | A list of button IDs that have been used for applicant rejection. A specific buttonId is automatically assigned to each rejection. For more details, see Temporary rejection and Final rejection clarification. |
Note
Mind that
reviewAnsweraffects the applicant only whenreviewStatus: completed.
Review statuses
The following table explains possible statuses for the reviewStatus attribute.
| Value | Description |
|---|---|
init | The applicant is created and the verification process is launched. At this moment, the initial registration has started but not all required documents are uploaded. For example, the applicant started to fill in a registration form on your web site or you have just added the applicant in the Dashboard. |
pending | The applicant is ready to be processed. It means that required documents are uploaded, the applicant profile contains necessary information and is now in a queue, waiting to be checked. |
prechecked | The check is half-way finished. At this step, the applicant profile is created and the uploaded documents have passed the initial quick check. For example, the system found and rejected a document photo due to its poor quality and then ceased verification to save time and resources on continuing validation of the entire applicant data. If the quick check did not find anything obviously wrong, verification continues. |
queued | The checks are in progress. |
completed | The check has been completed, and the review answer is given whether the applicant is approved or declined. |
onHold | Assistance from a compliance expert is required, and/or the applicant profile has been delegated to an administrator for manual check based on the criteria set by you. For example, certain data is incorrect or there are documents of the type you want to check on your side only and so on. In case of company verification, the company applicant could be waiting for all their beneficiaries to pass the KYC check. |