Create a Business User Event — Flagright

POST Business User Events

/events/business/user endpoint allows you to operate on the Business User Events entity.

User events are created after the initial POST /business/users call (which creates a user) and are used to:

Update the STATE and KYC Status of the user, using the userStateDetails or kycStatusDetails field
Update the user details, using the updatedBusinessUserAttributes field.

If you have neither of the above two use cases, you do not need to use user events.

Payload

Each user event needs three mandatory fields:

timestamp- the timestamp of when the event was created or occured in your system
userId - The ID of the transaction for which this event is generated.

In order to make individual events retrievable, you also need to pass in a unique eventId to the request body.

Query parameters

allowUserTypeConversionenumOptional

Boolean string whether Flagright should allow a Business user event to be applied to a Consumer user with the same user ID. This will converts a Consumer user to a Business user.

Allowed values: truefalse

Request

This endpoint expects an object.

timestamp

doubleRequired

Timestamp of the event

userId

stringRequired

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

Response

This endpoint returns an object

userId

string

Unique user ID for the user

createdTimestamp

double

Timestamp when the user was created

legalEntity

object

Model for business user legal entity details

activatedTimestamp

doubleOptional

Timestamp when the user was activated

userStateDetails

objectOptional

kycStatusDetails

objectOptional

shareHolders

list of objectsOptional

Shareholders (beneficiaries) of the company that hold at least 25% ownership. Can be another company or an individual

directors

list of objectsOptional

Director(s) of the company. Must be at least one

transactionLimits

objectOptional

Model for transaction limits for a given user

riskLevel

enumOptional

Allowed values: VERY_HIGHHIGHMEDIUMLOWVERY_LOW

allowedPaymentMethods

list of enumsOptional

linkedEntities

objectOptional

acquisitionChannel

enumOptional

Model for User acquisition channel

savedPaymentDetails

list of unionsOptional

mccDetails

objectOptional

Errors

1 curl -X POST https://sandbox.api.flagright.com/events/business/user \ 2 -H "x-api-key: <apiKey>" \ 3 -H "Content-Type: application/json" \ 4 -d '{ 5 "timestamp": 1.1, 6 "userId": "userId" 7 }'

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

1	curl -X POST https://sandbox.api.flagright.com/events/business/user \
2	-H "x-api-key: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"timestamp": 1.1,
6	"userId": "userId"
7	}'

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