AML Monitor Update Webhook

Overview

This webhook is triggered whenever an AML match is updated as part of Ongoing Monitoring. Updates may include newly added matches, removed entries, or updates to match risk details.

The webhook allows you to react in real-time to any changes in an individual's AML screening status without needing to poll the system.

📘

Use case:

Ideal for compliance teams to receive instant alerts when an individual's AML profile changes post-onboarding due to new sanctions, watchlists, or PEP updates.

Payload

The IDWise backend will send a JSON HTTP POST request to the webhook configured, with the following details:

{  
  "event": "AML Monitor Update",  
  "body": {
    "eventId":"4****-****-****-*********7", 
    "journeyId": "6720***********22e",
    "referenceNo": "840...........23",
    "systemDecision": "<SYSTEM_DECISION>",
    "previousSystemDecision": "<PREVIOUS_SYSTEM_DECISION>",
    "updatedAMLVersionNumber":**1**
    
  }  
}

📘

Note

Please note this object might be extended with extra elements. Ensure your code can accommodate any extra elements introduced to this payload object.

The JSON object provided contains information about certain events in the ID verification process. Here is the explanation of its elements:

• event: Identifies the type of event that triggered this webhook. For AML monitor update webhook this will always be AML Monior Update.

Inside the body element you find these elements:

• eventId: A unique identifier to identify this event instance. Should the event be attempted again, the eventId will consistently remain unchanged throughout all retry attempts.

• journeyId: A unique identifier for the journey, a specific instance of the verification process.

• referenceNo: The reference number associated with the journey.

• systemDecision: The automated decision by the IDWise system based on the inputs received.

• previousSystemDecision: the journey system decision before the the AML update.

• updatedAMLVersionNumber: An integer representing the version of the AML status update. This value increments by 1 with each ongoing monitoring update for this applicant. you can use this version to fetch the updated matches by this API.

How to Fetch the Updated AML Matches

To retrieve the latest changes in AML matches, use the AML History API, which fetches only the changes specific to that version (use updatedAMLVersionNumber from the payload).