Retrieve a Business User Event

GET

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

This endpoint returns an object.

timestampdouble

Timestamp of the event

userIdstring

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

Errors

GET

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

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             "city": "Berlin",
72             "country": "Germany",
73             "postcode": "10557",
74             "state": "Berlin",
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               "city": "Berlin",
133               "country": "Germany",
134               "postcode": "10557",
135               "state": "Berlin",
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       }
152     ],
153     "directors": [
154       {
155         "generalDetails": {
156           "name": {
157             "firstName": "Baran",
158             "middleName": "Realblood",
159             "lastName": "Ozkan"
160           },
161           "dateOfBirth": "1991-01-01",
162           "countryOfResidence": "US",
163           "countryOfNationality": "DE"
164         },
165         "legalDocuments": [
166           {
167             "documentType": "passport",
168             "documentNumber": "Z9431P",
169             "documentIssuedCountry": "DE",
170             "documentIssuedDate": 1639939034000,
171             "documentExpirationDate": 1839939034000,
172             "tags": [
173               {
174                 "key": "customerType",
175                 "value": "wallet"
176               }
177             ],
178             "nameOnDocument": {
179               "firstName": "Baran",
180               "middleName": "Realblood",
181               "lastName": "Ozkan"
182             }
183           }
184         ],
185         "contactDetails": {
186           "emailIds": [
187             "baran@flagright.com"
188           ],
189           "contactNumbers": [
190             "+371 123132"
191           ],
192           "websites": [
193             "flagright.com"
194           ],
195           "addresses": [
196             {
197               "addressLines": [
198                 "Klara-Franke Str 20"
199               ],
200               "city": "Berlin",
201               "country": "Germany",
202               "postcode": "10557",
203               "state": "Berlin",
204               "tags": [
205                 {
206                   "key": "customKey",
207                   "value": "customValue"
208                 }
209               ]
210             }
211           ]
212         },
213         "tags": [
214           {
215             "key": "customKey",
216             "value": "customValue"
217           }
218         ]
219       }
220     ],
221     "transactionLimits": {
222       "maximumDailyTransactionLimit": {
223         "amountValue": 800,
224         "amountCurrency": "GBP"
225       },
226       "maximumWeeklyTransactionLimit": {
227         "amountValue": 800,
228         "amountCurrency": "GBP"
229       },
230       "maximumMonthlyTransactionLimit": {
231         "amountValue": 800,
232         "amountCurrency": "GBP"
233       },
234       "maximumQuarterlyTransactionLimit": {
235         "amountValue": 800,
236         "amountCurrency": "GBP"
237       },
238       "maximumTransactionLimit": {
239         "amountValue": 800,
240         "amountCurrency": "GBP"
241       },
242       "maximumYearlyTransactionLimit": {
243         "amountValue": 800,
244         "amountCurrency": "GBP"
245       }
246     },
247     "riskLevel": "VERY_HIGH",
248     "allowedPaymentMethods": [
249       "ACH"
250     ],
251     "lastTransactionTimestamp": 1.1,
252     "linkedEntities": {
253       "parentUserId": "parentUserId"
254     },
255     "acquisitionChannel": "ORGANIC",
256     "mccDetails": {
257       "code": 1.1,
258       "description": "description"
259     },
260     "tags": [
261       {
262         "key": "customKey",
263         "value": "customValue"
264       }
265     ]
266   },
267   "executedRules": [
268     {
269       "ruleInstanceId": "ruleInstanceId",
270       "ruleName": "Proof of funds for high value transactions",
271       "ruleDescription": "If a user makes a remittance transaction >= 1800 in EUR - ask for proof of funds",
272       "ruleAction": "BLOCK",
273       "ruleHit": true,
274       "ruleId": "R-1a",
275       "vars": [
276         {
277           "value": {}
278         }
279       ],
280       "labels": [
281         "UNEXPECTED_BEHAVIOR"
282       ],
283       "nature": "AML",
284       "isShadow": true
285     }
286   ],
287   "hitRules": [
288     {
289       "ruleInstanceId": "ruleInstanceId",
290       "ruleName": "Proof of funds for high value transactions",
291       "ruleDescription": "If a user makes a remittance transaction >= 1800 in EUR - ask for proof of funds",
292       "ruleAction": "BLOCK",
293       "ruleId": "R-1a",
294       "labels": [
295         "UNEXPECTED_BEHAVIOR"
296       ],
297       "nature": "FRAUD",
298       "isShadow": true
299     }
300   ],
301   "riskScoreDetails": {
302     "kycRiskScore": 1.1,
303     "craRiskScore": 1.1,
304     "kycRiskLevel": "VERY_HIGH",
305     "craRiskLevel": "VERY_HIGH"
306   }
307 }

Built with

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

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	"city": "Berlin",
72	"country": "Germany",
73	"postcode": "10557",
74	"state": "Berlin",
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	"city": "Berlin",
133	"country": "Germany",
134	"postcode": "10557",
135	"state": "Berlin",
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	}
152	],
153	"directors": [
154	{
155	"generalDetails": {
156	"name": {
157	"firstName": "Baran",
158	"middleName": "Realblood",
159	"lastName": "Ozkan"
160	},
161	"dateOfBirth": "1991-01-01",
162	"countryOfResidence": "US",
163	"countryOfNationality": "DE"
164	},
165	"legalDocuments": [
166	{
167	"documentType": "passport",
168	"documentNumber": "Z9431P",
169	"documentIssuedCountry": "DE",
170	"documentIssuedDate": 1639939034000,
171	"documentExpirationDate": 1839939034000,
172	"tags": [
173	{
174	"key": "customerType",
175	"value": "wallet"
176	}
177	],
178	"nameOnDocument": {
179	"firstName": "Baran",
180	"middleName": "Realblood",
181	"lastName": "Ozkan"
182	}
183	}
184	],
185	"contactDetails": {
186	"emailIds": [
187	"baran@flagright.com"
188	],
189	"contactNumbers": [
190	"+371 123132"
191	],
192	"websites": [
193	"flagright.com"
194	],
195	"addresses": [
196	{
197	"addressLines": [
198	"Klara-Franke Str 20"
199	],
200	"city": "Berlin",
201	"country": "Germany",
202	"postcode": "10557",
203	"state": "Berlin",
204	"tags": [
205	{
206	"key": "customKey",
207	"value": "customValue"
208	}
209	]
210	}
211	]
212	},
213	"tags": [
214	{
215	"key": "customKey",
216	"value": "customValue"
217	}
218	]
219	}
220	],
221	"transactionLimits": {
222	"maximumDailyTransactionLimit": {
223	"amountValue": 800,
224	"amountCurrency": "GBP"
225	},
226	"maximumWeeklyTransactionLimit": {
227	"amountValue": 800,
228	"amountCurrency": "GBP"
229	},
230	"maximumMonthlyTransactionLimit": {
231	"amountValue": 800,
232	"amountCurrency": "GBP"
233	},
234	"maximumQuarterlyTransactionLimit": {
235	"amountValue": 800,
236	"amountCurrency": "GBP"
237	},
238	"maximumTransactionLimit": {
239	"amountValue": 800,
240	"amountCurrency": "GBP"
241	},
242	"maximumYearlyTransactionLimit": {
243	"amountValue": 800,
244	"amountCurrency": "GBP"
245	}
246	},
247	"riskLevel": "VERY_HIGH",
248	"allowedPaymentMethods": [
249	"ACH"
250	],
251	"lastTransactionTimestamp": 1.1,
252	"linkedEntities": {
253	"parentUserId": "parentUserId"
254	},
255	"acquisitionChannel": "ORGANIC",
256	"mccDetails": {
257	"code": 1.1,
258	"description": "description"
259	},
260	"tags": [
261	{
262	"key": "customKey",
263	"value": "customValue"
264	}
265	]
266	},
267	"executedRules": [
268	{
269	"ruleInstanceId": "ruleInstanceId",
270	"ruleName": "Proof of funds for high value transactions",
271	"ruleDescription": "If a user makes a remittance transaction >= 1800 in EUR - ask for proof of funds",
272	"ruleAction": "BLOCK",
273	"ruleHit": true,
274	"ruleId": "R-1a",
275	"vars": [
276	{
277	"value": {}
278	}
279	],
280	"labels": [
281	"UNEXPECTED_BEHAVIOR"
282	],
283	"nature": "AML",
284	"isShadow": true
285	}
286	],
287	"hitRules": [
288	{
289	"ruleInstanceId": "ruleInstanceId",
290	"ruleName": "Proof of funds for high value transactions",
291	"ruleDescription": "If a user makes a remittance transaction >= 1800 in EUR - ask for proof of funds",
292	"ruleAction": "BLOCK",
293	"ruleId": "R-1a",
294	"labels": [
295	"UNEXPECTED_BEHAVIOR"
296	],
297	"nature": "FRAUD",
298	"isShadow": true
299	}
300	],
301	"riskScoreDetails": {
302	"kycRiskScore": 1.1,
303	"craRiskScore": 1.1,
304	"kycRiskLevel": "VERY_HIGH",
305	"craRiskLevel": "VERY_HIGH"
306	}
307	}