Business User Events

Retrieve a Business User Event

GET

Path parameters

eventIdstringRequired
Unique Business User Event Identifier

Response

This endpoint returns an object
timestamp
double
Timestamp of the event
userId
string
Transaction ID the event pertains to
eventId
stringOptional
Unique event ID
reason
stringOptional
Reason for the event or a state change
eventDescription
stringOptional
Event description
updatedBusinessUserAttributes
objectOptional
Model for a business user - optional fields

Errors

GET
1curl 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    "userStateDetails": {
9      "state": "UNACCEPTABLE",
10      "userId": "userId",
11      "reason": "reason"
12    },
13    "kycStatusDetails": {
14      "reason": "reason",
15      "status": "SUCCESSFUL",
16      "userId": "userId"
17    },
18    "legalEntity": {
19      "companyGeneralDetails": {
20        "legalName": "Ozkan Hazelnut Export JSC",
21        "businessIndustry": [
22          "Farming"
23        ],
24        "mainProductsServicesSold": [
25          "Hazelnut"
26        ],
27        "tags": [
28          {
29            "key": "customKey",
30            "value": "customValue"
31          }
32        ]
33      },
34      "companyFinancialDetails": {
35        "expectedTransactionAmountPerMonth": {
36          "amountValue": 800,
37          "amountCurrency": "GBP"
38        },
39        "expectedTurnoverPerMonth": {
40          "amountValue": 8000,
41          "amountCurrency": "USD"
42        },
43        "tags": [
44          {
45            "key": "customKey",
46            "value": "customValue"
47          }
48        ]
49      },
50      "companyRegistrationDetails": {
51        "registrationIdentifier": "PSJ554342",
52        "registrationCountry": "DE",
53        "tags": [
54          {
55            "key": "customKey",
56            "value": "customValue"
57          }
58        ]
59      },
60      "reasonForAccountOpening": [
61        "string"
62      ],
63      "sourceOfFunds": [
64        "Earnings"
65      ],
66      "contactDetails": {
67        "addresses": [
68          {
69            "addressLines": [
70              "Klara-Franke Str 20"
71            ],
72            "city": "Berlin",
73            "country": "Germany",
74            "postcode": "10557",
75            "state": "Berlin",
76            "tags": [
77              {
78                "key": "customKey",
79                "value": "customValue"
80              }
81            ]
82          }
83        ]
84      }
85    },
86    "shareHolders": [
87      {
88        "generalDetails": {
89          "name": {
90            "firstName": "Baran",
91            "middleName": "Realblood",
92            "lastName": "Ozkan"
93          },
94          "dateOfBirth": "1991-01-01",
95          "countryOfResidence": "US",
96          "countryOfNationality": "DE"
97        },
98        "legalDocuments": [
99          {
100            "documentType": "passport",
101            "documentNumber": "Z9431P",
102            "documentIssuedCountry": "DE",
103            "documentIssuedDate": 1639939034000,
104            "documentExpirationDate": 1839939034000,
105            "tags": [
106              {
107                "key": "customerType",
108                "value": "wallet"
109              }
110            ],
111            "nameOnDocument": {
112              "firstName": "Baran",
113              "middleName": "Realblood",
114              "lastName": "Ozkan"
115            }
116          }
117        ],
118        "contactDetails": {
119          "emailIds": [
120            "baran@flagright.com"
121          ],
122          "contactNumbers": [
123            "+371 123132"
124          ],
125          "websites": [
126            "flagright.com"
127          ],
128          "addresses": [
129            {
130              "addressLines": [
131                "Klara-Franke Str 20"
132              ],
133              "city": "Berlin",
134              "country": "Germany",
135              "postcode": "10557",
136              "state": "Berlin",
137              "tags": [
138                {
139                  "key": "customKey",
140                  "value": "customValue"
141                }
142              ]
143            }
144          ]
145        },
146        "tags": [
147          {
148            "key": "customKey",
149            "value": "customValue"
150          }
151        ]
152      }
153    ],
154    "directors": [
155      {
156        "generalDetails": {
157          "name": {
158            "firstName": "Baran",
159            "middleName": "Realblood",
160            "lastName": "Ozkan"
161          },
162          "dateOfBirth": "1991-01-01",
163          "countryOfResidence": "US",
164          "countryOfNationality": "DE"
165        },
166        "legalDocuments": [
167          {
168            "documentType": "passport",
169            "documentNumber": "Z9431P",
170            "documentIssuedCountry": "DE",
171            "documentIssuedDate": 1639939034000,
172            "documentExpirationDate": 1839939034000,
173            "tags": [
174              {
175                "key": "customerType",
176                "value": "wallet"
177              }
178            ],
179            "nameOnDocument": {
180              "firstName": "Baran",
181              "middleName": "Realblood",
182              "lastName": "Ozkan"
183            }
184          }
185        ],
186        "contactDetails": {
187          "emailIds": [
188            "baran@flagright.com"
189          ],
190          "contactNumbers": [
191            "+371 123132"
192          ],
193          "websites": [
194            "flagright.com"
195          ],
196          "addresses": [
197            {
198              "addressLines": [
199                "Klara-Franke Str 20"
200              ],
201              "city": "Berlin",
202              "country": "Germany",
203              "postcode": "10557",
204              "state": "Berlin",
205              "tags": [
206                {
207                  "key": "customKey",
208                  "value": "customValue"
209                }
210              ]
211            }
212          ]
213        },
214        "tags": [
215          {
216            "key": "customKey",
217            "value": "customValue"
218          }
219        ]
220      }
221    ],
222    "transactionLimits": {
223      "maximumDailyTransactionLimit": {
224        "amountValue": 800,
225        "amountCurrency": "GBP"
226      },
227      "maximumWeeklyTransactionLimit": {
228        "amountValue": 800,
229        "amountCurrency": "GBP"
230      },
231      "maximumMonthlyTransactionLimit": {
232        "amountValue": 800,
233        "amountCurrency": "GBP"
234      },
235      "maximumQuarterlyTransactionLimit": {
236        "amountValue": 800,
237        "amountCurrency": "GBP"
238      },
239      "maximumTransactionLimit": {
240        "amountValue": 800,
241        "amountCurrency": "GBP"
242      },
243      "maximumYearlyTransactionLimit": {
244        "amountValue": 800,
245        "amountCurrency": "GBP"
246      }
247    },
248    "riskLevel": "VERY_HIGH",
249    "allowedPaymentMethods": [
250      "ACH"
251    ],
252    "linkedEntities": {
253      "parentUserId": "parentUserId",
254      "childUserIds": [
255        "childUserIds"
256      ]
257    },
258    "acquisitionChannel": "ORGANIC",
259    "mccDetails": {
260      "code": 1.1,
261      "description": "description"
262    },
263    "tags": [
264      {
265        "key": "customKey",
266        "value": "customValue"
267      }
268    ]
269  }
270}
Built with