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 when the applicant is in a category the client does not accept.
  • 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 Resubmission requested and Rejected.

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, we automatically assign rejection labels to their profile. We also assign explanatory buttons clarifying the reason for rejection. Explanatory buttons may have a Resubmission requested or Rejected state. To get the list of explanatory buttons by applicantId, use this API method.

❗️

Important

Rejection labels do not define the rejection type. Depending on the check, the same label can indicate either a Rejected or Resubmission requested status. To see the exact state:

• Refer to the reviewRejectType field in the applicantReviewed webhook.
• Refer to the reviewResult.reviewRejectType field in the response when getting the applicant review status.
• Refer to the review.reviewResult.reviewRejectType field in the response when requesting applicant data.