post https://api.eu.mesh.complyadvantage.com/v2/webhooks
This endpoint enables you to create a webhook that will monitor an event type and send updates to the URL you specify.
There are three event types you can listen to:
CASE_CREATED
Receive an update whenever a new case is created. Example:
{
"api_version": "v2",
"case_identifier": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"case_state": "CASE_STATE_NOT_STARTED",
"case_type": "CASE_TYPE_CUSTOMER_ONBOARDING"
}
CASE_STATE_UPDATED
Receive an update whenever a case changes its state, e.g. from "Not Started" to "In Progress". Example:
{
"api_version": "v2",
"case_identifier": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"case_state": "CASE_STATE_IN_PROGRESS",
"case_type": "CASE_TYPE_CUSTOMER_ONBOARDING"
}
WORKFLOW_COMPLETED
Receive an update when an onboarding workflow completes. Example:
{
{
"api_version": "v2",
"workflow_instance_identifier": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"status": "COMPLETED",
"step_details": {
"alerting": {
"identifier": null,
"status": "COMPLETED",
"step_output": {
"alerts": [
{
"identifier": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
]
}
},
"customer-creation": {
"identifier": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"status": "COMPLETED",
"step_output": {
"customer_identifier": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
},
"customer-screening": {
"identifier": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"status": "COMPLETED",
"step_output": {
"screening_result": "HAS_PROFILES"
}
},
"initial-risk-scoring": {
"identifier": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"status": "COMPLETED",
"step_output": {
"overall_level": "LOW-RISK",
"overall_value": 0
}
}
},
"steps": [
"customer-creation",
"initial-risk-scoring",
"customer-screening",
"alerting"
],
"workflow_type": "create-and-screen"
}
}