Updated Journey Webhook

🔄 Updated Journey Webhook

This webhook is triggered only after a journey is completed, when there is a change in the system decision or a compliance-driven update part of the manual review. It keeps your system in sync with important post-verification decision changes.

Webhook Trigger

Each time an update occurs in the journey's system, IDWise sends an HTTP POST request to your configured webhook URL with the following JSON payload:

{  
  "event": "Updated Journey",  
  "body": {
    "eventId":"4****-****-****-*********7", 
    "journeyId": "6720***********22e",
    "referenceNo": "840...........23",  
    "systemDecision": "<SYSTEM_DECISION>",  
    "manualDecision": "<MANUAL_DECISION>",  
    "finalDecision": "<FINAL_DECISION>",
    "action": "<ACTION>"
  }  
}

📘

Note

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

Payload Description

  • event: Always set to "Updated Journey" for this webhook.

  • body:

    • eventId: Unique identifier for the webhook event. It remains the same across retries to help you avoid duplicate processing.

    • journeyId: Unique ID for the verification journey.

    • referenceNo: Your internal reference number for the journey.

    • systemDecision: The automated decision made by IDWise. See decision values.

    • manualDecision: The decision made during manual review, if any. See decision values.

    • finalDecision: Reflects the final decision for the journey. If a manual review is performed, this mirrors the manual decision; otherwise, it matches the system decision.

    • action: Describes what triggered the update. Possible values included in the table below

      ActionDescriptionAdditional Payload Field
      Step UpdateA step was re-submitted or updated after journey completion—typically due to a resubmission request during manual review.N/A
      AML AmendTriggered when an AML record is manually amended or a new AML check is initiated by the compliance team.N/A
      AML OGM UpdateAn update occurred in ongoing AML monitoring.N/A
      AML Match UpdateTriggered when an AML match is either whitelisted or its status is changed during AML review.N/A
      Manual ReviewTriggered when a user manually overrides the system's decision by approving, rejecting, or requesting resubmission for a journey.manualReviewDetails

Additional Payload Field

  • Manual Review Payload
    When the action is Manual Review, the webhook body includes an extra object: manualReviewDetails. This object provides detailed context about the manual review decisions taken during the process.

    FieldDescription
    journeyReviewDecisionThe overall manual decision for the journey. Possible values: Approved, Rejected, Resubmission Requested.
    journeyReviewReasonCodeA code representing the reason for the manual review decision.
    reviewedStepsA list of step-level decisions reviewed during the manual review.

    Each item in reviewedSteps includes:

    FieldDescription
    stepIdID of the step that was manually reviewed.
    decisionDecision for the individual step. Values can be Approve or Resubmit.
    reasonCodeReason code explaining why this step decision was taken.