Get all client hits

get

https://api.ext-sandbox.fourthline.com/v4/WatchlistAutomation/GetClientHits/{clientId}

Use this endpoint to get a list of all hits for a specific client.

Note Note: This is a new version of this endpoint. See also the previous version.

Path Params

clientId

string

required

Our unique identifier for the client, returned in the Create AML client profile response.

Format: uuid string

Example: 790f325a-48c9-4b82-bb53-c0ea128236f0

Query Params

hitResult

string

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

hitKind

string

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

hitsSinceUtc

date

Filter hits by date.
Set the start date of the time frame you want to view hits for, including on this date.

Format: YYYY-MM-DD

hitsUntilUtc

date

Filter hits by date
Set the end date of the time frame you want to view hits for, including on this date.

Format: YYYY-MM-DD

Responses

200Client hits returned

400Invalid request parameters