Skip to main content
GET
List related persons
Required scope: COMPANIES_READ

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"

Path Parameters

id
string<uuid>
required

Company identifier

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 related persons by exact ID match

status
enum<string>[]

Filter related persons by verification status (comma-separated)

  • NOT_STARTED: KYC verification not yet started
  • IN_REVIEW: KYC submitted and under review
  • APPROVED: KYC verified successfully
  • REJECTED: KYC rejected
Available options:
NOT_STARTED,
IN_REVIEW,
APPROVED,
REJECTED
includeArchived
string

When true, include archived related persons. Defaults to false (addressable persons only).

Response

Paginated list of related persons

items
object[]
required
nextCursor
string | null
required

Cursor for next page, or null if no more items