AML Monitor Update Webhook

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.
manualDecision: The outcome of a manual review.
finalDecision: The ultimate decision for the journey. It will contain the system_decision if there has not been manual review done. Otherwise it will contain the manual_decision.
previousSystemDecision: the journey system decision before the the AML update. it will have the same finalDecision values
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.

📘Note

📘
Note