Users - Search

GET

/users/search

GET

/management/users/search

1 curl https://sandbox.api.flagright.com/management/users/search \
2      -H "x-api-key: <apiKey>"

1 {
2   "items": [
3     {
4       "userId": "string",
5       "createdTimestamp": 2220000000000,
6       "activatedTimestamp": 2220000000000,
7       "userDetails": {
8         "name": {
9           "firstName": "Baran",
10           "middleName": "Realblood",
11           "lastName": "Ozkan"
12         },
13         "dateOfBirth": "1991-01-01",
14         "countryOfResidence": "US",
15         "countryOfNationality": "DE"
16       },
17       "userStateDetails": {
18         "reason": "string",
19         "state": "UNACCEPTABLE"
20       },
21       "kycStatusDetails": {
22         "reason": "string",
23         "status": "SUCCESSFUL"
24       },
25       "eoddDate": 2220000000000,
26       "employmentStatus": "UNEMPLOYED",
27       "occupation": "string",
28       "legalDocuments": [
29         {
30           "documentType": "string",
31           "documentNumber": "string",
32           "documentIssuedDate": 2220000000000,
33           "documentExpirationDate": 2220000000000,
34           "documentIssuedCountry": "AF",
35           "tags": [
36             {
37               "key": "string",
38               "value": "string",
39               "isTimestamp": true
40             }
41           ],
42           "nameOnDocument": {
43             "firstName": "Baran",
44             "middleName": "Realblood",
45             "lastName": "Ozkan"
46           }
47         }
48       ],
49       "contactDetails": {
50         "emailIds": [
51           "string"
52         ],
53         "contactNumbers": [
54           "string"
55         ],
56         "faxNumbers": [
57           "string"
58         ],
59         "websites": [
60           "string"
61         ],
62         "addresses": [
63           {
64             "addressLines": [
65               "string"
66             ],
67             "postcode": "string",
68             "city": "string",
69             "state": "string",
70             "country": "string",
71             "addressType": "string",
72             "tags": [
73               {
74                 "key": "string",
75                 "value": "string",
76                 "isTimestamp": true
77               }
78             ]
79           }
80         ],
81         "name": {
82           "firstName": "Baran",
83           "middleName": "Realblood",
84           "lastName": "Ozkan"
85         },
86         "tags": [
87           {
88             "key": "string",
89             "value": "string",
90             "isTimestamp": true
91           }
92         ]
93       },
94       "employmentDetails": {
95         "employmentSector": "string",
96         "employerName": "string",
97         "businessIndustry": [
98           "string"
99         ]
100       },
101       "transactionLimits": {
102         "maximumDailyTransactionLimit": {
103           "amountValue": 800,
104           "amountCurrency": "GBP"
105         },
106         "maximumWeeklyTransactionLimit": {
107           "amountValue": 800,
108           "amountCurrency": "GBP"
109         },
110         "maximumMonthlyTransactionLimit": {
111           "amountValue": 800,
112           "amountCurrency": "GBP"
113         },
114         "maximumQuarterlyTransactionLimit": {
115           "amountValue": 800,
116           "amountCurrency": "GBP"
117         },
118         "maximumTransactionLimit": {
119           "amountValue": 800,
120           "amountCurrency": "GBP"
121         },
122         "maximumYearlyTransactionLimit": {
123           "amountValue": 800,
124           "amountCurrency": "GBP"
125         },
126         "paymentMethodLimits": {
127           "ACH": {
128             "transactionCountLimit": {
129               "day": 1.1,
130               "week": 1.1,
131               "month": 1.1,
132               "year": 1.1
133             },
134             "transactionAmountLimit": {
135               "day": {
136                 "amountValue": 800,
137                 "amountCurrency": "GBP"
138               },
139               "week": {
140                 "amountValue": 800,
141                 "amountCurrency": "GBP"
142               },
143               "month": {
144                 "amountValue": 800,
145                 "amountCurrency": "GBP"
146               },
147               "year": {
148                 "amountValue": 800,
149                 "amountCurrency": "GBP"
150               }
151             },
152             "averageTransactionAmountLimit": {
153               "day": {
154                 "amountValue": 800,
155                 "amountCurrency": "GBP"
156               },
157               "week": {
158                 "amountValue": 800,
159                 "amountCurrency": "GBP"
160               },
161               "month": {
162                 "amountValue": 800,
163                 "amountCurrency": "GBP"
164               },
165               "year": {
166                 "amountValue": 800,
167                 "amountCurrency": "GBP"
168               }
169             }
170           },
171           "CARD": {
172             "transactionCountLimit": {
173               "day": 1.1,
174               "week": 1.1,
175               "month": 1.1,
176               "year": 1.1
177             },
178             "transactionAmountLimit": {
179               "day": {
180                 "amountValue": 800,
181                 "amountCurrency": "GBP"
182               },
183               "week": {
184                 "amountValue": 800,
185                 "amountCurrency": "GBP"
186               },
187               "month": {
188                 "amountValue": 800,
189                 "amountCurrency": "GBP"
190               },
191               "year": {
192                 "amountValue": 800,
193                 "amountCurrency": "GBP"
194               }
195             },
196             "averageTransactionAmountLimit": {
197               "day": {
198                 "amountValue": 800,
199                 "amountCurrency": "GBP"
200               },
201               "week": {
202                 "amountValue": 800,
203                 "amountCurrency": "GBP"
204               },
205               "month": {
206                 "amountValue": 800,
207                 "amountCurrency": "GBP"
208               },
209               "year": {
210                 "amountValue": 800,
211                 "amountCurrency": "GBP"
212               }
213             }
214           },
215           "IBAN": {
216             "transactionCountLimit": {
217               "day": 1.1,
218               "week": 1.1,
219               "month": 1.1,
220               "year": 1.1
221             },
222             "transactionAmountLimit": {
223               "day": {
224                 "amountValue": 800,
225                 "amountCurrency": "GBP"
226               },
227               "week": {
228                 "amountValue": 800,
229                 "amountCurrency": "GBP"
230               },
231               "month": {
232                 "amountValue": 800,
233                 "amountCurrency": "GBP"
234               },
235               "year": {
236                 "amountValue": 800,
237                 "amountCurrency": "GBP"
238               }
239             },
240             "averageTransactionAmountLimit": {
241               "day": {
242                 "amountValue": 800,
243                 "amountCurrency": "GBP"
244               },
245               "week": {
246                 "amountValue": 800,
247                 "amountCurrency": "GBP"
248               },
249               "month": {
250                 "amountValue": 800,
251                 "amountCurrency": "GBP"
252               },
253               "year": {
254                 "amountValue": 800,
255                 "amountCurrency": "GBP"
256               }
257             }
258           },
259           "UPI": {
260             "transactionCountLimit": {
261               "day": 1.1,
262               "week": 1.1,
263               "month": 1.1,
264               "year": 1.1
265             },
266             "transactionAmountLimit": {
267               "day": {
268                 "amountValue": 800,
269                 "amountCurrency": "GBP"
270               },
271               "week": {
272                 "amountValue": 800,
273                 "amountCurrency": "GBP"
274               },
275               "month": {
276                 "amountValue": 800,
277                 "amountCurrency": "GBP"
278               },
279               "year": {
280                 "amountValue": 800,
281                 "amountCurrency": "GBP"
282               }
283             },
284             "averageTransactionAmountLimit": {
285               "day": {
286                 "amountValue": 800,
287                 "amountCurrency": "GBP"
288               },
289               "week": {
290                 "amountValue": 800,
291                 "amountCurrency": "GBP"
292               },
293               "month": {
294                 "amountValue": 800,
295                 "amountCurrency": "GBP"
296               },
297               "year": {
298                 "amountValue": 800,
299                 "amountCurrency": "GBP"
300               }
301             }
302           },
303           "GENERIC_BANK_ACCOUNT": {
304             "transactionCountLimit": {
305               "day": 1.1,
306               "week": 1.1,
307               "month": 1.1,
308               "year": 1.1
309             },
310             "transactionAmountLimit": {
311               "day": {
312                 "amountValue": 800,
313                 "amountCurrency": "GBP"
314               },
315               "week": {
316                 "amountValue": 800,
317                 "amountCurrency": "GBP"
318               },
319               "month": {
320                 "amountValue": 800,
321                 "amountCurrency": "GBP"
322               },
323               "year": {
324                 "amountValue": 800,
325                 "amountCurrency": "GBP"
326               }
327             },
328             "averageTransactionAmountLimit": {
329               "day": {
330                 "amountValue": 800,
331                 "amountCurrency": "GBP"
332               },
333               "week": {
334                 "amountValue": 800,
335                 "amountCurrency": "GBP"
336               },
337               "month": {
338                 "amountValue": 800,
339                 "amountCurrency": "GBP"
340               },
341               "year": {
342                 "amountValue": 800,
343                 "amountCurrency": "GBP"
344               }
345             }
346           },
347           "MPESA": {
348             "transactionCountLimit": {
349               "day": 1.1,
350               "week": 1.1,
351               "month": 1.1,
352               "year": 1.1
353             },
354             "transactionAmountLimit": {
355               "day": {
356                 "amountValue": 800,
357                 "amountCurrency": "GBP"
358               },
359               "week": {
360                 "amountValue": 800,
361                 "amountCurrency": "GBP"
362               },
363               "month": {
364                 "amountValue": 800,
365                 "amountCurrency": "GBP"
366               },
367               "year": {
368                 "amountValue": 800,
369                 "amountCurrency": "GBP"
370               }
371             },
372             "averageTransactionAmountLimit": {
373               "day": {
374                 "amountValue": 800,
375                 "amountCurrency": "GBP"
376               },
377               "week": {
378                 "amountValue": 800,
379                 "amountCurrency": "GBP"
380               },
381               "month": {
382                 "amountValue": 800,
383                 "amountCurrency": "GBP"
384               },
385               "year": {
386                 "amountValue": 800,
387                 "amountCurrency": "GBP"
388               }
389             }
390           },
391           "SWIFT": {
392             "transactionCountLimit": {
393               "day": 1.1,
394               "week": 1.1,
395               "month": 1.1,
396               "year": 1.1
397             },
398             "transactionAmountLimit": {
399               "day": {
400                 "amountValue": 800,
401                 "amountCurrency": "GBP"
402               },
403               "week": {
404                 "amountValue": 800,
405                 "amountCurrency": "GBP"
406               },
407               "month": {
408                 "amountValue": 800,
409                 "amountCurrency": "GBP"
410               },
411               "year": {
412                 "amountValue": 800,
413                 "amountCurrency": "GBP"
414               }
415             },
416             "averageTransactionAmountLimit": {
417               "day": {
418                 "amountValue": 800,
419                 "amountCurrency": "GBP"
420               },
421               "week": {
422                 "amountValue": 800,
423                 "amountCurrency": "GBP"
424               },
425               "month": {
426                 "amountValue": 800,
427                 "amountCurrency": "GBP"
428               },
429               "year": {
430                 "amountValue": 800,
431                 "amountCurrency": "GBP"
432               }
433             }
434           },
435           "WALLET": {
436             "transactionCountLimit": {
437               "day": 1.1,
438               "week": 1.1,
439               "month": 1.1,
440               "year": 1.1
441             },
442             "transactionAmountLimit": {
443               "day": {
444                 "amountValue": 800,
445                 "amountCurrency": "GBP"
446               },
447               "week": {
448                 "amountValue": 800,
449                 "amountCurrency": "GBP"
450               },
451               "month": {
452                 "amountValue": 800,
453                 "amountCurrency": "GBP"
454               },
455               "year": {
456                 "amountValue": 800,
457                 "amountCurrency": "GBP"
458               }
459             },
460             "averageTransactionAmountLimit": {
461               "day": {
462                 "amountValue": 800,
463                 "amountCurrency": "GBP"
464               },
465               "week": {
466                 "amountValue": 800,
467                 "amountCurrency": "GBP"
468               },
469               "month": {
470                 "amountValue": 800,
471                 "amountCurrency": "GBP"
472               },
473               "year": {
474                 "amountValue": 800,
475                 "amountCurrency": "GBP"
476               }
477             }
478           },
479           "CHECK": {
480             "transactionCountLimit": {
481               "day": 1.1,
482               "week": 1.1,
483               "month": 1.1,
484               "year": 1.1
485             },
486             "transactionAmountLimit": {
487               "day": {
488                 "amountValue": 800,
489                 "amountCurrency": "GBP"
490               },
491               "week": {
492                 "amountValue": 800,
493                 "amountCurrency": "GBP"
494               },
495               "month": {
496                 "amountValue": 800,
497                 "amountCurrency": "GBP"
498               },
499               "year": {
500                 "amountValue": 800,
501                 "amountCurrency": "GBP"
502               }
503             },
504             "averageTransactionAmountLimit": {
505               "day": {
506                 "amountValue": 800,
507                 "amountCurrency": "GBP"
508               },
509               "week": {
510                 "amountValue": 800,
511                 "amountCurrency": "GBP"
512               },
513               "month": {
514                 "amountValue": 800,
515                 "amountCurrency": "GBP"
516               },
517               "year": {
518                 "amountValue": 800,
519                 "amountCurrency": "GBP"
520               }
521             }
522           },
523           "CASH": {
524             "transactionCountLimit": {
525               "day": 1.1,
526               "week": 1.1,
527               "month": 1.1,
528               "year": 1.1
529             },
530             "transactionAmountLimit": {
531               "day": {
532                 "amountValue": 800,
533                 "amountCurrency": "GBP"
534               },
535               "week": {
536                 "amountValue": 800,
537                 "amountCurrency": "GBP"
538               },
539               "month": {
540                 "amountValue": 800,
541                 "amountCurrency": "GBP"
542               },
543               "year": {
544                 "amountValue": 800,
545                 "amountCurrency": "GBP"
546               }
547             },
548             "averageTransactionAmountLimit": {
549               "day": {
550                 "amountValue": 800,
551                 "amountCurrency": "GBP"
552               },
553               "week": {
554                 "amountValue": 800,
555                 "amountCurrency": "GBP"
556               },
557               "month": {
558                 "amountValue": 800,
559                 "amountCurrency": "GBP"
560               },
561               "year": {
562                 "amountValue": 800,
563                 "amountCurrency": "GBP"
564               }
565             }
566           },
567           "NPP": {
568             "transactionCountLimit": {
569               "day": 1.1,
570               "week": 1.1,
571               "month": 1.1,
572               "year": 1.1
573             },
574             "transactionAmountLimit": {
575               "day": {
576                 "amountValue": 800,
577                 "amountCurrency": "GBP"
578               },
579               "week": {
580                 "amountValue": 800,
581                 "amountCurrency": "GBP"
582               },
583               "month": {
584                 "amountValue": 800,
585                 "amountCurrency": "GBP"
586               },
587               "year": {
588                 "amountValue": 800,
589                 "amountCurrency": "GBP"
590               }
591             },
592             "averageTransactionAmountLimit": {
593               "day": {
594                 "amountValue": 800,
595                 "amountCurrency": "GBP"
596               },
597               "week": {
598                 "amountValue": 800,
599                 "amountCurrency": "GBP"
600               },
601               "month": {
602                 "amountValue": 800,
603                 "amountCurrency": "GBP"
604               },
605               "year": {
606                 "amountValue": 800,
607                 "amountCurrency": "GBP"
608               }
609             }
610           }
611         }
612       },
613       "expectedIncome": {
614         "dailyExpectedIncome": {
615           "amountValue": 800,
616           "amountCurrency": "GBP"
617         },
618         "weeklyExpectedIncome": {
619           "amountValue": 800,
620           "amountCurrency": "GBP"
621         },
622         "monthlyExpectedIncome": {
623           "amountValue": 800,
624           "amountCurrency": "GBP"
625         },
626         "quarterlyExpectedIncome": {
627           "amountValue": 800,
628           "amountCurrency": "GBP"
629         },
630         "yearlyExpectedIncome": {
631           "amountValue": 800,
632           "amountCurrency": "GBP"
633         }
634       },
635       "expectedTransactionCountries": {
636         "incoming": [
637           {
638             "countryCode": "AF"
639           }
640         ],
641         "outgoing": [
642           {
643             "countryCode": "AF"
644           }
645         ]
646       },
647       "expectedTransactionCurrencies": {
648         "incoming": [
649           {
650             "currencyCode": "1INCH"
651           }
652         ],
653         "outgoing": [
654           {
655             "currencyCode": "1INCH"
656           }
657         ]
658       },
659       "riskLevel": "VERY_HIGH",
660       "kycRiskLevel": "VERY_HIGH",
661       "acquisitionChannel": "ORGANIC",
662       "reasonForAccountOpening": [
663         "string"
664       ],
665       "sourceOfFunds": [
666         "Earnings"
667       ],
668       "userSegment": "RETAIL",
669       "pepStatus": [
670         {
671           "isPepHit": true,
672           "pepCountry": "AF",
673           "pepRank": "LEVEL_1",
674           "category": "string"
675         }
676       ],
677       "sanctionsStatus": true,
678       "adverseMediaStatus": true,
679       "corporateEntities": [
680         {
681           "legalName": "string"
682         }
683       ],
684       "linkedEntities": {
685         "parentUserId": "string"
686       },
687       "savedPaymentDetails": [
688         {
689           "method": "CARD",
690           "cardFingerprint": "20ac00fed8ef913aefb17cfae1097cce",
691           "cardIssuedCountry": "TR",
692           "transactionReferenceField": "Deposit",
693           "3dsDone": true
694         }
695       ],
696       "tags": [
697         {
698           "key": "string",
699           "value": "string",
700           "isTimestamp": true,
701           "isEditable": true
702         }
703       ],
704       "attachments": [
705         {
706           "id": "string",
707           "comment": "string",
708           "files": [
709             {
710               "s3Key": "string",
711               "bucket": "string",
712               "filename": "string",
713               "size": 1.1,
714               "downloadLink": "string",
715               "aiSummary": "string"
716             }
717           ],
718           "userId": "string",
719           "createdAt": 2220000000000,
720           "deletedAt": 2220000000000,
721           "tags": [
722             "string"
723           ]
724         }
725       ],
726       "metaData": {
727         "batteryLevel": 1.1,
728         "deviceLatitude": 1.1,
729         "deviceLongitude": 1.1,
730         "ipAddress": "string",
731         "ipCountry": "AF",
732         "deviceIdentifier": "string",
733         "vpnUsed": true,
734         "operatingSystem": "string",
735         "deviceMaker": "string",
736         "deviceModel": "string",
737         "deviceYear": "string",
738         "appVersion": "string"
739       },
740       "jurisdiction": "string",
741       "productsEnabled": [
742         {
743           "productName": "string"
744         }
745       ],
746       "externalLinks": [
747         "string"
748       ]
749     }
750   ],
751   "hasNext": true,
752   "hasPrev": true,
753   "next": "string",
754   "prev": "string",
755   "count": 1,
756   "pageSize": 1,
757   "last": "string"
758 }

Users Search

GET /users/search endpoint retrieves a list of users matching the specified search criteria.

Authentication

x-api-keystring

API keys are used to authenticate the requests.

Query parameters

namestringOptional

emailstringOptional

startstringOptional

pageSizeintegerOptional1-100

sortOrderenumOptional

Allowed values:

sortByenumOptional

Allowed values:

Response

itemslist of objects

hasNextboolean

hasPrevboolean

nextstring

prevstring

countinteger

pageSizeinteger

laststring

Errors

400

Bad Request Error