Verification Update Required Webhook

IDWise sends this webhook when a verification journey requires the user to resubmit one or more steps, either because a reviewer requested resubmission during manual review, or because a KYC renewal is due.

Webhook Trigger

Each time a step update is required, IDWise sends an HTTP POST request to your configured webhook URL with the following JSON payload:

{
  "event": "Verification Update Required",
  "body": {
    "eventId": "4****-****-****-*********7",
    "journeyId": "6720***********22e",
    "referenceNo": "840...........23",
    "systemDecision": "<SYSTEM_DECISION>",
    "manualDecision": "<MANUAL_DECISION>",
    "finalDecision": "<FINAL_DECISION>",
    "trigger": "<TRIGGER>",
    "requiredSteps": [
      {
        "stepId": "<STEP_ID>",
        "reasonCode": "<REASON_CODE>"
      }
    ]
  }
}

📘
The payload structure may be extended in the future. Ensure your webhook handler can safely ignore unknown fields to maintain forward compatibility.

Payload Fields

Top-Level Fields

Field	Type	Description
`event`	string	Always set to `"Verification Update Required"` for this webhook.
`body`	object	Contains the journey details and update information. See fields below.

Body Fields

Field	Type	Description
`eventId`	string	Unique identifier for the webhook event. Remains the same across retries to help you avoid duplicate processing.
`journeyId`	string	Unique ID for the verification journey.
`referenceNo`	string	Your internal reference number for the journey.
`systemDecision`	string	The automated decision made by IDWise. See decision values.
`manualDecision`	string	The decision made during manual review, if any. See decision values.
`finalDecision`	string	The final decision for the journey. If a manual review was performed, this mirrors the manual decision; otherwise, it matches the system decision.
`trigger`	string	Describes what triggered the update. See Trigger Values below.
`requiredSteps`	array	List of steps the user must resubmit. See Required Steps below.

Trigger Values

Trigger	Description
`Manual Review Resubmission`	A reviewer overrode the system's decision and requested the user to resubmit one or more steps.
`KYC Renewal`	The journey requires renewal based on your configured KYC renewal policy.

Required Steps

Each item in the requiredSteps array identifies a step the user must complete or resubmit:

Field	Type	Description
`stepId`	string	ID of the step that requires an update.
`reasonCode`	string	Reason code explaining why this step requires an update.

Updated about 1 hour ago