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: <x-api-key>"

Try it

200getExample

1 {
2   "timestamp": 42,
3   "userId": "foo",
4   "eventId": "foo",
5   "reason": "foo",
6   "eventDescription": "foo",
7   "updatedBusinessUserAttributes": {
8     "activatedTimestamp": 42,
9     "userStateDetails": {
10       "state": "UNACCEPTABLE",
11       "reason": "foo"
12     },
13     "kycStatusDetails": {
14       "reason": "foo",
15       "status": "SUCCESSFUL"
16     },
17     "legalEntity": {
18       "companyGeneralDetails": {
19         "legalName": "foo",
20         "businessIndustry": [
21           "foo"
22         ],
23         "mainProductsServicesSold": [
24           "foo"
25         ],
26         "userSegment": "SOLE_PROPRIETORSHIP",
27         "userRegistrationStatus": "REGISTERED",
28         "operatingCountries": [
29           "AF"
30         ],
31         "alias": [
32           "foo"
33         ],
34         "tags": [
35           {
36             "key": "foo",
37             "value": "foo"
38           }
39         ]
40       },
41       "companyFinancialDetails": {
42         "expectedTransactionAmountPerMonth": {
43           "amountValue": 42,
44           "amountCurrency": "1INCH"
45         },
46         "expectedTurnoverPerMonth": {
47           "amountValue": 42,
48           "amountCurrency": "1INCH"
49         },
50         "tags": [
51           {
52             "key": "foo",
53             "value": "foo"
54           }
55         ]
56       },
57       "companyRegistrationDetails": {
58         "registrationIdentifier": "foo",
59         "registrationCountry": "AF",
60         "taxResidenceCountry": "AF",
61         "taxIdentifier": "foo",
62         "legalEntityType": "foo",
63         "dateOfRegistration": "foo",
64         "tags": [
65           {
66             "key": "foo",
67             "value": "foo"
68           }
69         ]
70       },
71       "reasonForAccountOpening": [
72         "foo"
73       ],
74       "sourceOfFunds": [
75         "Earnings"
76       ],
77       "contactDetails": {
78         "emailIds": [
79           "foo"
80         ],
81         "contactNumbers": [
82           "foo"
83         ],
84         "faxNumbers": [
85           "foo"
86         ],
87         "websites": [
88           "foo"
89         ],
90         "addresses": [
91           {
92             "addressLines": [
93               "foo"
94             ],
95             "postcode": "foo",
96             "city": "foo",
97             "state": "foo",
98             "country": "foo",
99             "addressType": "foo",
100             "tags": [
101               {
102                 "key": "foo",
103                 "value": "foo"
104               }
105             ]
106           }
107         ],
108         "name": {
109           "firstName": "foo",
110           "middleName": "foo",
111           "lastName": "foo"
112         },
113         "tags": [
114           {
115             "key": "foo",
116             "value": "foo"
117           }
118         ]
119       }
120     },
121     "shareHolders": [
122       {
123         "generalDetails": {
124           "name": {
125             "firstName": "foo",
126             "middleName": "foo",
127             "lastName": "foo"
128           },
129           "dateOfBirth": "foo",
130           "userCategory": "foo",
131           "countryOfResidence": "AF",
132           "countryOfTaxResidence": "AF",
133           "countryOfNationality": "AF",
134           "gender": "M",
135           "maritalStatus": "DIVORCED",
136           "placeOfBirth": {
137             "country": "AF",
138             "city": "foo",
139             "state": "foo"
140           },
141           "alias": [
142             "foo"
143           ]
144         },
145         "userId": "foo",
146         "legalDocuments": [
147           {
148             "documentType": "foo",
149             "documentNumber": "foo",
150             "documentIssuedCountry": "AF",
151             "documentIssuedDate": 42,
152             "documentExpirationDate": 42,
153             "tags": [
154               {
155                 "key": "foo",
156                 "value": "foo"
157               }
158             ],
159             "nameOnDocument": {
160               "firstName": "foo",
161               "middleName": "foo",
162               "lastName": "foo"
163             }
164           }
165         ],
166         "contactDetails": {
167           "emailIds": [
168             "foo"
169           ],
170           "contactNumbers": [
171             "foo"
172           ],
173           "faxNumbers": [
174             "foo"
175           ],
176           "websites": [
177             "foo"
178           ],
179           "addresses": [
180             {
181               "addressLines": [
182                 "foo"
183               ],
184               "postcode": "foo",
185               "city": "foo",
186               "state": "foo",
187               "country": "foo",
188               "addressType": "foo",
189               "tags": [
190                 {
191                   "key": "foo",
192                   "value": "foo"
193                 }
194               ]
195             }
196           ],
197           "name": {
198             "firstName": "foo",
199             "middleName": "foo",
200             "lastName": "foo"
201           },
202           "tags": [
203             {
204               "key": "foo",
205               "value": "foo"
206             }
207           ]
208         },
209         "pepStatus": [
210           {
211             "isPepHit": true,
212             "pepCountry": "AF",
213             "pepRank": "LEVEL_1"
214           }
215         ],
216         "tags": [
217           {
218             "key": "foo",
219             "value": "foo"
220           }
221         ],
222         "attachments": [
223           {
224             "files": [
225               {
226                 "s3Key": "foo",
227                 "filename": "foo",
228                 "size": 42,
229                 "bucket": "foo",
230                 "downloadLink": "foo",
231                 "aiSummary": "foo"
232               }
233             ],
234             "userId": "foo",
235             "id": "foo",
236             "comment": "foo",
237             "createdAt": 42,
238             "deletedAt": 42
239           }
240         ]
241       }
242     ],
243     "directors": [
244       {
245         "generalDetails": {
246           "name": {
247             "firstName": "foo",
248             "middleName": "foo",
249             "lastName": "foo"
250           },
251           "dateOfBirth": "foo",
252           "userCategory": "foo",
253           "countryOfResidence": "AF",
254           "countryOfTaxResidence": "AF",
255           "countryOfNationality": "AF",
256           "gender": "M",
257           "maritalStatus": "DIVORCED",
258           "placeOfBirth": {
259             "country": "AF",
260             "city": "foo",
261             "state": "foo"
262           },
263           "alias": [
264             "foo"
265           ]
266         },
267         "userId": "foo",
268         "legalDocuments": [
269           {
270             "documentType": "foo",
271             "documentNumber": "foo",
272             "documentIssuedCountry": "AF",
273             "documentIssuedDate": 42,
274             "documentExpirationDate": 42,
275             "tags": [
276               {
277                 "key": "foo",
278                 "value": "foo"
279               }
280             ],
281             "nameOnDocument": {
282               "firstName": "foo",
283               "middleName": "foo",
284               "lastName": "foo"
285             }
286           }
287         ],
288         "contactDetails": {
289           "emailIds": [
290             "foo"
291           ],
292           "contactNumbers": [
293             "foo"
294           ],
295           "faxNumbers": [
296             "foo"
297           ],
298           "websites": [
299             "foo"
300           ],
301           "addresses": [
302             {
303               "addressLines": [
304                 "foo"
305               ],
306               "postcode": "foo",
307               "city": "foo",
308               "state": "foo",
309               "country": "foo",
310               "addressType": "foo",
311               "tags": [
312                 {
313                   "key": "foo",
314                   "value": "foo"
315                 }
316               ]
317             }
318           ],
319           "name": {
320             "firstName": "foo",
321             "middleName": "foo",
322             "lastName": "foo"
323           },
324           "tags": [
325             {
326               "key": "foo",
327               "value": "foo"
328             }
329           ]
330         },
331         "pepStatus": [
332           {
333             "isPepHit": true,
334             "pepCountry": "AF",
335             "pepRank": "LEVEL_1"
336           }
337         ],
338         "tags": [
339           {
340             "key": "foo",
341             "value": "foo"
342           }
343         ],
344         "attachments": [
345           {
346             "files": [
347               {
348                 "s3Key": "foo",
349                 "filename": "foo",
350                 "size": 42,
351                 "bucket": "foo",
352                 "downloadLink": "foo",
353                 "aiSummary": "foo"
354               }
355             ],
356             "userId": "foo",
357             "id": "foo",
358             "comment": "foo",
359             "createdAt": 42,
360             "deletedAt": 42
361           }
362         ]
363       }
364     ],
365     "transactionLimits": {
366       "maximumDailyTransactionLimit": {
367         "amountValue": 42,
368         "amountCurrency": "1INCH"
369       },
370       "maximumWeeklyTransactionLimit": {
371         "amountValue": 42,
372         "amountCurrency": "1INCH"
373       },
374       "maximumMonthlyTransactionLimit": {
375         "amountValue": 42,
376         "amountCurrency": "1INCH"
377       },
378       "maximumQuarterlyTransactionLimit": {
379         "amountValue": 42,
380         "amountCurrency": "1INCH"
381       },
382       "maximumTransactionLimit": {
383         "amountValue": 42,
384         "amountCurrency": "1INCH"
385       },
386       "maximumYearlyTransactionLimit": {
387         "amountValue": 42,
388         "amountCurrency": "1INCH"
389       },
390       "paymentMethodLimits": {
391         "ACH": {
392           "transactionCountLimit": {
393             "day": 42,
394             "week": 42,
395             "month": 42,
396             "year": 42
397           },
398           "transactionAmountLimit": {
399             "day": {
400               "amountValue": 42,
401               "amountCurrency": "1INCH"
402             },
403             "week": {
404               "amountValue": 42,
405               "amountCurrency": "1INCH"
406             },
407             "month": {
408               "amountValue": 42,
409               "amountCurrency": "1INCH"
410             },
411             "year": {
412               "amountValue": 42,
413               "amountCurrency": "1INCH"
414             }
415           },
416           "averageTransactionAmountLimit": {
417             "day": {
418               "amountValue": 42,
419               "amountCurrency": "1INCH"
420             },
421             "week": {
422               "amountValue": 42,
423               "amountCurrency": "1INCH"
424             },
425             "month": {
426               "amountValue": 42,
427               "amountCurrency": "1INCH"
428             },
429             "year": {
430               "amountValue": 42,
431               "amountCurrency": "1INCH"
432             }
433           }
434         },
435         "CARD": {
436           "transactionCountLimit": {
437             "day": 42,
438             "week": 42,
439             "month": 42,
440             "year": 42
441           },
442           "transactionAmountLimit": {
443             "day": {
444               "amountValue": 42,
445               "amountCurrency": "1INCH"
446             },
447             "week": {
448               "amountValue": 42,
449               "amountCurrency": "1INCH"
450             },
451             "month": {
452               "amountValue": 42,
453               "amountCurrency": "1INCH"
454             },
455             "year": {
456               "amountValue": 42,
457               "amountCurrency": "1INCH"
458             }
459           },
460           "averageTransactionAmountLimit": {
461             "day": {
462               "amountValue": 42,
463               "amountCurrency": "1INCH"
464             },
465             "week": {
466               "amountValue": 42,
467               "amountCurrency": "1INCH"
468             },
469             "month": {
470               "amountValue": 42,
471               "amountCurrency": "1INCH"
472             },
473             "year": {
474               "amountValue": 42,
475               "amountCurrency": "1INCH"
476             }
477           }
478         },
479         "IBAN": {
480           "transactionCountLimit": {
481             "day": 42,
482             "week": 42,
483             "month": 42,
484             "year": 42
485           },
486           "transactionAmountLimit": {
487             "day": {
488               "amountValue": 42,
489               "amountCurrency": "1INCH"
490             },
491             "week": {
492               "amountValue": 42,
493               "amountCurrency": "1INCH"
494             },
495             "month": {
496               "amountValue": 42,
497               "amountCurrency": "1INCH"
498             },
499             "year": {
500               "amountValue": 42,
501               "amountCurrency": "1INCH"
502             }
503           },
504           "averageTransactionAmountLimit": {
505             "day": {
506               "amountValue": 42,
507               "amountCurrency": "1INCH"
508             },
509             "week": {
510               "amountValue": 42,
511               "amountCurrency": "1INCH"
512             },
513             "month": {
514               "amountValue": 42,
515               "amountCurrency": "1INCH"
516             },
517             "year": {
518               "amountValue": 42,
519               "amountCurrency": "1INCH"
520             }
521           }
522         },
523         "UPI": {
524           "transactionCountLimit": {
525             "day": 42,
526             "week": 42,
527             "month": 42,
528             "year": 42
529           },
530           "transactionAmountLimit": {
531             "day": {
532               "amountValue": 42,
533               "amountCurrency": "1INCH"
534             },
535             "week": {
536               "amountValue": 42,
537               "amountCurrency": "1INCH"
538             },
539             "month": {
540               "amountValue": 42,
541               "amountCurrency": "1INCH"
542             },
543             "year": {
544               "amountValue": 42,
545               "amountCurrency": "1INCH"
546             }
547           },
548           "averageTransactionAmountLimit": {
549             "day": {
550               "amountValue": 42,
551               "amountCurrency": "1INCH"
552             },
553             "week": {
554               "amountValue": 42,
555               "amountCurrency": "1INCH"
556             },
557             "month": {
558               "amountValue": 42,
559               "amountCurrency": "1INCH"
560             },
561             "year": {
562               "amountValue": 42,
563               "amountCurrency": "1INCH"
564             }
565           }
566         },
567         "GENERIC_BANK_ACCOUNT": {
568           "transactionCountLimit": {
569             "day": 42,
570             "week": 42,
571             "month": 42,
572             "year": 42
573           },
574           "transactionAmountLimit": {
575             "day": {
576               "amountValue": 42,
577               "amountCurrency": "1INCH"
578             },
579             "week": {
580               "amountValue": 42,
581               "amountCurrency": "1INCH"
582             },
583             "month": {
584               "amountValue": 42,
585               "amountCurrency": "1INCH"
586             },
587             "year": {
588               "amountValue": 42,
589               "amountCurrency": "1INCH"
590             }
591           },
592           "averageTransactionAmountLimit": {
593             "day": {
594               "amountValue": 42,
595               "amountCurrency": "1INCH"
596             },
597             "week": {
598               "amountValue": 42,
599               "amountCurrency": "1INCH"
600             },
601             "month": {
602               "amountValue": 42,
603               "amountCurrency": "1INCH"
604             },
605             "year": {
606               "amountValue": 42,
607               "amountCurrency": "1INCH"
608             }
609           }
610         },
611         "MPESA": {
612           "transactionCountLimit": {
613             "day": 42,
614             "week": 42,
615             "month": 42,
616             "year": 42
617           },
618           "transactionAmountLimit": {
619             "day": {
620               "amountValue": 42,
621               "amountCurrency": "1INCH"
622             },
623             "week": {
624               "amountValue": 42,
625               "amountCurrency": "1INCH"
626             },
627             "month": {
628               "amountValue": 42,
629               "amountCurrency": "1INCH"
630             },
631             "year": {
632               "amountValue": 42,
633               "amountCurrency": "1INCH"
634             }
635           },
636           "averageTransactionAmountLimit": {
637             "day": {
638               "amountValue": 42,
639               "amountCurrency": "1INCH"
640             },
641             "week": {
642               "amountValue": 42,
643               "amountCurrency": "1INCH"
644             },
645             "month": {
646               "amountValue": 42,
647               "amountCurrency": "1INCH"
648             },
649             "year": {
650               "amountValue": 42,
651               "amountCurrency": "1INCH"
652             }
653           }
654         },
655         "SWIFT": {
656           "transactionCountLimit": {
657             "day": 42,
658             "week": 42,
659             "month": 42,
660             "year": 42
661           },
662           "transactionAmountLimit": {
663             "day": {
664               "amountValue": 42,
665               "amountCurrency": "1INCH"
666             },
667             "week": {
668               "amountValue": 42,
669               "amountCurrency": "1INCH"
670             },
671             "month": {
672               "amountValue": 42,
673               "amountCurrency": "1INCH"
674             },
675             "year": {
676               "amountValue": 42,
677               "amountCurrency": "1INCH"
678             }
679           },
680           "averageTransactionAmountLimit": {
681             "day": {
682               "amountValue": 42,
683               "amountCurrency": "1INCH"
684             },
685             "week": {
686               "amountValue": 42,
687               "amountCurrency": "1INCH"
688             },
689             "month": {
690               "amountValue": 42,
691               "amountCurrency": "1INCH"
692             },
693             "year": {
694               "amountValue": 42,
695               "amountCurrency": "1INCH"
696             }
697           }
698         },
699         "WALLET": {
700           "transactionCountLimit": {
701             "day": 42,
702             "week": 42,
703             "month": 42,
704             "year": 42
705           },
706           "transactionAmountLimit": {
707             "day": {
708               "amountValue": 42,
709               "amountCurrency": "1INCH"
710             },
711             "week": {
712               "amountValue": 42,
713               "amountCurrency": "1INCH"
714             },
715             "month": {
716               "amountValue": 42,
717               "amountCurrency": "1INCH"
718             },
719             "year": {
720               "amountValue": 42,
721               "amountCurrency": "1INCH"
722             }
723           },
724           "averageTransactionAmountLimit": {
725             "day": {
726               "amountValue": 42,
727               "amountCurrency": "1INCH"
728             },
729             "week": {
730               "amountValue": 42,
731               "amountCurrency": "1INCH"
732             },
733             "month": {
734               "amountValue": 42,
735               "amountCurrency": "1INCH"
736             },
737             "year": {
738               "amountValue": 42,
739               "amountCurrency": "1INCH"
740             }
741           }
742         },
743         "CHECK": {
744           "transactionCountLimit": {
745             "day": 42,
746             "week": 42,
747             "month": 42,
748             "year": 42
749           },
750           "transactionAmountLimit": {
751             "day": {
752               "amountValue": 42,
753               "amountCurrency": "1INCH"
754             },
755             "week": {
756               "amountValue": 42,
757               "amountCurrency": "1INCH"
758             },
759             "month": {
760               "amountValue": 42,
761               "amountCurrency": "1INCH"
762             },
763             "year": {
764               "amountValue": 42,
765               "amountCurrency": "1INCH"
766             }
767           },
768           "averageTransactionAmountLimit": {
769             "day": {
770               "amountValue": 42,
771               "amountCurrency": "1INCH"
772             },
773             "week": {
774               "amountValue": 42,
775               "amountCurrency": "1INCH"
776             },
777             "month": {
778               "amountValue": 42,
779               "amountCurrency": "1INCH"
780             },
781             "year": {
782               "amountValue": 42,
783               "amountCurrency": "1INCH"
784             }
785           }
786         }
787       }
788     },
789     "riskLevel": "VERY_HIGH",
790     "kycRiskLevel": "VERY_HIGH",
791     "allowedPaymentMethods": [
792       "ACH"
793     ],
794     "linkedEntities": {
795       "parentUserId": "foo"
796     },
797     "acquisitionChannel": "ORGANIC",
798     "savedPaymentDetails": [
799       {
800         "method": "CARD",
801         "cardFingerprint": "foo",
802         "emailId": "foo",
803         "cardStatus": "ACTIVE",
804         "cardIssuedCountry": "AF",
805         "transactionReferenceField": "foo",
806         "3dsDone": true,
807         "nameOnCard": {
808           "firstName": "foo",
809           "middleName": "foo",
810           "lastName": "foo"
811         },
812         "cardExpiry": {
813           "month": 42,
814           "year": 42
815         },
816         "posDetails": {
817           "entryMode": "0"
818         },
819         "cardLast4Digits": "foo",
820         "cardBrand": "VISA",
821         "cardFunding": "CREDIT",
822         "cardAuthenticated": true,
823         "cardTokenized": true,
824         "cardPresent": true,
825         "paymentChannel": "foo",
826         "cardType": "VIRTUAL",
827         "cardBalance": {
828           "amountValue": 42,
829           "amountCurrency": "1INCH"
830         },
831         "merchantDetails": {
832           "id": "foo",
833           "name": "foo",
834           "category": "foo",
835           "MCC": "foo",
836           "city": "foo",
837           "country": "AF",
838           "state": "foo",
839           "postCode": "foo"
840         },
841         "networkProviderRiskScore": 42,
842         "tags": [
843           {
844             "key": "foo",
845             "value": "foo"
846           }
847         ]
848       }
849     ],
850     "mccDetails": {
851       "code": 42,
852       "description": "foo"
853     },
854     "tags": [
855       {
856         "key": "foo",
857         "value": "foo",
858         "isEditable": true
859       }
860     ],
861     "attachments": [
862       {
863         "files": [
864           {
865             "s3Key": "foo",
866             "filename": "foo",
867             "size": 42,
868             "bucket": "foo",
869             "downloadLink": "foo",
870             "aiSummary": "foo"
871           }
872         ],
873         "userId": "foo",
874         "id": "foo",
875         "comment": "foo",
876         "createdAt": 42,
877         "deletedAt": 42
878       }
879     ]
880   },
881   "executedRules": [
882     {
883       "ruleInstanceId": "foo",
884       "ruleName": "foo",
885       "ruleDescription": "foo",
886       "ruleAction": "ALLOW",
887       "ruleHit": true,
888       "ruleId": "foo",
889       "executedAt": 42,
890       "ruleHitMeta": {
891         "hitDirections": [
892           "ORIGIN"
893         ],
894         "falsePositiveDetails": {
895           "isFalsePositive": true,
896           "confidenceScore": 42
897         },
898         "sanctionsDetails": [
899           {
900             "name": "foo",
901             "searchId": "foo",
902             "iban": "foo",
903             "entityType": "CONSUMER_NAME",
904             "sanctionHitIds": [
905               "foo"
906             ],
907             "hitContext": {
908               "entity": "USER",
909               "entityType": "CONSUMER_NAME",
910               "userId": "foo",
911               "transactionId": "foo",
912               "ruleInstanceId": "foo",
913               "ruleId": "foo",
914               "iban": "foo",
915               "yearOfBirth": 42,
916               "searchTerm": "foo",
917               "paymentMethodId": "foo"
918             }
919           }
920         ],
921         "isOngoingScreeningHit": true
922       },
923       "vars": [
924         {
925           "value": {},
926           "direction": "ORIGIN"
927         }
928       ],
929       "labels": [
930         "UNEXPECTED_BEHAVIOR"
931       ],
932       "nature": "AML",
933       "isShadow": true
934     }
935   ],
936   "hitRules": [
937     {
938       "ruleInstanceId": "foo",
939       "ruleName": "foo",
940       "ruleDescription": "foo",
941       "ruleAction": "ALLOW",
942       "ruleId": "foo",
943       "executedAt": 42,
944       "ruleHitMeta": {
945         "hitDirections": [
946           "ORIGIN"
947         ],
948         "falsePositiveDetails": {
949           "isFalsePositive": true,
950           "confidenceScore": 42
951         },
952         "sanctionsDetails": [
953           {
954             "name": "foo",
955             "searchId": "foo",
956             "iban": "foo",
957             "entityType": "CONSUMER_NAME",
958             "sanctionHitIds": [
959               "foo"
960             ],
961             "hitContext": {
962               "entity": "USER",
963               "entityType": "CONSUMER_NAME",
964               "userId": "foo",
965               "transactionId": "foo",
966               "ruleInstanceId": "foo",
967               "ruleId": "foo",
968               "iban": "foo",
969               "yearOfBirth": 42,
970               "searchTerm": "foo",
971               "paymentMethodId": "foo"
972             }
973           }
974         ],
975         "isOngoingScreeningHit": true
976       },
977       "labels": [
978         "UNEXPECTED_BEHAVIOR"
979       ],
980       "nature": "AML",
981       "isShadow": true
982     }
983   ],
984   "riskScoreDetails": {
985     "kycRiskScore": 42,
986     "craRiskScore": 42,
987     "kycRiskLevel": "VERY_HIGH",
988     "craRiskLevel": "VERY_HIGH"
989   }
990 }

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

eventIdstring or null

Unique event ID

reasonstring or null

Reason for the event or a state change

eventDescriptionstring or null

Event description

updatedBusinessUserAttributesobject or null

Model for a business user - optional fields

executedRuleslist of objects or null

hitRuleslist of objects or null

riskScoreDetailsobject or null

Retrieve a Business User Event

GET a Business User Event

Path parameters

Headers

Response

Errors