After applicant verification is complete, we send you the results via the applicantReviewed webhook.

In this webhook, you can find the reviewResult object with the reviewAnswer field that indicates the verification status. If the status 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.
• reviewAnswer — explains the review result: GREEN — approved, RED — rejected.
• rejectLabels — enumerates rejection labels.
• reviewRejectType — Indicates the type of rejection:
  • FINAL — indicates a final rejection, for example, 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, for example, by uploading an image of better quality.
• buttonIds — specific identifiers that are automatically assigned to each rejection of an applicant or a document. For more details, see Temporary rejection and Final rejection.

An example webhook payload with a GREEN 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"
}

An example webhook payload with a 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": "Verification rejected due to excessive file uploads.",
    "reviewAnswer": "RED",
    "rejectLabels": [
      "UNSATISFACTORY_PHOTOS",
      "GRAPHIC_EDITOR",
      "FORGERY"
    ],
    "reviewRejectType": "FINAL",
    "buttonIds": [
      "selfie_badFaceComparison",
      "badPhoto",
      "additionalPages",
      "badDocument",
      "additionalPages_anotherSide",
      "badDocument_withoutFace",
      "badPhoto_screenshot",
      "selfie",
      "spam",
      "badPhoto_dataNotVisible"
    ]
  },
  "reviewStatus": "completed",
  "createdAtMs": "2020-02-21 13:23:19.001"
}

Understand rejection

When applicants are rejected, their profiles are marked with rejection labels. Depending on the reason, applicants may 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 can 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.