Update the status of AML process results

PATCH

https://api.uat.frankie.one/v2/individuals/:entityId/results/aml

PATCH

/v2/individuals/:entityId/results/aml

1 curl -X PATCH https://api.uat.frankie.one/v2/individuals/entityId/results/aml \
2      -H "X-Frankie-CustomerID: 12345678-1234-1234-1234-123456789012" \
3      -H "X-Frankie-CustomerChildID: 87654321-4321-4321-4321-210987654321" \
4      -H "X-Frankie-Username: fred.flintstone@frankieone.com" \
5      -H "api_key: <apiKey>" \
6      -H "Content-Type: application/json" \
7      -d '{}'

Try it

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

Update the status of a set of AML process results.

Path parameters

entityIdstringRequired

Unique FrankieOne identifier for an entity

Headers

Request

This endpoint expects an object.

processResultslist of stringsOptional

manualStatusenumOptional

Any manual status set after the results have been reviewed

commentobjectOptional

Response

requestIdstring or null

The unique request ID for the API call made.

processResultslist of objects or null

Path parameters

Headers

Request

Response

Errors