Sign in

v1

latestOpenAPI 3.0.02026-07-2667172347.6 KB
AML Screening & Monitoring

Get AML client by your ID

Use this endpoint to get an AML client profile using your identifier: providerClientId.

get/v2/clients/ProviderClientId/{providerClientId}

Path parameters

providerClientIdstring required

Your unique identifier for the client, which you passed in the Create AML client profile request.

Query parameters

tenantstring

Your unique identifier.

Headers

Authorizationstring required

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

Cache-Controlstring

To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to no-cache.

Response

AML client returned

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