List beneficiaries
Returns a keyset-paginated list of fiat payout beneficiaries owned by the authenticated entity.
Only returns non-deleted records. Use the status filter to narrow results.
GET
List beneficiaries
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
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 Number of results per page (1–100).
Required range:
1 <= x <= 100Keyset cursor — return results after this beneficiary ID.
Example:
"a1b2c3d4-e5f6-7890-abcd-ef1234567890"
Keyset cursor — return results before this beneficiary ID.
Example:
"a1b2c3d4-e5f6-7890-abcd-ef1234567890"
Response
Successfully retrieved beneficiary list.