Skip to main content
GET
List users

Authorizations

Authorization
string
header
required

API key as Bearer token

Headers

Reap-Version
enum<string>
required

API version (YYYY-MM-DD)

Available options:
2025-02-14
Example:

"2025-02-14"

Query Parameters

limit
integer
default:20

Maximum number of items to return (1-100, default: 20)

Required range: x <= 100
Examples:

20

50

100

cursor
string

Opaque cursor for pagination. Pass nextCursor from previous response to get next page.

id
string<uuid>

Filter users by exact ID match

companyId
string<uuid>

Filter users by company ID (CORPORATE mode only)

applicationStatus
enum<string>[]

Filter users by application status (comma-separated)

  • NOT_STARTED: KYC verification not yet initiated
  • AWAITING_DOCUMENTS: Identity data submitted; supporting documents pending upload (Universal KYC only)
  • IN_REVIEW: KYC application submitted and under review
  • APPROVED: KYC verified successfully
  • REJECTED: KYC rejected (final)
  • RETRY_REQUIRED: KYC requires resubmission
Available options:
NOT_STARTED,
AWAITING_DOCUMENTS,
IN_REVIEW,
APPROVED,
REJECTED,
RETRY_REQUIRED

Response

Response for status 200

items
object[]
required
nextCursor
string | null
required

Cursor for next page, or null if no more items