AML Screening Webhooks

Webhook notifications for AML Screening. Configure the POST /aml endpoint on your server to receive screening and monitoring notifications.

Note Note: For setup instructions, see Webhooks.

Body Params
string

Not applicable

string
required
Defaults to DailyWatchlistAutomation

The type of workflow.
Expected value: Always DailyWatchlistAutomation = AML Screening or Monitoring
Validation: Expected value
Errors: Must be set to DailyWatchlistAutomation.

sla
object

Information about the SLA for our investigation(s).

string
enum
required

The screening/monitoring status.
Validation: Valid enum value
Errors: Invalid enum value.

string
required

Our unique identifier for the AML client.

Format: uuid string

Example: 790f325a-48c9-4b82-bb53-c0ea128236f0
Validations: uuid format, clientId exists
Errors: Format is incorrect or doesn’t exist

string
required

Your unique identifier for the AML client.

string

Our unique identifier for the investigation.

Format: uuid string

Example: 790f325a-48c9-4b82-bb53-c0ea128236f0

messages
array of objects
required

Information about any completed investigations.

messages*
uncompletedMessages
array of objects
required

Information about any incomplete investigations.

uncompletedMessages*
Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json