API Reference

List Beneficiaries

get
https://{base_url}/v2/beneficiaries
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
number
Defaults to 10

Page sizing

number
Defaults to 1

Page number

string
length between 1 and 64

Filter by counterparty name

string

Filter by currency code

string

Filter by country code

boolean

Filter for counterparties that are your own accounts

string

Filter by counterparty email address

string
length between 4 and 32

Search keyword for counterparty name, email, or reference

string

Filter by counterparty kind

string

Filter by blockchain network (for crypto counterparties)

Response

Updated over 1 year ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 1 year ago

Did this page help you?