Sign in

v1

latestOpenAPI 3.0.02026-07-2667172347.6 KB
AML Screening & Monitoring

Create AML client profile

Use this endpoint to create an AML client profile and upload the client’s data for screening or monitoring. <br /><br /><img src="https://files.readme.io/310d4d3-Inline_Caution.svg" align="left" alt="Important" /> Important: Before using this endpoint, see the <a href="https://docs.fourthline.com/docs/aml-integration-api">integration guide</a>.

post/v2/clients

Headers

Authorizationstring required

The access_token returned in your most recent Create access token response.

Request body

providerClientIdstring required

Your unique identifier for the client. <br /><br />Format: No set format <br /><br /> <img src="https://files.readme.io/8eb9022-Inline_Tip.svg" align="left"/>Tip: This is the same value as your ClientNumberProvider.

monitoringType'1' | '2' required

The type of AML client. <br />Enum: <br />• 1: Screening <br />• 2: Monitoring

branchstring

Your configuration for this product. <br />Set the string provided by your Fourthline delivery manager.<br />If not set, we use your default configuration. <br /><br /><img src="https://files.readme.io/8eb9022-Inline_Tip.svg" align="left"/> Tip: Use this parameter for case configuration in older setups.

Response

The AML client profile was created successfully

idstring

Our unique identifier for the client, returned in the Create AML client profile response. <br /><br />Format: uuid string <br /><br />Example: 790f325a-48c9-4b82-bb53-c0ea128236f0

providerClientIdstring

Your unique identifier for the client. <br /><br />Format: No set format <br /><br /> <img src="https://files.readme.io/8eb9022-Inline_Tip.svg" align="left"/>Tip: This is the same value as your ClientNumberProvider.

monitoringTypestring

The type of AML client. <br />Enum: <br />• 1: Screening <br />• 2: Monitoring

creationUtcDateTimestring

The timestamp for when the client profile was created <br /><br />Format: ISO 8601 UTC date and time

updateUtcDateTimestring

The timestamp for when the client profile was last updated. <br /><br />Format: ISO 8601 UTC date and time