Users - Search

GET

Users Search

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

Query parameters

namestringOptional

emailstringOptional

startstringOptional

pageSizeintegerOptional

sortOrder"asc" or "desc"Optional

Allowed values: ascdesc

sortBy"createdTimestamp" or "updatedAt"Optional

Allowed values: createdTimestampupdatedAt

Response

This endpoint returns an object.

itemslist of objectsOptional

hasNextbooleanOptional

hasPrevbooleanOptional

nextstringOptional

prevstringOptional

countintegerOptional

pageSizeintegerOptional

laststringOptional

Errors

GET

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

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       "employmentStatus": "UNEMPLOYED",
21       "occupation": "occupation",
22       "legalDocuments": [
23         {
24           "documentType": "passport",
25           "documentNumber": "Z9431P",
26           "documentIssuedDate": 1639939034000,
27           "documentExpirationDate": 1839939034000,
28           "documentIssuedCountry": "DE",
29           "tags": [
30             {
31               "key": "customerType",
32               "value": "wallet"
33             }
34           ],
35           "nameOnDocument": {
36             "firstName": "Baran",
37             "middleName": "Realblood",
38             "lastName": "Ozkan"
39           }
40         }
41       ],
42       "contactDetails": {
43         "addresses": [
44           {
45             "addressLines": [
46               "Klara-Franke Str 20"
47             ],
48             "postcode": "10557",
49             "city": "Berlin",
50             "state": "Berlin",
51             "country": "Germany",
52             "tags": [
53               {
54                 "key": "customKey",
55                 "value": "customValue"
56               }
57             ]
58           }
59         ]
60       },
61       "transactionLimits": {
62         "maximumDailyTransactionLimit": {
63           "amountValue": 800,
64           "amountCurrency": "GBP"
65         },
66         "maximumWeeklyTransactionLimit": {
67           "amountValue": 800,
68           "amountCurrency": "GBP"
69         },
70         "maximumMonthlyTransactionLimit": {
71           "amountValue": 800,
72           "amountCurrency": "GBP"
73         },
74         "maximumQuarterlyTransactionLimit": {
75           "amountValue": 800,
76           "amountCurrency": "GBP"
77         },
78         "maximumTransactionLimit": {
79           "amountValue": 800,
80           "amountCurrency": "GBP"
81         },
82         "maximumYearlyTransactionLimit": {
83           "amountValue": 800,
84           "amountCurrency": "GBP"
85         }
86       },
87       "expectedIncome": {
88         "dailyExpectedIncome": {
89           "amountValue": 800,
90           "amountCurrency": "GBP"
91         },
92         "weeklyExpectedIncome": {
93           "amountValue": 800,
94           "amountCurrency": "GBP"
95         },
96         "monthlyExpectedIncome": {
97           "amountValue": 800,
98           "amountCurrency": "GBP"
99         },
100         "quarterlyExpectedIncome": {
101           "amountValue": 800,
102           "amountCurrency": "GBP"
103         },
104         "yearlyExpectedIncome": {
105           "amountValue": 800,
106           "amountCurrency": "GBP"
107         }
108       },
109       "riskLevel": "VERY_HIGH",
110       "acquisitionChannel": "ORGANIC",
111       "reasonForAccountOpening": [
112         "reasonForAccountOpening"
113       ],
114       "sourceOfFunds": [
115         "Earnings"
116       ],
117       "userSegment": "RETAIL",
118       "pepStatus": [
119         {
120           "isPepHit": true
121         }
122       ],
123       "tags": [
124         {
125           "key": "customKey",
126           "value": "customValue"
127         }
128       ]
129     }
130   ],
131   "hasNext": true,
132   "hasPrev": true,
133   "next": "next",
134   "prev": "prev",
135   "count": 1,
136   "pageSize": 1,
137   "last": "last"
138 }

Built with

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

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	"employmentStatus": "UNEMPLOYED",
21	"occupation": "occupation",
22	"legalDocuments": [
23	{
24	"documentType": "passport",
25	"documentNumber": "Z9431P",
26	"documentIssuedDate": 1639939034000,
27	"documentExpirationDate": 1839939034000,
28	"documentIssuedCountry": "DE",
29	"tags": [
30	{
31	"key": "customerType",
32	"value": "wallet"
33	}
34	],
35	"nameOnDocument": {
36	"firstName": "Baran",
37	"middleName": "Realblood",
38	"lastName": "Ozkan"
39	}
40	}
41	],
42	"contactDetails": {
43	"addresses": [
44	{
45	"addressLines": [
46	"Klara-Franke Str 20"
47	],
48	"postcode": "10557",
49	"city": "Berlin",
50	"state": "Berlin",
51	"country": "Germany",
52	"tags": [
53	{
54	"key": "customKey",
55	"value": "customValue"
56	}
57	]
58	}
59	]
60	},
61	"transactionLimits": {
62	"maximumDailyTransactionLimit": {
63	"amountValue": 800,
64	"amountCurrency": "GBP"
65	},
66	"maximumWeeklyTransactionLimit": {
67	"amountValue": 800,
68	"amountCurrency": "GBP"
69	},
70	"maximumMonthlyTransactionLimit": {
71	"amountValue": 800,
72	"amountCurrency": "GBP"
73	},
74	"maximumQuarterlyTransactionLimit": {
75	"amountValue": 800,
76	"amountCurrency": "GBP"
77	},
78	"maximumTransactionLimit": {
79	"amountValue": 800,
80	"amountCurrency": "GBP"
81	},
82	"maximumYearlyTransactionLimit": {
83	"amountValue": 800,
84	"amountCurrency": "GBP"
85	}
86	},
87	"expectedIncome": {
88	"dailyExpectedIncome": {
89	"amountValue": 800,
90	"amountCurrency": "GBP"
91	},
92	"weeklyExpectedIncome": {
93	"amountValue": 800,
94	"amountCurrency": "GBP"
95	},
96	"monthlyExpectedIncome": {
97	"amountValue": 800,
98	"amountCurrency": "GBP"
99	},
100	"quarterlyExpectedIncome": {
101	"amountValue": 800,
102	"amountCurrency": "GBP"
103	},
104	"yearlyExpectedIncome": {
105	"amountValue": 800,
106	"amountCurrency": "GBP"
107	}
108	},
109	"riskLevel": "VERY_HIGH",
110	"acquisitionChannel": "ORGANIC",
111	"reasonForAccountOpening": [
112	"reasonForAccountOpening"
113	],
114	"sourceOfFunds": [
115	"Earnings"
116	],
117	"userSegment": "RETAIL",
118	"pepStatus": [
119	{
120	"isPepHit": true
121	}
122	],
123	"tags": [
124	{
125	"key": "customKey",
126	"value": "customValue"
127	}
128	]
129	}
130	],
131	"hasNext": true,
132	"hasPrev": true,
133	"next": "next",
134	"prev": "prev",
135	"count": 1,
136	"pageSize": 1,
137	"last": "last"
138	}