AML Screening Webhooks

post

https://mysite.com/aml

Note Note: AML Screening & Monitoring is a separate API. Use these endpoints whether your workflows use API v1 or API v2. The requests, fields, and identifiers are the same.

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

hash

string

Not applicable

processType

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).

status

string

enum

required

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

clientId

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

providerClientId

string

required

Your unique identifier for the AML client.

verificationId

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

200Your server acknowledges receipt. Return HTTP 2xx (typically 200) with an empty body ({}) or no body.

401Fourthline could not authenticate with your webhook endpoint. See troubleshooting.

403Fourthline could not authenticate with your webhook endpoint. See troubleshooting.

404Fourthline can reach your server, but the webhook endpoint could not be found. See troubleshooting.

500Your server received the request but could not process it successfully. See troubleshooting.