FOfourthline
Webhooks

AML Screening Webhooks

<img src="https://files.readme.io/ad2486a-Inline_Note.svg" align="left" alt="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. <br /><br />Webhook notifications for <a href="https://docs.fourthline.com/docs/aml-overview">AML Screening</a>. Configure the POST /aml endpoint on your server to receive screening and monitoring notifications. <br /><br /><img src="https://files.readme.io/ad2486a-Inline_Note.svg" align="left" alt="Note" /> Note: For setup instructions, see <a href="https://docs.fourthline.com/docs/webhooks">Webhooks</a>.

post/aml

Request

  • Base URL
    https://mysite.com/api/fourthline
  • URL
    https://mysite.com/api/fourthline/aml
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://example.com/token

Headers

Authorizationstring required

Your Basic or Bearer access token. <br />The examples we’ve provided show Bearer. <br /><br /><img src="https://files.readme.io/ad2486a-Inline_Note.svg" align="left"/>More information: Webhooks – Specify authentication method

Request body

hashstring

Not applicable

processTypestring required

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

status'completed' | 'doNotExist' | 'manualreviewrequired' | 'other' | 'pendingManualReview' | 'recentlyScreened' | 'scheduled' | 'screeningInProgress' | 'wrongMonitoringType' required

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

clientIdstring required

Our unique identifier for the AML client. <br /><br />Format: uuid string <br /><br />Example: 790f325a-48c9-4b82-bb53-c0ea128236f0 <br />Validations: uuid format, clientId exists <br />Errors: Format is incorrect or doesn’t exist

providerClientIdstring required

Your unique identifier for the AML client.

verificationIdstring

Our unique identifier for the investigation. <br /><br />Format: uuid string <br /><br />Example: 790f325a-48c9-4b82-bb53-c0ea128236f0

Response

Return HTTP 2xx to acknowledge receipt. See Handle webhook deliveries.

object required

A successful response is empty.

Changes

No recorded changes to this operation across all 1 revision of this API.