Verification can either be passed or not passed and marked with a GREEN or RED flag, respectively. The results are delivered with the applicantReviewed webhook expected to arrive at average in 3-5 minutes upon verification, but in some cases can take up to 24 hours.

We recommend that you wait for the webhook no more than a day, and then send a request to our server for information about the applicant status.

Get started

The applicantReviewed webhook contains the reviewResult object that includes the reviewAnswer field, indicating the verification status. If it is GREEN, it means verification went well. If it is RED, additional fields are added:

• moderationComment — a human-readable comment that can be shown to your applicants. Note that some images may also contain additional document-specific comments, in which case the field might be empty. To get the additional comments, use this method.
• clientComment — a human-readable comment that should not be shown to your applicants. This field will contain applicant top-level comments and—if reviewRejectType is FINAL—it may also contain some private information which should not be shared with anyone except administrative personnel on the client side.
• rejectLabels — enumerates rejection labels.
• reviewRejectType — Indicates the type of rejection:
  • FINAL — indicates a final rejection, e.g. when the applicant is considered to be a fraudster, or a client does not want to accept such types of clients.
  • RETRY — applicants are allowed to resubmit their documents, e.g. by uploading an image of better quality.

An example webhook payload with the RED (final rejection) response:

{
  "applicantId": "5cb744200a975a67ed1798a4",
  "inspectionId": "5cb744200a975a67ed1798a5",
  "correlationId": "req-fa94263f-0b23-42d7-9393-ab10b28ef42d",
  "externalUserId": "externalUserId",
  "levelName": "id-and-liveness",
  "type": "applicantReviewed",
  "reviewResult": {
    "moderationComment": "We could not verify your profile. If you have any questions, please contact the Company where you try to verify your profile ${clientSupportEmail}",
    "clientComment": " Suspected fraudulent account.",
    "reviewAnswer": "RED",
    "rejectLabels": ["UNSATISFACTORY_PHOTOS", "GRAPHIC_EDITOR", "FORGERY"],
    "reviewRejectType": "FINAL"
  },
  "reviewStatus": "completed",
  "createdAtMs": "2020-02-21 13:23:19.001"
}

An example webhook payload with the GREEN (temporary rejection) response:

{
  "applicantId": "5cb56e8e0a975a35f333cb83",
  "inspectionId": "5cb56e8e0a975a35f333cb84",
  "correlationId": "req-a260b669-4f14-4bb5-a4c5-ac0218acb9a4",
  "externalUserId": "externalUserId",
  "levelName": "id-and-liveness",
  "type": "applicantReviewed",
  "reviewResult": {
    "reviewAnswer": "GREEN"
  },
  "reviewStatus": "completed",
  "createdAtMs": "2020-02-21 13:23:19.321"
}

Understand rejection

When applicants are rejected, their profiles are marked with rejection labels. Depending on the reason, applicants might be rejected either temporarily or finally.

In addition to the temporary and final rejection labels, we assign specific explanatory buttons clarifying the reason for rejection. Explanatory buttons may have a temporary or final rejection state. To get the list of explanatory buttons by applicantId, use this API method.

Temporary rejection labels

Temporary rejection usually occurs when the required documents are unsuitable or uploaded in poor quality.

Temporarily rejected applicants may correct any outstanding issues in accordance with the system instructions and attempt verification again.

The following table lists temporary rejection labels.

Final rejection labels

Final rejections are due to major violations of the verification rules, such as fraud attempts. Finally rejected applicants are blocked and cannot attempt verification again.

The following table lists final rejection labels.