Retrieve a Business User Event

GET

/events/business/user/:eventId

GET

/events/business/user/:eventId

$ curl https://sandbox.api.flagright.com/events/business/user/eventId \
>      -H "x-api-key: <apiKey>"

1 {
2   "timestamp": 2220000000000,
3   "userId": "string",
4   "eventId": "string",
5   "reason": "string",
6   "eventDescription": "string",
7   "updatedBusinessUserAttributes": {
8     "legalEntity": {
9       "companyGeneralDetails": {
10         "legalName": "Ozkan Hazelnut Export JSC",
11         "businessIndustry": [
12           "Farming"
13         ],
14         "secondaryBusinessIndustry": [
15           "Food Processing"
16         ],
17         "mainProductsServicesSold": [
18           "Hazelnut"
19         ]
20       },
21       "companyFinancialDetails": {
22         "expectedTransactionAmountPerMonth": {
23           "amountValue": 800,
24           "amountCurrency": "GBP"
25         },
26         "expectedTurnoverPerMonth": {
27           "amountValue": 8000,
28           "amountCurrency": "USD"
29         }
30       },
31       "companyRegistrationDetails": {
32         "registrationIdentifier": "PSJ554342",
33         "registrationCountry": "DE"
34       },
35       "reasonForAccountOpening": [
36         "string"
37       ],
38       "contactDetails": {
39         "addresses": [
40           {
41             "addressLines": [
42               "Klara-Franke Str 20"
43             ],
44             "postcode": "10557",
45             "city": "Berlin",
46             "state": "Berlin",
47             "country": "Germany",
48             "tags": [
49               {
50                 "key": "customKey",
51                 "value": "customValue"
52               }
53             ]
54           }
55         ]
56       }
57     },
58     "shareHolders": [
59       {
60         "generalDetails": {
61           "name": {
62             "firstName": "Baran",
63             "middleName": "Realblood",
64             "lastName": "Ozkan"
65           },
66           "dateOfBirth": "1991-01-01",
67           "countryOfResidence": "US",
68           "countryOfNationality": "DE"
69         },
70         "legalDocuments": [
71           {
72             "documentType": "passport",
73             "documentNumber": "Z9431P",
74             "documentIssuedDate": 1639939034000,
75             "documentExpirationDate": 1839939034000,
76             "documentIssuedCountry": "DE",
77             "tags": [
78               {
79                 "key": "customerType",
80                 "value": "wallet"
81               }
82             ]
83           }
84         ],
85         "contactDetails": {
86           "emailIds": [
87             "baran@flagright.com"
88           ],
89           "contactNumbers": [
90             "+371 123132"
91           ],
92           "websites": [
93             "flagright.com"
94           ],
95           "addresses": [
96             {
97               "addressLines": [
98                 "Klara-Franke Str 20"
99               ],
100               "postcode": "10557",
101               "city": "Berlin",
102               "state": "Berlin",
103               "country": "Germany",
104               "tags": [
105                 {
106                   "key": "customKey",
107                   "value": "customValue"
108                 }
109               ]
110             }
111           ]
112         },
113         "tags": [
114           {
115             "key": "customKey",
116             "value": "customValue"
117           }
118         ]
119       }
120     ],
121     "directors": [
122       {
123         "generalDetails": {
124           "name": {
125             "firstName": "Baran",
126             "middleName": "Realblood",
127             "lastName": "Ozkan"
128           },
129           "dateOfBirth": "1991-01-01",
130           "countryOfResidence": "US",
131           "countryOfNationality": "DE"
132         },
133         "legalDocuments": [
134           {
135             "documentType": "passport",
136             "documentNumber": "Z9431P",
137             "documentIssuedDate": 1639939034000,
138             "documentExpirationDate": 1839939034000,
139             "documentIssuedCountry": "DE",
140             "tags": [
141               {
142                 "key": "customerType",
143                 "value": "wallet"
144               }
145             ]
146           }
147         ],
148         "contactDetails": {
149           "emailIds": [
150             "baran@flagright.com"
151           ],
152           "contactNumbers": [
153             "+371 123132"
154           ],
155           "websites": [
156             "flagright.com"
157           ],
158           "addresses": [
159             {
160               "addressLines": [
161                 "Klara-Franke Str 20"
162               ],
163               "postcode": "10557",
164               "city": "Berlin",
165               "state": "Berlin",
166               "country": "Germany",
167               "tags": [
168                 {
169                   "key": "customKey",
170                   "value": "customValue"
171                 }
172               ]
173             }
174           ]
175         },
176         "tags": [
177           {
178             "key": "customKey",
179             "value": "customValue"
180           }
181         ]
182       }
183     ],
184     "tags": [
185       {
186         "key": "customKey",
187         "value": "customValue"
188       }
189     ],
190     "metaData": {
191       "batteryLevel": 76.3,
192       "deviceLatitude": 13.009711,
193       "deviceLongitude": 76.102898,
194       "ipAddress": "79.144.2.20",
195       "vpnUsed": true
196     },
197     "createdTimestamp": 1641654664000,
198     "userId": "96647cfd9e8fe66ee0f3362e011e34e8"
199   },
200   "newUserId": "string",
201   "externalLinks": [
202     "string"
203   ],
204   "executedRules": [
205     {
206       "ruleInstanceId": "string",
207       "ruleName": "string",
208       "ruleDescription": "string",
209       "ruleAction": "ALLOW",
210       "ruleHit": true,
211       "ruleId": "string",
212       "versionId": "string",
213       "executedAt": 2220000000000,
214       "executedRiskLevel": "VERY_HIGH",
215       "ruleHitMeta": {
216         "hitDirections": [
217           "ORIGIN"
218         ],
219         "falsePositiveDetails": {
220           "isFalsePositive": true,
221           "confidenceScore": 1.1
222         },
223         "sanctionsDetails": [
224           {
225             "name": "string",
226             "searchId": "string",
227             "requestHash": "string",
228             "iban": "string",
229             "entityType": "CONSUMER_NAME",
230             "sanctionHitIds": [
231               "string"
232             ],
233             "hitContext": {
234               "entity": "USER",
235               "entityType": "CONSUMER_NAME",
236               "userId": "string",
237               "transactionId": "string",
238               "ruleInstanceId": "string",
239               "ruleId": "string",
240               "iban": "string",
241               "yearOfBirth": 1,
242               "searchTerm": "string",
243               "paymentMethodId": "string"
244             },
245             "hitDirection": "ORIGIN",
246             "isRuleHit": true
247           }
248         ],
249         "isOngoingScreeningHit": true
250       },
251       "vars": [
252         {
253           "value": {},
254           "direction": "ORIGIN",
255           "listContext": {
256             "direction": "ORIGIN",
257             "matchedEntities": [
258               {
259                 "value": "string",
260                 "listId": "string",
261                 "matchedValues": [
262                   {
263                     "matchedKey": "string"
264                   }
265                 ],
266                 "settings": {}
267               }
268             ]
269           }
270         }
271       ],
272       "labels": [
273         "UNEXPECTED_BEHAVIOR"
274       ],
275       "nature": "AML",
276       "isShadow": true
277     }
278   ],
279   "hitRules": [
280     {
281       "ruleInstanceId": "string",
282       "ruleName": "string",
283       "ruleDescription": "string",
284       "ruleAction": "ALLOW",
285       "ruleId": "string",
286       "versionId": "string",
287       "executedAt": 2220000000000,
288       "executedRiskLevel": "VERY_HIGH",
289       "ruleHitMeta": {
290         "hitDirections": [
291           "ORIGIN"
292         ],
293         "falsePositiveDetails": {
294           "isFalsePositive": true,
295           "confidenceScore": 1.1
296         },
297         "sanctionsDetails": [
298           {
299             "name": "string",
300             "searchId": "string",
301             "requestHash": "string",
302             "iban": "string",
303             "entityType": "CONSUMER_NAME",
304             "sanctionHitIds": [
305               "string"
306             ],
307             "hitContext": {
308               "entity": "USER",
309               "entityType": "CONSUMER_NAME",
310               "userId": "string",
311               "transactionId": "string",
312               "ruleInstanceId": "string",
313               "ruleId": "string",
314               "iban": "string",
315               "yearOfBirth": 1,
316               "searchTerm": "string",
317               "paymentMethodId": "string"
318             },
319             "hitDirection": "ORIGIN",
320             "isRuleHit": true
321           }
322         ],
323         "isOngoingScreeningHit": true
324       },
325       "labels": [
326         "UNEXPECTED_BEHAVIOR"
327       ],
328       "nature": "AML",
329       "isShadow": true
330     }
331   ],
332   "riskScoreDetails": {
333     "kycRiskScore": 1.1,
334     "craRiskScore": 1.1,
335     "kycRiskLevel": "VERY_HIGH",
336     "craRiskLevel": "VERY_HIGH",
337     "kycRiskFactors": [
338       {
339         "riskFactorId": "string",
340         "riskFactorName": "string",
341         "riskFactorVersionId": "string",
342         "value": "string",
343         "riskScore": 1.1,
344         "riskLevel": "string",
345         "weight": 1.1
346       }
347     ],
348     "avgTrsScore": 1.1,
349     "krsWeight": 1.1,
350     "avgTrsWeight": 1.1
351   }
352 }

GET a Business User Event

You can retrieve any business user event you created using the POST Business User Events call.

Authentication

x-api-keystring

API keys are used to authenticate the requests.

Path parameters

eventIdstringRequired

Unique Business User Event Identifier

Response

timestampdouble315529200000-4133890801000

Timestamp of the event

userIdstring>=1 character

Transaction ID the event pertains to

eventIdstringOptional

Unique event ID

reasonstringOptional

Reason for the event or a state change

eventDescriptionstringOptional

Event description

updatedBusinessUserAttributesobjectOptional

Model for a business user - optional fields

newUserIdstringOptional>=1 character

New userId for the existing user (keep in mind all of the future requests for this user will now reference this userId). Requires the changeUserId query param to come in affect.

externalLinkslist of stringsOptional

External links related to the business user

executedRuleslist of objectsOptional

hitRuleslist of objectsOptional

riskScoreDetailsobjectOptional

Errors

400

Bad Request Error

401

Unauthorized Error

429

Too Many Requests Error