🚀 Welcome to our revamped documentation featuring dedicated Business Logic and API sections with improved layouts—please remember to update your bookmarks as old links will no longer work!
API Reference
Endpoints
Webhooks
- HOOKCustomer sanctions screening pending
- HOOKCustomer pep screening pending
- HOOKCustomer adverse media screening pending
- HOOKCustomer internal list screening pending
- HOOKCustomer sanctions screening completed
- HOOKCustomer pep screening completed
- HOOKCustomer adverse media screening completed
- HOOKCustomer internal list screening completed
{
"sanctioned": true,
"externalId": "bb2274b1-6804-41f3-9e6f-81b9eb6700e3",
"screeningMatch": true,
"screeningGuid": "0199bee4-a5e6-71d6-8f81-9bd85806942b"
}Customer Screening
Customer sanctions screening completed
Fired when on completion by a human decision/automatically resolution.
WEBHOOK
app.amlyze.customer.screening.sanctions.completed
{
"sanctioned": true,
"externalId": "bb2274b1-6804-41f3-9e6f-81b9eb6700e3",
"screeningMatch": true,
"screeningGuid": "0199bee4-a5e6-71d6-8f81-9bd85806942b"
}Documentation Index
Fetch the complete documentation index at: https://api.amlyze.com/llms.txt
Use this file to discover all available pages before exploring further.
Body
application/json
Customer external id.
Example:
"49187e79-e3be-4bc4-82e3-571f3b8a073e"
Indicates if the screening process found any matches.
Example:
true
Identifier of the screening alert. Only returned if there is a match.
Example:
"af1dc86a-2135-47f7-980c-840ae59ad138"
Customer sanctioned or not.
Example:
true
⌘I