GuidesAPI Reference
Guides
API Reference

List all beneficiaries

Retrieves a paginated list of all beneficiaries associated with your integrator account. Beneficiaries are the individuals or businesses that can send or receive funds through your platform. Results can be filtered by status (active, inactive, pending verification), type (individual, business), creation date range, or search by name/email. Each result includes beneficiary ID, name, type, status, KYC/KYB verification state, and creation date. Use this for beneficiary management interfaces or to search for specific users.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Find beneficiaries with names that match ANY of the defined criteria

string

Find beneficiaries with names that match ALL of the defined criteria

string

Case-insensitive substring match against person.firstName, person.lastName, or business.name

string
enum

Exact match on beneficiary type

Allowed:
date-time

ISO-8601 datetime in UTC (inclusive lower bound on createdDate)

date-time

ISO-8601 datetime in UTC (inclusive upper bound on createdDate)

pageable
object
required

Pagination parameters including page number, size, and sorting options.

boolean
Defaults to false

When true, returns all results without pagination

Response

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json