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>"

Try it

200Retrieved

1 {
2   "items": [
3     {
4       "userId": "userId",
5       "createdTimestamp": 1.1,
6       "activatedTimestamp": 1.1,
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         "state": "UNACCEPTABLE"
19       },
20       "eoddDate": 1.1,
21       "employmentStatus": "UNEMPLOYED",
22       "occupation": "occupation",
23       "legalDocuments": [
24         {
25           "documentType": "passport",
26           "documentNumber": "Z9431P",
27           "documentIssuedDate": 1639939034000,
28           "documentExpirationDate": 1839939034000,
29           "documentIssuedCountry": "DE",
30           "tags": [
31             {
32               "key": "customerType",
33               "value": "wallet"
34             }
35           ],
36           "nameOnDocument": {
37             "firstName": "Baran",
38             "middleName": "Realblood",
39             "lastName": "Ozkan"
40           }
41         }
42       ],
43       "contactDetails": {
44         "addresses": [
45           {
46             "addressLines": [
47               "Klara-Franke Str 20"
48             ],
49             "postcode": "10557",
50             "city": "Berlin",
51             "state": "Berlin",
52             "country": "Germany",
53             "tags": [
54               {
55                 "key": "customKey",
56                 "value": "customValue"
57               }
58             ]
59           }
60         ]
61       },
62       "transactionLimits": {
63         "maximumDailyTransactionLimit": {
64           "amountValue": 800,
65           "amountCurrency": "GBP"
66         },
67         "maximumWeeklyTransactionLimit": {
68           "amountValue": 800,
69           "amountCurrency": "GBP"
70         },
71         "maximumMonthlyTransactionLimit": {
72           "amountValue": 800,
73           "amountCurrency": "GBP"
74         },
75         "maximumQuarterlyTransactionLimit": {
76           "amountValue": 800,
77           "amountCurrency": "GBP"
78         },
79         "maximumTransactionLimit": {
80           "amountValue": 800,
81           "amountCurrency": "GBP"
82         },
83         "maximumYearlyTransactionLimit": {
84           "amountValue": 800,
85           "amountCurrency": "GBP"
86         }
87       },
88       "expectedIncome": {
89         "dailyExpectedIncome": {
90           "amountValue": 800,
91           "amountCurrency": "GBP"
92         },
93         "weeklyExpectedIncome": {
94           "amountValue": 800,
95           "amountCurrency": "GBP"
96         },
97         "monthlyExpectedIncome": {
98           "amountValue": 800,
99           "amountCurrency": "GBP"
100         },
101         "quarterlyExpectedIncome": {
102           "amountValue": 800,
103           "amountCurrency": "GBP"
104         },
105         "yearlyExpectedIncome": {
106           "amountValue": 800,
107           "amountCurrency": "GBP"
108         }
109       },
110       "riskLevel": "VERY_HIGH",
111       "kycRiskLevel": "VERY_HIGH",
112       "acquisitionChannel": "ORGANIC",
113       "reasonForAccountOpening": [
114         "reasonForAccountOpening"
115       ],
116       "sourceOfFunds": [
117         "Earnings"
118       ],
119       "userSegment": "RETAIL",
120       "pepStatus": [
121         {
122           "isPepHit": true
123         }
124       ],
125       "sanctionsStatus": true,
126       "adverseMediaStatus": true,
127       "lastTransactionTimestamp": 1.1,
128       "savedPaymentDetails": [
129         {
130           "cardFingerprint": "20ac00fed8ef913aefb17cfae1097cce",
131           "cardIssuedCountry": "TR",
132           "transactionReferenceField": "Deposit",
133           "3dsDone": true,
134           "nameOnCard": {
135             "firstName": "Baran",
136             "middleName": "Realblood",
137             "lastName": "Ozkan"
138           },
139           "cardBalance": {
140             "amountValue": 800,
141             "amountCurrency": "GBP"
142           },
143           "tags": [
144             {
145               "key": "customKey",
146               "value": "customValue"
147             }
148           ],
149           "method": "CARD"
150         }
151       ],
152       "tags": [
153         {
154           "key": "key",
155           "value": "value"
156         }
157       ],
158       "attachments": [
159         {
160           "comment": "Arun's tax information",
161           "files": [
162             {
163               "s3Key": "s3Key",
164               "filename": "filename",
165               "size": 1.1
166             }
167           ],
168           "userId": "userId"
169         }
170       ]
171     }
172   ],
173   "hasNext": true,
174   "hasPrev": true,
175   "next": "next",
176   "prev": "prev",
177   "count": 1,
178   "pageSize": 1,
179   "last": "last"
180 }

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 objectsOptional

hasNextbooleanOptional

hasPrevbooleanOptional

nextstringOptional

prevstringOptional

countintegerOptional

pageSizeintegerOptional

laststringOptional

Users - Search

Users Search

Headers

Query parameters

Response

Errors