Retrieve a Business User Event

GET

/events/business/user/:eventId

GET

/events/business/user/:eventId

1 from flagright import Flagright
2 
3 client = Flagright(
4     api_key="YOUR_API_KEY",
5 )
6 client.business_user_events.get(
7     event_id="eventId",
8 )

Try it

1 {
2   "timestamp": 1.1,
3   "userId": "userId",
4   "eventId": "eventId",
5   "reason": "reason",
6   "eventDescription": "eventDescription",
7   "updatedBusinessUserAttributes": {
8     "activatedTimestamp": 1.1,
9     "userStateDetails": {
10       "state": "UNACCEPTABLE",
11       "reason": "reason"
12     },
13     "kycStatusDetails": {
14       "reason": "reason",
15       "status": "SUCCESSFUL"
16     },
17     "legalEntity": {
18       "companyGeneralDetails": {
19         "legalName": "Ozkan Hazelnut Export JSC",
20         "businessIndustry": [
21           "Farming"
22         ],
23         "mainProductsServicesSold": [
24           "Hazelnut"
25         ],
26         "tags": [
27           {
28             "key": "customKey",
29             "value": "customValue"
30           }
31         ]
32       },
33       "companyFinancialDetails": {
34         "expectedTransactionAmountPerMonth": {
35           "amountValue": 800,
36           "amountCurrency": "GBP"
37         },
38         "expectedTurnoverPerMonth": {
39           "amountValue": 8000,
40           "amountCurrency": "USD"
41         },
42         "tags": [
43           {
44             "key": "customKey",
45             "value": "customValue"
46           }
47         ]
48       },
49       "companyRegistrationDetails": {
50         "registrationIdentifier": "PSJ554342",
51         "registrationCountry": "DE",
52         "tags": [
53           {
54             "key": "customKey",
55             "value": "customValue"
56           }
57         ]
58       },
59       "reasonForAccountOpening": [
60         "string"
61       ],
62       "sourceOfFunds": [
63         "Earnings"
64       ],
65       "contactDetails": {
66         "addresses": [
67           {
68             "addressLines": [
69               "Klara-Franke Str 20"
70             ],
71             "postcode": "10557",
72             "city": "Berlin",
73             "state": "Berlin",
74             "country": "Germany",
75             "tags": [
76               {
77                 "key": "customKey",
78                 "value": "customValue"
79               }
80             ]
81           }
82         ]
83       }
84     },
85     "shareHolders": [
86       {
87         "generalDetails": {
88           "name": {
89             "firstName": "Baran",
90             "middleName": "Realblood",
91             "lastName": "Ozkan"
92           },
93           "dateOfBirth": "1991-01-01",
94           "countryOfResidence": "US",
95           "countryOfNationality": "DE"
96         },
97         "legalDocuments": [
98           {
99             "documentType": "passport",
100             "documentNumber": "Z9431P",
101             "documentIssuedCountry": "DE",
102             "documentIssuedDate": 1639939034000,
103             "documentExpirationDate": 1839939034000,
104             "tags": [
105               {
106                 "key": "customerType",
107                 "value": "wallet"
108               }
109             ],
110             "nameOnDocument": {
111               "firstName": "Baran",
112               "middleName": "Realblood",
113               "lastName": "Ozkan"
114             }
115           }
116         ],
117         "contactDetails": {
118           "emailIds": [
119             "baran@flagright.com"
120           ],
121           "contactNumbers": [
122             "+371 123132"
123           ],
124           "websites": [
125             "flagright.com"
126           ],
127           "addresses": [
128             {
129               "addressLines": [
130                 "Klara-Franke Str 20"
131               ],
132               "postcode": "10557",
133               "city": "Berlin",
134               "state": "Berlin",
135               "country": "Germany",
136               "tags": [
137                 {
138                   "key": "customKey",
139                   "value": "customValue"
140                 }
141               ]
142             }
143           ]
144         },
145         "tags": [
146           {
147             "key": "customKey",
148             "value": "customValue"
149           }
150         ],
151         "attachments": [
152           {
153             "files": [
154               {
155                 "s3Key": "s3Key",
156                 "filename": "filename",
157                 "size": 1.1
158               }
159             ],
160             "userId": "userId",
161             "comment": "Arun's tax information"
162           }
163         ]
164       }
165     ],
166     "directors": [
167       {
168         "generalDetails": {
169           "name": {
170             "firstName": "Baran",
171             "middleName": "Realblood",
172             "lastName": "Ozkan"
173           },
174           "dateOfBirth": "1991-01-01",
175           "countryOfResidence": "US",
176           "countryOfNationality": "DE"
177         },
178         "legalDocuments": [
179           {
180             "documentType": "passport",
181             "documentNumber": "Z9431P",
182             "documentIssuedCountry": "DE",
183             "documentIssuedDate": 1639939034000,
184             "documentExpirationDate": 1839939034000,
185             "tags": [
186               {
187                 "key": "customerType",
188                 "value": "wallet"
189               }
190             ],
191             "nameOnDocument": {
192               "firstName": "Baran",
193               "middleName": "Realblood",
194               "lastName": "Ozkan"
195             }
196           }
197         ],
198         "contactDetails": {
199           "emailIds": [
200             "baran@flagright.com"
201           ],
202           "contactNumbers": [
203             "+371 123132"
204           ],
205           "websites": [
206             "flagright.com"
207           ],
208           "addresses": [
209             {
210               "addressLines": [
211                 "Klara-Franke Str 20"
212               ],
213               "postcode": "10557",
214               "city": "Berlin",
215               "state": "Berlin",
216               "country": "Germany",
217               "tags": [
218                 {
219                   "key": "customKey",
220                   "value": "customValue"
221                 }
222               ]
223             }
224           ]
225         },
226         "tags": [
227           {
228             "key": "customKey",
229             "value": "customValue"
230           }
231         ],
232         "attachments": [
233           {
234             "files": [
235               {
236                 "s3Key": "s3Key",
237                 "filename": "filename",
238                 "size": 1.1
239               }
240             ],
241             "userId": "userId",
242             "comment": "Arun's tax information"
243           }
244         ]
245       }
246     ],
247     "transactionLimits": {
248       "maximumDailyTransactionLimit": {
249         "amountValue": 800,
250         "amountCurrency": "GBP"
251       },
252       "maximumWeeklyTransactionLimit": {
253         "amountValue": 800,
254         "amountCurrency": "GBP"
255       },
256       "maximumMonthlyTransactionLimit": {
257         "amountValue": 800,
258         "amountCurrency": "GBP"
259       },
260       "maximumQuarterlyTransactionLimit": {
261         "amountValue": 800,
262         "amountCurrency": "GBP"
263       },
264       "maximumTransactionLimit": {
265         "amountValue": 800,
266         "amountCurrency": "GBP"
267       },
268       "maximumYearlyTransactionLimit": {
269         "amountValue": 800,
270         "amountCurrency": "GBP"
271       }
272     },
273     "riskLevel": "VERY_HIGH",
274     "kycRiskLevel": "VERY_HIGH",
275     "allowedPaymentMethods": [
276       "ACH"
277     ],
278     "lastTransactionTimestamp": 1.1,
279     "linkedEntities": {
280       "parentUserId": "parentUserId"
281     },
282     "acquisitionChannel": "ORGANIC",
283     "savedPaymentDetails": [
284       {
285         "method": "CARD",
286         "3dsDone": true,
287         "cardBalance": {
288           "amountValue": 800,
289           "amountCurrency": "GBP"
290         },
291         "cardFingerprint": "20ac00fed8ef913aefb17cfae1097cce",
292         "cardIssuedCountry": "TR",
293         "nameOnCard": {
294           "firstName": "Baran",
295           "middleName": "Realblood",
296           "lastName": "Ozkan"
297         },
298         "tags": [
299           {
300             "key": "customKey",
301             "value": "customValue"
302           }
303         ],
304         "transactionReferenceField": "Deposit"
305       }
306     ],
307     "mccDetails": {
308       "code": 1.1,
309       "description": "description"
310     },
311     "tags": [
312       {
313         "key": "customKey",
314         "value": "customValue"
315       }
316     ],
317     "attachments": [
318       {
319         "files": [
320           {
321             "s3Key": "s3Key",
322             "filename": "filename",
323             "size": 1.1
324           }
325         ],
326         "userId": "userId",
327         "comment": "Arun's tax information"
328       }
329     ]
330   },
331   "executedRules": [
332     {
333       "ruleInstanceId": "ruleInstanceId",
334       "ruleName": "Proof of funds for high value transactions",
335       "ruleDescription": "If a user makes a remittance transaction >= 1800 in EUR - ask for proof of funds",
336       "ruleAction": "BLOCK",
337       "ruleHit": true,
338       "ruleId": "R-1a",
339       "executedAt": 1.1,
340       "vars": [
341         {
342           "value": {
343             "key": "value"
344           }
345         }
346       ],
347       "labels": [
348         "UNEXPECTED_BEHAVIOR"
349       ],
350       "nature": "AML",
351       "isShadow": true
352     }
353   ],
354   "hitRules": [
355     {
356       "ruleInstanceId": "ruleInstanceId",
357       "ruleName": "Proof of funds for high value transactions",
358       "ruleDescription": "If a user makes a remittance transaction >= 1800 in EUR - ask for proof of funds",
359       "ruleAction": "BLOCK",
360       "ruleId": "R-1a",
361       "executedAt": 1.1,
362       "labels": [
363         "UNEXPECTED_BEHAVIOR"
364       ],
365       "nature": "FRAUD",
366       "isShadow": true
367     }
368   ],
369   "riskScoreDetails": {
370     "kycRiskScore": 1.1,
371     "craRiskScore": 1.1,
372     "kycRiskLevel": "VERY_HIGH",
373     "craRiskLevel": "VERY_HIGH"
374   }
375 }

GET a Business User Event

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

Path parameters

eventIdstringRequired

Unique Business User Event Identifier

Response

timestampdouble>=315529200000<=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

executedRuleslist of objectsOptional

hitRuleslist of objectsOptional

riskScoreDetailsobjectOptional

Retrieve a Business User Event

GET a Business User Event

Path parameters

Headers

Response

Errors