Classifications API

Classifying AML Match Results

After investigating the supplementaryData for any AML screening match details, you’ll need to make a decision on whether the person you are evaluating matches the person that we found during screening (true positive) or not (false positive).

To confirm whether an AML screening hit is true positive, false positive or unknown, you’ll need to update the manualStatus of the process result. The manualStatus is used to store any manually determined statuses on a result as not to override the initial result gathered as part of the workflow execution.

Example 1: Classify Single Match as True Positive

curl --location --request POST
'https://api.{{env}}.frankie.one/v2/individuals/{entityId}/results/{processResultId}' \
--header 'api_key: {{your_apiKey}}' \
--header 'X-Frankie-CustomerID: {{your_CustomerID}}' \
--header 'X-Frankie-CustomerChildID: {{your_CustomerChildID}}' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data-raw '{
  "processResults": [
    "{processResultId}"
  ],
  "manualStatus": "TRUE_POSITIVE"
}'

Example 2: Classify Multiple Matches as False Positive

curl --location --request POST
'https://api.{{env}}.frankie.one/v2/individuals/{entityId}/results/aml' \
--header 'api_key: {{your_apiKey}}' \
--header 'X-Frankie-CustomerID: {{your_CustomerID}}' \
--header 'X-Frankie-CustomerChildID: {{your_CustomerChildID}}' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data-raw '{
  "processResults": [
    "{processResultId}", "{processResultId}"
  ],
  "manualStatus": "FALSE_POSITIVE"
}'

On successful classification, FrankieOne will notify the relevant AML service provider of the true positive, false positive or unknown match status to ensure the same entities are no longer returned as additional matches.