Fetch user beneficiaries

get

https://api-beneficiary-beta.vertofx.com/recipients

Retrieve a paginated list of beneficiaries for the authenticated user with filtering and search capabilities

📘
NOTE:
Always confirm your Base URL: If you are testing in the sandbox environment, ensure your base URL is set to the sandbox base url: https://api-company-sandbox.vertofx.com, and if in production, use the production base URL: https://api-company-beta.vertofx.com. Using them interchangably will result in 403 errors.

Query Params

limit

int32

≤ 100

max records to return

skip

int32

number of items to skip

searchQuery

string

search in beneficiary list

filter

enum

add filter

Allowed:

currencyId

string

filter by currency

accountId

string

filter by account

accountNumbers

string

comma separated multiple account numbers

stablecoin

lists only stablecoin beneficiaries

isSelfAccount

string

filter by account

companyId

string

filter by company

accountIds

string

^[0-9,]+$

comma separated multiple account ids

skipLimitSkip

boolean

filter by company

reference

string

filter by query

isAccountActive

boolean

filter by query

adminVerified

string

filter by query

isBankCountryCode

boolean

check if bank country code is present

needsUpdate

boolean

filter by query

isUserRecordId

boolean

filter by query

excludeCompanyId

number

exclude beneficiaries from this company id

excludeReference

string

exclude beneficiaries from this reference

Response

200Successfully retrieved user beneficiaries