Understanding Anti-Money Laundering (AML) | FrankieOne

Understanding Anti-Money Laundering (AML) Results

Anti-Money Laundering (AML) checks are an integral part of compliance workflows conducted through FrankieOne. These workflows are designed to provide a comprehensive evaluation by combining a series of automated checks and processes. AML checks play a pivotal role in these workflows, which may also include identity verification (IDV), risk assessments, and other compliance-related procedures. Together, these components ensure a robust approach to combating financial crimes and meeting regulatory requirements.

For specific use cases, AML checks can also be executed independently. This flexibility allows organizations to focus exclusively on AML compliance without incorporating additional checks or processes.

AML Check Results

The results of an AML check are presented in a structured format, providing comprehensive insights into matched entities and their associated details. The results are organized into the following key sections:

Workflow Execution Details: Includes metadata about the workflow execution, such as the request ID, workflow name, execution state, and timestamps for when the check started and ended.
Workflow Step Results: Details the outcomes of each step in the workflow, including the AML check. This section highlights the step name, object type, and the status of the check.
Workflow Step Summary: Summarizes the AML check results, including metrics such as the total number of hits, false positives, true positives, and unresolved cases. It also provides a breakdown of results by service provider.
Process Results: Lists matches identified during the AML check. Each match is represented by a Process Results Object (PRO), which contains detailed information about the matched individual or entity, including supplementary data and reference documentation.
Risk Assessment: Evaluates the risk associated with the matched entities, detailing risk factors, risk levels, and any relevant contextual information.
Notes and Comments: Allows users to add contextual notes or comments related to the AML check, offering additional insights or clarifications about the results.
Errors: Lists any errors encountered during the AML check, helping to identify and address potential issues in the process.

Workflow Execution Details

The workflow execution details provide essential metadata about the AML check, including the request ID, workflow name, execution state, and timestamps for when the check started and ended. This information is crucial for tracking and auditing purposes. This is the first section of the results and includes the following fields:

Field Name	Description
`workflowResult`	Summary of the workflow’s execution.
`schemaVersion`	The version of the schema.
`workflowName`	The name of the workflow. (Read-only)
`workflowExecutionId`	The unique identifier for the workflow execution.
`workflowExecutionState`	The current state of the workflow execution.
`status`	Outcome of this workflow execution. Possible values include: `UNCHECKED`, `IN_PROGRESS`, `REVIEW`, `PASS`, `FAIL`, `COMPLETE`, `INCOMPLETE`, `NEEDS_APPROVAL`, `APPROVED`, `REJECTED`, `BLOCKED`, `CLEAR`, `URGENT`, `MONITOR`.
`statusOverrideAt`	Timestamp of when the status override occurred.
`statusOverrideRequestId`	The request ID of the override request. Indicates if the status has been manually changed.
`statusOverrideBy`	Identifies the user who performed the override (may not always be present).
`riskAssessment`	Details about the risk assessment.
`isManual`	Indicates if the workflow execution was manually triggered.
`steps`	Details about the steps in the workflow execution.
`startedAt`	The timestamp when the workflow execution was started.
`endedAt`	The timestamp when the workflow execution was ended.
`issues`	List of issues encountered during the workflow execution.
`lifecyclePhase`	The lifecycle phase of the customer in which this workflow was executed. Possible values: `ONBOARDING`, `MONITORING`, `OTHER`.
`monitoringTypes`	Types of monitoring associated with the workflow.
`workflowId`	The unique identifier for the workflow.
`requestId`	The unique identifier for the request.
`entityId`	The unique identifier for the entity.
`entityType`	The type of entity within Frankie. Possible values: `INDIVIDUAL`, `ORGANIZATION`, `UNKNOWN`.
`serviceProfileId`	The unique identifier for the service profile.
`endWorkflowId`	The unique identifier for the end workflow.
`endWorkflowName`	The name of the end workflow.
`workflowStepResults`	Results of the steps in the workflow execution.
`result`	Outcome of this workflow execution. Possible values include: `UNCHECKED`, `IN_PROGRESS`, `REVIEW`, `PASS`, `FAIL`, `COMPLETE`, `INCOMPLETE`, `NEEDS_APPROVAL`, `APPROVED`, `REJECTED`, `BLOCKED`, `CLEAR`, `URGENT`, `MONITOR`.
`errors`	List of errors encountered during the workflow execution.
`notes`	Custom attributes or notes related to the workflow execution.
`createdAt`	The timestamp when the workflow execution was created.
`updatedAt`	The timestamp when the workflow execution was last updated.
`updatedBy`	The user who last updated the workflow execution.

Example Workflow Results

1 {
2   "requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
3   "workflowResult": {
4     "schemaVersion": 0,
5     "workflowName": "string",
6     "workflowExecutionId": "string",
7     "workflowExecutionState": "COMPLETED",
8     "status": "UNCHECKED",
9     "statusOverrideAt": "2025-05-09T01:51:56.000Z",
10     "statusOverrideRequestId": "string",
11     "statusOverrideBy": "string",
12     "riskAssessment": {..},
13     "isManual": true,
14     "steps": {..},
15     "startedAt": "2025-05-09T01:51:56.000Z",
16     "endedAt": "2025-05-09T01:51:56.000Z",
17     "issues": [
18       {..},
19       {..}
20     ],
21     "lifecyclePhase": "ONBOARDING",
22     "monitoringTypes": [
23       "AML"
24     ],
25     "workflowId": "string",
26     "requestId": "string",
27     "entityId": "string",
28     "entityType": "INDIVIDUAL",
29     "serviceProfileId": "string",
30     "endWorkflowId": "string",
31     "endWorkflowName": "string",
32     "workflowStepResults": [
33       {
34         "stepResultId": "string",
35         "workflowExecutionId": "string",
36         "stepName": "string",
37         "requestId": "string",
38         "objectType": "NAME",
39         "objectId": "string",
40         "schemaVersion": 0,
41         "startedAt": "2025-05-09T01:51:56.000Z",
42         "endedAt": "2025-05-09T01:51:56.000Z",
43         "serviceProviders": [
44           {..},
45           {..}
46         ],
47         "result": "UNCHECKED",
48         "errors": [
49           {..},
50           {..}
51         ],
52         "summary": {
53           "totalHits": 0,
54           "totalFalsePositives": 0,
55           "totalTruePositives": 0,
56           "totalUnknowns": 0,
57           "totalUnresolved": 0,
58           "numUnresolvedPEP": 0,
59           "numUnresolvedSanction": 0,
60           "numUnresolvedWatchlist": 0,
61           "numUnresolvedAdverseMedia": 0,
62           "providerSummaries": [
63             {
64               "name": "string",
65               "lastRetrievedAt": "2025-05-09T01:51:56.000Z",
66               "numHits": 0,
67               "numFalsePositives": 0,
68               "numTruePositives": 0,
69               "numUnknowns": 0,
70               "numUnresolved": 0,
71               "pepCountries": {
72                 "AUS",
73                 "NZ",
74                 },
75               "sanctionCountries": {
76                 "AUS",
77                 "NZ",
78                 },
79               "watchlistCountries": {
80                 "AUS",
81                 "NZ",
82                 },
83               "adverseMediaCountries":: {
84                 "AUS",
85                 "NZ",
86                 },
87               "numUnresolvedPEP": 0,
88               "numUnresolvedSanction": 0,
89               "numUnresolvedWatchlist": 0,
90               "numUnresolvedAdverseMedia": 0,
91               "searchQuery": {..}
92             }
93           ],
94           "stepName": "AML Check",
95         },
96         "risk": {..},
97         "notes": {..},
98         "processResults": [
99           {
100             "processResultId": "string",
101             "schemaVersion": 0,
102             "entityId": "string",
103             "requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
104             "stepName": "string",
105             "stepType": "string",
106             "objectType": "string",
107             "objectId": "string",
108             "createdAt": "2025-05-09T01:51:56.000Z",
109             "updatedAt": "2025-05-09T01:51:56.000Z",
110             "groupId": "string",
111             "providerResult": {..},
112             "result": "HIT",
113             "class": "AML",
114             "supplementaryData": {
115               "type": "AML",
116               "serviceProvider": "string",
117               "searchId": "string",
118               "caseId": "string",
119               "referenceId": "string",
120               "originalStepSearchLevel": "string",
121               "groupingId": "string",
122               "reportUrl": "string",
123               "fuzziness": {
124                 "normalized": 100,
125                 "actual": "string"
126               },
127               "matchData": {
128                 "strength": 0,
129                 "spReferenceId": "string",
130                 "name": "string",
131                 "givenName": "string",
132                 "otherName": "string",
133                 "familyName": "string",
134                 "date": "string",
135                 "address": "string",
136                 "countries": [
137                   {
138                     "code": "str",
139                     "matchType": "string"
140                   }
141                 ],
142                 "nationalId": {
143                   "idNumber": "string",
144                   "idType": "string",
145                   "idExpiry": "string",
146                   "issuingCountryCode": "string",
147                   "documentId": "string"
148                 },
149                 "imageUrl": "string",
150                 "isDeceased": true,
151                 "isAlias": true,
152                 "isRelated": true
153               },
154               "aliases": [
155                 "string"
156               ],
157               "relatedParties": [
158                 {
159                   "name": "string",
160                   "relationship": "string"
161                 }
162               ],
163               "referenceDocs": [
164                 {
165                   "url": "string",
166                   "description": "string"
167                 }
168               ],
169               "notes": {..},
170               "pepData": [
171                 {
172                   "countryCode": "string",
173                   "countryName": "string",
174                   "sourceName": "string",
175                   "level": "string",
176                   "sourceUrl": "string",
177                   "position": "string",
178                   "positionDescription": "string",
179                   "status": "string",
180                   "listingStart": "string",
181                   "listingEnd": "string",
182                   "imageUrl": "string",
183                   "referenceDocs": [
184                     {
185                       "url": "string",
186                       "description": "string"
187                     }
188                   ],
189                   "additionalData": [
190                     {
191                       "key": "string",
192                       "value": "string"
193                     }
194                   ]
195                 }
196               ],
197               "sanctionData": [
198                 {
199                   "countryCode": "string",
200                   "countryName": "string",
201                   "sourceName": "string",
202                   "sourceUrl": "string",
203                   "sourceReason": "string",
204                   "listingStart": "string",
205                   "listingEnd": "string",
206                   "imageUrl": "string",
207                   "referenceDocs": [
208                     {
209                       "url": "string",
210                       "description": "string"
211                     }
212                   ],
213                   "additionalData": [
214                     {
215                       "key": "string",
216                       "value": "string"
217                     }
218                   ]
219                 }
220               ],
221               "watchlistData": [
222                 {
223                   "countryCode": "string",
224                   "countryName": "string",
225                   "sourceName": "string",
226                   "sourceUrl": "string",
227                   "sourceReason": "string",
228                   "listingStart": "string",
229                   "listingEnd": "string",
230                   "imageUrl": "string",
231                   "referenceDocs": [
232                     {
233                       "url": "string",
234                       "description": "string"
235                     }
236                   ],
237                   "additionalData": [
238                     {
239                       "key": "string",
240                       "value": "string"
241                     }
242                   ]
243                 }
244               ],
245               "mediaData": [
246                 {
247                   "title": "string",
248                   "snippet": "string",
249                   "source": "string",
250                   "sourceDate": "string",
251                   "sourceCountry": "string",
252                   "url": "string",
253                   "isCurrent": true
254                 }
255               ]
256             },
257             "errors": [
258               {..},
259               {..}
260             ],
261             "notes": {..},
262             "systemStatus": "VALID",
263             "manualStatus": "TRUE_POSITIVE",
264             "state": "IN_PROGRESS",
265             "riskFactors": [
266               {..},
267               {..}  
268             ],
269             "updatedBy": "string"
270           }
271         ],
272         "createdAt": "2025-05-09T01:51:56.000Z",
273         "updatedAt": "2025-05-09T01:51:56.000Z",
274         "updatedBy": "string"
275       }
276     ],
277     "result": "UNCHECKED",
278     "errors": [
279       {..},
280       {..}
281     ],
282     "notes": {..},
283     "createdAt": "2025-05-09T01:51:56.000Z",
284     "updatedAt": "2025-05-09T01:51:56.000Z",
285     "updatedBy": "string"
286   },
287 }

Workflow Step Results

The workflow step results provide detailed information about the outcomes of each step in the workflow, including the AML check. This section highlights the step name, object type, and the status of the check. The results are organized into the following key sections:

Field Name	Description
`stepResultId`	The unique identifier for the step result.
`workflowExecutionId`	The unique identifier for the workflow execution.
`stepName`	The name of the step, written in SCREAMING_SNAKE_CASE.
`requestId`	The unique identifier for the request.
`objectType`	The type of primary object that was checked. Possible values include: `NAME`, `ADDRESS`, `DATE_OF_BIRTH`, `ORGANIZATION`, `DOCUMENT`, `EMAIL`, `PHONE_NUMBER`, `INDIVIDUAL`.
`objectId`	The unique identifier for the object being checked.
`schemaVersion`	The version of the schema.
`startedAt`	The timestamp when the step started.
`endedAt`	The timestamp when the step ended.
`serviceProviders`	A list of service providers involved in the step.
`result`	The overall result of the step. Possible values include: `UNCHECKED`, `SKIPPED`, `MISSING_DATA`, `PASS`, `FAIL`, `COMPLETE`, `INCOMPLETE`, `MATCH`, `NO_MATCH`, `PARTIAL`, `CLEAR`, `HIT`, `CLEARED`, `EXPIRED`, `NOT_APPLICABLE`, `ERROR`.
`errors`	A list of errors encountered during the step.
`summary`	A summary of the step’s results, including metrics and provider summaries.
`risk`	The risk assessment details for the step.
`notes`	Custom attributes or notes related to the step.
`processResults`	A list of process results generated during the step.
`createdAt`	The timestamp when the step result was created.
`updatedAt`	The timestamp when the step result was last updated.
`updatedBy`	The user who last updated the step result.

Example Step Results

1 {
2   "stepResultId": "string",
3   "workflowExecutionId": "string",
4   "stepName": "string",
5   "requestId": "string",
6   "objectType": "NAME",
7   "objectId": "string",
8   "schemaVersion": 0,
9   "startedAt": "2025-05-09T01:51:56.000Z",
10   "endedAt": "2025-05-09T01:51:56.000Z",
11   "serviceProviders": [
12     {
13       "provider": "string",
14       "result": "string",
15       "order": 0,
16       "startedAt": "2025-05-09T01:51:56.000Z",
17       "endedAt": "2025-05-09T01:51:56.000Z"
18     }
19   ],
20   "result": "UNCHECKED",
21   "errors": [
22     {
23       "code": "string",
24       "description": "string",
25       "location": "string"
26     }
27   ],
28   "summary": {
29     "matchedRules": [
30       {
31         "ruleName": "default",
32         "ruleOrder": 1,
33         "ruleMatches": [
34           {
35             "matchTypes": {
36               "additionalProp1": {
37                 "objectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
38                 "objectType": "string",
39                 "matchCount": 1,
40                 "matchSources": [
41                   "string"
42                 ],
43                 "nonMatchSources": [
44                   "string"
45                 ],
46                 "isChecked": true,
47                 "isVerified": true
48               },
49               "additionalProp2": {
50                 "objectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
51                 "objectType": "string",
52                 "matchCount": 1,
53                 "matchSources": [
54                   "string"
55                 ],
56                 "nonMatchSources": [
57                   "string"
58                 ],
59                 "isChecked": true,
60                 "isVerified": true
61               },
62               "additionalProp3": {
63                 "objectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
64                 "objectType": "string",
65                 "matchCount": 1,
66                 "matchSources": [
67                   "string"
68                 ],
69                 "nonMatchSources": [
70                   "string"
71                 ],
72                 "isChecked": true,
73                 "isVerified": true
74               }
75             },
76             "matchCount": 2,
77             "matchCountRequired": 1,
78             "hasAllRequiredSourcesMatched": true,
79             "requiredSourcesMatched": [
80               "string"
81             ],
82             "requiredSourcesNotMatched": [
83               "string"
84             ],
85             "isVerified": false,
86             "matchDetails": [
87               {
88                 "provider": "string",
89                 "source": "string",
90                 "attributesMatched": [
91                   "string"
92                 ]
93               }
94             ],
95             "nonMatchDetails": [
96               {
97                 "provider": "string",
98                 "source": "string",
99                 "attributesMatched": [
100                   "string"
101                 ]
102               }
103             ]
104           }
105         ]
106       }
107     ],
108     "unmatchedRules": [
109       {
110         "ruleName": "default",
111         "ruleOrder": 1,
112         "ruleMatches": [
113           {
114             "matchTypes": {
115               "additionalProp1": {
116                 "objectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
117                 "objectType": "string",
118                 "matchCount": 1,
119                 "matchSources": [
120                   "string"
121                 ],
122                 "nonMatchSources": [
123                   "string"
124                 ],
125                 "isChecked": true,
126                 "isVerified": true
127               },
128               "additionalProp2": {
129                 "objectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
130                 "objectType": "string",
131                 "matchCount": 1,
132                 "matchSources": [
133                   "string"
134                 ],
135                 "nonMatchSources": [
136                   "string"
137                 ],
138                 "isChecked": true,
139                 "isVerified": true
140               },
141               "additionalProp3": {
142                 "objectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
143                 "objectType": "string",
144                 "matchCount": 1,
145                 "matchSources": [
146                   "string"
147                 ],
148                 "nonMatchSources": [
149                   "string"
150                 ],
151                 "isChecked": true,
152                 "isVerified": true
153               }
154             },
155             "matchCount": 2,
156             "matchCountRequired": 1,
157             "hasAllRequiredSourcesMatched": true,
158             "requiredSourcesMatched": [
159               "string"
160             ],
161             "requiredSourcesNotMatched": [
162               "string"
163             ],
164             "isVerified": false,
165             "matchDetails": [
166               {
167                 "provider": "string",
168                 "source": "string",
169                 "attributesMatched": [
170                   "string"
171                 ]
172               }
173             ],
174             "nonMatchDetails": [
175               {
176                 "provider": "string",
177                 "source": "string",
178                 "attributesMatched": [
179                   "string"
180                 ]
181               }
182             ]
183           }
184         ]
185       }
186     ],
187     "stepName": "string"
188   },
189   "risk": {
190     "level": "string",
191     "contributedScore": 0,
192     "overallScore": 0,
193     "factors": [
194       {
195         "factor": "string",
196         "score": 0,
197         "value": "string"
198       }
199     ]
200   },
201   "notes": {
202     "additionalProp1": {
203       "type": "string",
204       "value": "string"
205     },
206     "additionalProp2": {
207       "type": "string",
208       "value": "string"
209     },
210     "additionalProp3": {
211       "type": "string",
212       "value": "string"
213     }
214   },
215   "processResults": [
216     {
217       "processResultId": "string",
218       "schemaVersion": 0,
219       "entityId": "string",
220       "requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
221       "stepName": "string",
222       "stepType": "string",
223       "objectType": "string",
224       "objectId": "string",
225       "createdAt": "2025-05-09T01:51:56.000Z",
226       "updatedAt": "2025-05-09T01:51:56.000Z",
227       "groupId": "string",
228       "providerResult": {
229         "name": "string",
230         "source": "string",
231         "sourceNormalized": "string",
232         "reference": "string",
233         "fuzziness": {
234           "normalized": 100,
235           "actual": "string"
236         },
237         "confidence": {
238           "normalized": 100,
239           "actual": "string"
240         },
241         "riskScore": 0,
242         "errorCode": "string",
243         "errorMessage": "string"
244       },
245       "result": "MATCH",
246       "class": "KYC",
247       "supplementaryData": {
248         "type": "AML",
249         "serviceProvider": "string",
250         "searchId": "string",
251         "caseId": "string",
252         "referenceId": "string",
253         "originalStepSearchLevel": "string",
254         "groupingId": "string",
255         "reportUrl": "string",
256         "fuzziness": {
257           "normalized": 100,
258           "actual": "string"
259         },
260         "matchData": {
261           "strength": 0,
262           "spReferenceId": "string",
263           "name": "string",
264           "givenName": "string",
265           "otherName": "string",
266           "familyName": "string",
267           "date": "string",
268           "address": "string",
269           "countries": [
270             {
271               "code": "str",
272               "matchType": "string"
273             }
274           ],
275           "nationalId": {
276             "idNumber": "string",
277             "idType": "string",
278             "idExpiry": "string",
279             "issuingCountryCode": "string",
280             "documentId": "string"
281           },
282           "imageUrl": "string",
283           "isDeceased": true,
284           "isAlias": true,
285           "isRelated": true
286         },
287         "aliases": [
288           "string"
289         ],
290         "relatedParties": [
291           {
292             "name": "string",
293             "relationship": "string"
294           }
295         ],
296         "referenceDocs": [
297           {
298             "url": "string",
299             "description": "string"
300           }
301         ],
302         "notes": {
303           "additionalProp1": {
304             "type": "string",
305             "value": "string"
306           },
307           "additionalProp2": {
308             "type": "string",
309             "value": "string"
310           },
311           "additionalProp3": {
312             "type": "string",
313             "value": "string"
314           }
315         },
316         "pepData": [
317           {
318             "countryCode": "string",
319             "countryName": "string",
320             "sourceName": "string",
321             "level": "string",
322             "sourceUrl": "string",
323             "position": "string",
324             "positionDescription": "string",
325             "status": "string",
326             "listingStart": "string",
327             "listingEnd": "string",
328             "imageUrl": "string",
329             "referenceDocs": [
330               {
331                 "url": "string",
332                 "description": "string"
333               }
334             ],
335             "additionalData": [
336               {
337                 "key": "string",
338                 "value": "string"
339               }
340             ]
341           }
342         ],
343         "sanctionData": [
344           {
345             "countryCode": "string",
346             "countryName": "string",
347             "sourceName": "string",
348             "sourceUrl": "string",
349             "sourceReason": "string",
350             "listingStart": "string",
351             "listingEnd": "string",
352             "imageUrl": "string",
353             "referenceDocs": [
354               {
355                 "url": "string",
356                 "description": "string"
357               }
358             ],
359             "additionalData": [
360               {
361                 "key": "string",
362                 "value": "string"
363               }
364             ]
365           }
366         ],
367         "watchlistData": [
368           {
369             "countryCode": "string",
370             "countryName": "string",
371             "sourceName": "string",
372             "sourceUrl": "string",
373             "sourceReason": "string",
374             "listingStart": "string",
375             "listingEnd": "string",
376             "imageUrl": "string",
377             "referenceDocs": [
378               {
379                 "url": "string",
380                 "description": "string"
381               }
382             ],
383             "additionalData": [
384               {
385                 "key": "string",
386                 "value": "string"
387               }
388             ]
389           }
390         ],
391         "mediaData": [
392           {
393             "title": "string",
394             "snippet": "string",
395             "source": "string",
396             "sourceDate": "string",
397             "sourceCountry": "string",
398             "url": "string",
399             "isCurrent": true
400           }
401         ]
402       },
403       "errors": [
404         {
405           "code": "string",
406           "description": "string",
407           "location": "string"
408         }
409       ],
410       "notes": {
411         "additionalProp1": {
412           "type": "string",
413           "value": "string"
414         },
415         "additionalProp2": {
416           "type": "string",
417           "value": "string"
418         },
419         "additionalProp3": {
420           "type": "string",
421           "value": "string"
422         }
423       },
424       "systemStatus": "VALID",
425       "manualStatus": "TRUE_POSITIVE",
426       "state": "IN_PROGRESS",
427       "riskFactors": [
428         {
429           "factor": "string",
430           "value": "string"
431         }
432       ],
433       "updatedBy": "string"
434     }
435   ],
436   "createdAt": "2025-05-09T01:51:56.000Z",
437   "updatedAt": "2025-05-09T01:51:56.000Z",
438   "updatedBy": "string"
439 }

Workflow Step Summary

The workflow step summary provides a high-level overview of the results of each step in the workflow. It includes information about the number of hits, false positives, true positives, and unknowns. The summary is organized into the following key sections:

Field Name	Description
`totalHits`	Total number of AML hits across all providers. Minimum value: 0.
`totalFalsePositives`	Total number of AML hits marked as false positive across all providers. Minimum value: 0.
`totalTruePositives`	Total number of AML hits marked as true positive across all providers. Minimum value: 0.
`totalUnknown`	Total number of AML hits marked as unknown across all providers. Minimum value: 0.
`totalUnresolved`	Total number of AML hits that remain unresolved across all providers. Minimum value: 0.
`numUnresolvedPEP`	Total number of unresolved AML hits that have a PEP entry across all providers. Minimum value: 0.
`numUnresolvedSanction`	Total number of unresolved AML hits that have a sanctions entry across all providers. Minimum value: 0.
`numUnresolvedWatchlist`	Total number of unresolved AML hits that have a watchlist entry across all providers. Minimum value: 0.
`numUnresolvedAdverseMedia`	Total number of unresolved AML hits that have an adverse media entry across all providers. Minimum value: 0.
`providerSummaries`	A list of summaries for each provider involved in the AML check.
`stepName`	The name of the step associated with the AML check results.

Example Step Summary

1 "summary": {
2   "totalHits": 0,
3   "totalFalsePositives": 0,
4   "totalTruePositives": 0,
5   "totalUnknowns": 0,
6   "totalUnresolved": 0,
7   "numUnresolvedPEP": 0,
8   "numUnresolvedSanction": 0,
9   "numUnresolvedWatchlist": 0,
10   "numUnresolvedAdverseMedia": 0,
11   "providerSummaries": [
12     {
13       "name": "string",
14       "lastRetrievedAt": "2025-05-09T01:51:56.000Z",
15       "numHits": 0,
16       "numFalsePositives": 0,
17       "numTruePositives": 0,
18       "numUnknowns": 0,
19       "numUnresolved": 0,
20       "pepCountries": {
21         "AUS",
22         "NZ",
23         },
24       "sanctionCountries": {
25         "AUS",
26         "NZ",
27         },
28       "watchlistCountries": {
29         "AUS",
30         "NZ",
31         },
32       "adverseMediaCountries":: {
33         "AUS",
34         "NZ",
35         },
36       "numUnresolvedPEP": 0,
37       "numUnresolvedSanction": 0,
38       "numUnresolvedWatchlist": 0,
39       "numUnresolvedAdverseMedia": 0,
40       "searchQuery": {..}
41     }
42   ],
43   "stepName": "AML Check",
44 }

Process Results

The process results provide detailed information about the individual AML checks performed during the workflow. Each process result includes information about the entity, request, step, and the outcome of the check. The process results are organized into the following key sections:

Field Name	Description
`processResultId`	A unique identifier for the process result object. This ID is assigned when the object is created and is used to reference the specific process result during updates.
`schemaVersion`	The version of the schema used for the process result object. This field is read-only.
`entityId`	The unique identifier for the entity associated with the process result. This field is read-only.
`requestId`	The unique identifier for the API request that generated the process result. Example: `01HN9XHZN6MGXM9JXG50K59Q85`.
`stepName`	The name of the workflow step associated with the process result. This field is read-only.
`stepType`	The type of workflow step associated with the process result. This field is read-only.
`objectType`	The type of object being checked in the process result (e.g., `NAME`, `ADDRESS`). This field is read-only.
`objectId`	The unique identifier for the object being checked in the process result. This field is read-only.
`createdAt`	The timestamp indicating when the process result object was created. This field is read-only.
`updatedAt`	The timestamp indicating when the process result object was last updated. This field is read-only.
`groupId`	The unique identifier for the group associated with the process result. This field is read-only.
`providerResult`	An object containing detailed results from the service provider involved in the process.
`result`	The outcome of the process result check. Possible values include `PASS`, `FAIL`, `MATCH`, `NO_MATCH`, and others. This field is read-only.
`class`	The classification of the process result, providing additional context for generic element types like `person`. Possible values include `AML`, `KYC`, and others. This field is read-only.
`supplementaryData`	An object containing additional data related to the process result, such as provider-specific details or reference documentation.
`errors`	A list of error objects encountered during the process result check, providing details about any issues.
`notes`	An object containing custom notes or attributes related to the process result, offering additional context or clarifications.
`systemStatus`	The system-assigned status of the process result, indicating its validity. Default value is `VALID`. Possible values include `VALID`, `INVALID`, and others. This field is read-only.
`manualStatus`	The manually assigned status of the process result after review. Possible values include `TRUE_POSITIVE`, `FALSE_POSITIVE`, and others.
`state`	The final state of the process result, indicating its disposition. Possible values include `IN_PROGRESS`, `COMPLETED`, and others. This field is read-only.
`riskFactors`	A list of risk factor objects associated with the process result, detailing specific risks identified during the check.
`updatedBy`	The identifier of the user or system that last updated the process result object. This field is read-only.

Example Process Result

1 {
2   "processResultId": "string",
3   "schemaVersion": 0,
4   "entityId": "string",
5   "requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
6   "stepName": "string",
7   "stepType": "string",
8   "objectType": "string",
9   "objectId": "string",
10   "createdAt": "2025-05-09T01:51:56.000Z",
11   "updatedAt": "2025-05-09T01:51:56.000Z",
12   "groupId": "string",
13   "providerResult": {
14     "name": "string",
15     "source": "string",
16     "sourceNormalized": "string",
17     "reference": "string",
18     "fuzziness": {
19       "normalized": 100,
20       "actual": "string"
21     },
22     "confidence": {
23       "normalized": 100,
24       "actual": "string"
25     },
26     "riskScore": 0,
27     "errorCode": "string",
28     "errorMessage": "string"
29   },
30   "result": "MATCH",
31   "class": "KYC",
32   "supplementaryData": {
33     "type": "AML",
34     "serviceProvider": "string",
35     "searchId": "string",
36     "caseId": "string",
37     "referenceId": "string",
38     "originalStepSearchLevel": "string",
39     "groupingId": "string",
40     "reportUrl": "string",
41     "fuzziness": {
42       "normalized": 100,
43       "actual": "string"
44     },
45     "matchData": {
46       "strength": 0,
47       "spReferenceId": "string",
48       "name": "string",
49       "givenName": "string",
50       "otherName": "string",
51       "familyName": "string",
52       "date": "string",
53       "address": "string",
54       "countries": [
55         {
56           "code": "str",
57           "matchType": "string"
58         }
59       ],
60       "nationalId": {
61         "idNumber": "string",
62         "idType": "string",
63         "idExpiry": "string",
64         "issuingCountryCode": "string",
65         "documentId": "string"
66       },
67       "imageUrl": "string",
68       "isDeceased": true,
69       "isAlias": true,
70       "isRelated": true
71     },
72     "aliases": [
73       "string"
74     ],
75     "relatedParties": [
76       {
77         "name": "string",
78         "relationship": "string"
79       }
80     ],
81     "referenceDocs": [
82       {
83         "url": "string",
84         "description": "string"
85       }
86     ],
87     "notes": {
88       "additionalProp1": {
89         "type": "string",
90         "value": "string"
91       },
92       "additionalProp2": {
93         "type": "string",
94         "value": "string"
95       },
96       "additionalProp3": {
97         "type": "string",
98         "value": "string"
99       }
100     },
101     "pepData": [
102       {
103         "countryCode": "string",
104         "countryName": "string",
105         "sourceName": "string",
106         "level": "string",
107         "sourceUrl": "string",
108         "position": "string",
109         "positionDescription": "string",
110         "status": "string",
111         "listingStart": "string",
112         "listingEnd": "string",
113         "imageUrl": "string",
114         "referenceDocs": [
115           {
116             "url": "string",
117             "description": "string"
118           }
119         ],
120         "additionalData": [
121           {
122             "key": "string",
123             "value": "string"
124           }
125         ]
126       }
127     ],
128     "sanctionData": [
129       {
130         "countryCode": "string",
131         "countryName": "string",
132         "sourceName": "string",
133         "sourceUrl": "string",
134         "sourceReason": "string",
135         "listingStart": "string",
136         "listingEnd": "string",
137         "imageUrl": "string",
138         "referenceDocs": [
139           {
140             "url": "string",
141             "description": "string"
142           }
143         ],
144         "additionalData": [
145           {
146             "key": "string",
147             "value": "string"
148           }
149         ]
150       }
151     ],
152     "watchlistData": [
153       {
154         "countryCode": "string",
155         "countryName": "string",
156         "sourceName": "string",
157         "sourceUrl": "string",
158         "sourceReason": "string",
159         "listingStart": "string",
160         "listingEnd": "string",
161         "imageUrl": "string",
162         "referenceDocs": [
163           {
164             "url": "string",
165             "description": "string"
166           }
167         ],
168         "additionalData": [
169           {
170             "key": "string",
171             "value": "string"
172           }
173         ]
174       }
175     ],
176     "mediaData": [
177       {
178         "title": "string",
179         "snippet": "string",
180         "source": "string",
181         "sourceDate": "string",
182         "sourceCountry": "string",
183         "url": "string",
184         "isCurrent": true
185       }
186     ]
187   },
188   "errors": [
189     {
190       "code": "string",
191       "description": "string",
192       "location": "string"
193     }
194   ],
195   "notes": {
196     "additionalProp1": {
197       "type": "string",
198       "value": "string"
199     },
200     "additionalProp2": {
201       "type": "string",
202       "value": "string"
203     },
204     "additionalProp3": {
205       "type": "string",
206       "value": "string"
207     }
208   },
209   "systemStatus": "VALID",
210   "manualStatus": "TRUE_POSITIVE",
211   "state": "IN_PROGRESS",
212   "riskFactors": [
213     {
214       "factor": "string",
215       "value": "string"
216     }
217   ],
218   "updatedBy": "string"
219 }

Match Data

The match data provides detailed information about the specific matches found during the AML check. It includes attributes such as the strength of the match, the service provider’s reference ID, matched names, addresses, dates, and other identifying details. Additionally, it highlights whether the match is an alias, related party, or deceased, along with any associated countries and national IDs.

PEP Data

The PEP (Politically Exposed Persons) data provides information about individuals identified as politically exposed. It includes details such as the country code, country name, source name, level of exposure, position held, listing start and end dates, and any associated reference documents. Additional data such as the source URL and position description are also included for context.

Sanction Data

The sanction data provides information about entities or individuals flagged under sanctions. It includes details such as the country code, country name, source name, source reason, listing start and end dates, and any associated reference documents. Additional data such as the source URL and specific reasons for the sanction are also provided.

Watchlist Data

The watchlist data provides information about entities or individuals flagged in watchlists. It includes details such as the country code, country name, source name, source reason, listing start and end dates, and any associated reference documents. Additional data such as the source URL and reasons for inclusion in the watchlist are also included.

Media Data

The media data provides information about media mentions associated with the AML check. It includes details such as the title of the article, a snippet of the content, the source name, publication date, and the country of origin. Additional data such as the URL to the media source and whether the mention is current are also provided.

Reviewing AML Results

The AML results can be reviewed and updated using the POST /v2/individuals/{entityId}/results/aml endpoint. This allows you to manually set the status of the AML check, add comments, and update the results as needed.

Example Update AML Results

1 {
2   "processResults": [
3     "string" // UUID of the process result
4   ],
5   "manualStatus": "TRUE_POSITIVE", // The status to set for the process result (e.g. TRUE_POSITIVE, FALSE_POSITIVE, TRUE_POSITIVE_ACCEPT, TRUE_POSITIVE_REJECT, UNKNOWN, UNKNOWN_ACCEPT, UNKNOWN_REJECT)
6   "comment": {
7     "text": "Update after speaking to customer over phone directly"
8   }
9 }