Retrieve a Business User Event

GET

/events/business/user/:eventId

GET

/events/business/user/:eventId

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

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

eventIdstring

Unique event ID

reasonstring

Reason for the event or a state change

eventDescriptionstring

Event description

updatedBusinessUserAttributesobject

Model for a business user - optional fields

externalLinkslist of strings

External links related to the business user

executedRuleslist of objects

hitRuleslist of objects

riskScoreDetailsobject

Errors

400

Bad Request Error

401

Unauthorized Error

429

Too Many Requests Error