Sign in

v1

latestOpenAPI 3.0.02026-07-2667172347.6 KB
AML Screening & Monitoring

Get investigation hits

Use this endpoint to get all hits for a specific investigation. <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>. <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-investigation-hits-v3">previous version</a>.

get/v4/WatchlistAutomation/GetVerificationHits/{verificationId}

Path parameters

verificationIdstring required

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

Response

Investigation hits returned

hitIdinteger

The unique identifier for this hit. If there are no hits, hitId is null. <br /><br />Format: 5 digits

resultstring

The outcome of the hit: <br />• confirmed_hit: Our investigation confirmed the hit is definitely for this client. <br />• false_positive: Our investigation found that a potential hit wasn’t for this client. <br />• validating: This is a potential hit. <br /><br /><img src="https://files.readme.io/ad2486a-Inline_Note.svg" align="left"/> Note: <br />If there are: <br />• Confirmed hits, the most recent confirmed hit is returned <br />• No confirmed hits but there are false positive hits, the most recent false positive is returned <br />• No confirmed or false positive hits but there are potential hits that have not (yet) been investigated, the most recent potential hit is returned with validating status

categoriesstring

The type of hit: <br />• AdverseMedia: An adverse media article hit <br />• Enforcement: A legal penalty hit <br />• Other: Other type of hit <br />• PEP: A <Glossary>PEP</Glossary> hit <br />• Sanctions: A sanctions hit <br /><br /><img src="https://files.readme.io/ad2486a-Inline_Note.svg" align="left"/> Note: More than one value can be returned.

processStartDatestring

The timestamp for when we started investigating the hit <br /><br />Format: ISO 8601 UTC date and time

processEndDatestring

The timestamp for when we finished investigating the hit. <br /><br />Format: ISO 8601 UTC date and time

statusCodeinteger

The status code for the screening/monitoring.

verificationIdstring

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