List users
Users
List users
Retrieves a paginated list of users. Use cursor-based pagination by passing the nextCursor value from the response to get subsequent pages. In CORPORATE mode, use companyId to filter users by company.
GET
List users
Authorizations
API key as Bearer token
Headers
API version (YYYY-MM-DD)
Available options:
2025-02-14 Example:
"2025-02-14"
Query Parameters
Maximum number of items to return (1-100, default: 20)
Required range:
x <= 100Examples:
20
50
100
Opaque cursor for pagination. Pass nextCursor from previous response to get next page.
Filter users by exact ID match
Filter users by company ID (CORPORATE mode only)
Filter users by application status (comma-separated)
NOT_STARTED: KYC verification not yet initiatedIN_REVIEW: KYC application submitted and under reviewAPPROVED: KYC verified successfullyREJECTED: KYC rejected (final)RETRY_REQUIRED: KYC requires resubmission
Available options:
NOT_STARTED, IN_REVIEW, APPROVED, REJECTED, RETRY_REQUIRED