Skip to main content
GET
/
users
List users
curl --request GET \
  --url https://sandbox.api.reap.global/users/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Reap-Version: <reap-version>'
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "jsmith@example.com",
      "phoneNumber": "<string>",
      "firstName": "John",
      "lastName": "Doe",
      "country": "US",
      "dateOfBirth": "1990-05-15",
      "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "application": {
        "status": "NOT_STARTED",
        "rejectionReason": "<string>"
      },
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "nextCursor": "<string>"
}

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
  • 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,
IN_REVIEW,
APPROVED,
REJECTED,
RETRY_REQUIRED

Response

Response for status 200

items
object[]
required

Array of items for current page

nextCursor
string | null
required

Cursor for next page, or null if no more items