Sign in

v1

latestOpenAPI 3.0.02026-07-2667172347.6 KB
AML Screening & Monitoring

Get all client hits

Use this endpoint to get a list of all hits for a specific client. <br /><br /><img src="https://files.readme.io/ad2486a-Inline_Note.svg" align="left" alt="Note" /> Note: This is a new version of this endpoint. See also the <a href="ref:get-all-client-hits-v3">previous version</a>.

get/v4/WatchlistAutomation/GetClientHits/{clientId}

Path parameters

clientIdstring required

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

Query parameters

hitResultstring

Filter hits by status. <br /> Enum: <br />• confirmed_hit: Confirmed hits <br />• false_positive: False positive hits <br />• validating: Hits under investigation <br />• Or leave empty

hitKindstring

Filter hits by type of hit. <br /> Enum: <br />• AdverseMedia: An adverse media hit <br />• Enforcement: A legal penalty hit <br />• Other: Any other type of hit <br />• PEP: A <Glossary>PEP</Glossary> hit <br />• Sanctions: A sanctions hit

hitsSinceUtcstring date

Filter hits by date. <br />Set the start date of the time frame you want to view hits for, including on this date. <br /><br />Format: YYYY-MM-DD

hitsUntilUtcstring date

Filter hits by date <br />Set the end date of the time frame you want to view hits for, including on this date. <br /><br />Format: YYYY-MM-DD

Headers

Authorizationstring required

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

Response

Client hits returned

OR