Skip to main content
GET
List beneficiaries

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

status
enum<string>

Filter by beneficiary status. Lifecycle status of a beneficiary.

  • INACTIVE — registered, pending risk screening.
  • ACTIVE — risk-screened and approved; eligible for payouts.
  • DENIED — rejected by risk screening; cannot be used for payouts.
  • STALE — corridor requirements have changed since registration; re-register to use.
  • DELETED — soft-deleted; cannot be used for payouts.
Available options:
INACTIVE,
ACTIVE,
DENIED,
STALE,
DELETED
pageSize
integer

Number of results per page (1–100).

Required range: 1 <= x <= 100
pageAfter
string<uuid>

Keyset cursor — return results after this beneficiary ID.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

pageBefore
string<uuid>

Keyset cursor — return results before this beneficiary ID.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Response

Successfully retrieved beneficiary list.

data
object[]