Retrieve a Business User

GET

/business/users/:userId

GET

/business/users/:userId

1 from flagright import Flagright
2 
3 client = Flagright(
4     api_key="YOUR_API_KEY",
5 )
6 client.business_users.get(
7     user_id="userId",
8 )

Try it

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

GET Business User

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

Calling GET /business/user/{userId} will return the entire User payload and rule execution results for the User with the corresponding userId

Path parameters

userIdstringRequired

Response

userIdstring>=1 character

Unique user ID for the user

createdTimestampdouble>=315529200000<=4133890801000

Timestamp when the user was created

legalEntityobject

Model for business user legal entity details

activatedTimestampdoubleOptional>=315529200000<=4133890801000

Timestamp when the user was activated

userStateDetailsobjectOptional

kycStatusDetailsobjectOptional

shareHolderslist of objectsOptional

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

directorslist of objectsOptional

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

transactionLimitsobjectOptional

Model for transaction limits for a given user

riskLevelenumOptional

Allowed values:

kycRiskLevelenumOptional

Allowed values:

allowedPaymentMethodslist of enumsOptional

lastTransactionTimestampdoubleOptional

Timestamp of the last successful transaction of the user

linkedEntitiesobjectOptional

acquisitionChannelenumOptional

Model for User acquisition channel

savedPaymentDetailslist of objectsOptional

mccDetailsobjectOptional

tagslist of objectsOptional

Additional information that can be added via tags

attachmentslist of objectsOptional

User’s attachments uploaded by business user

executedRuleslist of objectsOptional

hitRuleslist of objectsOptional

riskScoreDetailsobjectOptional

Retrieve a Business User

GET Business User

Path parameters

Headers

Response

Errors