Skip to main content

Manual Review

Manual review lets authorized organization users resolve a document verification (DV) result that automated checks could not finalize. Keep the verification pending until the reviewer decision has been processed and a final webhook arrives.

How It Works​

  1. Flagging: A DV result that needs a person to decide is exposed by the API as REQUIRES_MANUAL_REVIEW.
  2. Notification: Zyphe sends a webhook with event: REVIEW, flowStatus: REVIEW, and data.dv.status: REVIEW.
  3. Review: An Admin or Operator opens Manual Review in the dashboard and inspects the submitted document, reasons, and available checks.
  4. Decision: The reviewer submits the API decision approved, rejected, or failed.
  5. Final event: After processing, Zyphe sends COMPLETED, REJECTED, or FAILED. Use that event, not the earlier REVIEW, as the final outcome in your product.
DV and KYB use different review vocabularies

REQUIRES_MANUAL_REVIEW and the REVIEW step status apply to document verification. KYB is reviewed as a case, with its own statuses (READY_FOR_REVIEW, ACTION_REQUIRED, APPROVED, REJECTED, and so on) and its own decision rules. See Reviewing KYB cases and Statuses and codes.

Review Statuses​

Reviewer decisionFinal webhookMeaning
approvedCOMPLETEDThe reviewer accepts the document verification result.
rejectedREJECTEDThe reviewer explicitly declines the result.
failedFAILEDThe verification cannot be completed, for example due to quality.

Permissions​

The customer organization roles that can perform DV manual review are:

  • Admin (ORG_ADMIN): full organization access, including manual review.
  • Operator (ORG_OPERATOR): can inspect and decide results waiting for manual review.

Platform administrators are internal Zyphe personnel, not a customer organization role. The full customer role matrix is maintained in Manage Users.

Webhook Events​

  • REVIEW: sent when a DV result is flagged; keep the user pending.
  • COMPLETED, FAILED, or REJECTED: sent after the reviewer decision is processed and represents the final outcome.