Users - Search

GET

/users/search

GET

/management/users/search

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

Try it

200getUsersSearchExample

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

Users Search

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

Query parameters

namestringOptional

emailstringOptional

startstringOptional

pageSizeintegerOptional>=1<=100

sortOrderenumOptional

Allowed values:

sortByenumOptional

Allowed values:

Response

itemslist of objects or null

hasNextboolean or null

hasPrevboolean or null

nextstring or null

prevstring or null

countinteger or null

pageSizeinteger or null

laststring or null

Users - Search

Users Search

Headers

Query parameters

Response

Errors