Receive results via API

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.

📘

Note

To see the full list of rejection labels, see this article.

An example webhook payload with a GREEN response:

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

An example webhook payload with a RED response:

{
  "applicantId": "69e5d579e37291e569b75ce5",
  "inspectionId": "69e5d579e37291e569b75ce5",
  "applicantType": "individual",
  "correlationId": "ffdf14510f0bdde909a2e5f9988f92ec",
  "levelName": "1doc",
  "sandboxMode": false,
  "externalUserId": "dash-6ccde837-640a-49b9-a2f9-f096f561744c",
  "type": "applicantReviewed",
  "reviewResult": {
    "reviewAnswer": "RED",
    "rejectLabels": [
      "BAD_PROOF_OF_IDENTITY"
    ],
    "reviewRejectType": "RETRY",
    "buttonIds": [
      "badDocument_suspiciousDocument",
      "badDocument"
    ]
  },
  "reviewStatus": "completed",
  "createdAt": "2026-04-30 08:04:23+0000",
  "createdAtMs": "2026-04-30 08:04:23.379",
  "clientId": "coolClientId"
}