Retrieve all beneficiaries for a user

Requires beneficiaries:read scope. Optional scope beneficiaries_detail:read is needed for some extra fields such as postal address. Optional scope account_identifiers:masked (when enabled for your API client and included on the token) masks beneficiary account identifier fields in the response. See Sensitive information.

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

The total number of records to retrieve

integer
0 to 1000000000

The offset at which to start retrieving records

boolean

Whether the beneficiaries returned include duplicates with differing references

Responses

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