Skip to main content
GET
List all beneficiaries

Authorizations

Authorization
string
header
required

Enter Auth0 JWT token

Headers

Zuba-Account-Id
string<uuid>

Optional. Names an owned sub-account (UUID) to act on. Omit to act at the master (tenant) level. Naming an account this key does not own returns 403 not_account_owner.

Response

List of beneficiaries

accounts
object[]
required

Array of associated payment accounts

country
string
required

Country code (ISO 3166-1 alpha-2)

Example:

"DE"

createdAt
string<date-time>
required

ISO timestamp when the beneficiary was created

Example:

"2024-01-15T10:30:00Z"

id
string<uuid>
required

Unique identifier for the beneficiary

Example:

"123e4567-e89b-12d3-a456-426614174000"

name
string
required

Full name of the beneficiary

Example:

"John Doe"

status
enum<string>
required

Beneficiary status

Available options:
active,
inactive,
suspended
Example:

"active"

type
enum<string>
required

Beneficiary type

Available options:
individual,
business
Example:

"individual"

updatedAt
string<date-time>
required

ISO timestamp when the beneficiary was last updated

Example:

"2024-01-15T10:30:00Z"

accountId
string<uuid>

The sub-account this beneficiary belongs to. Absent on the workspace’s own. A headerless list is a rollup over both, so this is what tells them apart.

address
string

Address line 1 of the beneficiary

Example:

"Hauptstraße 123"

addressLine2
string

Address line 2 of the beneficiary

Example:

"Apt 4B, 3rd Floor"

city
string

City of the beneficiary

Example:

"Berlin"

countrySubdivision
string

Country subdivision code (e.g., US state code "NY", "CA")

Example:

"NY"

dateOfBirth
string

Date of birth in YYYY-MM-DD format (individual beneficiaries only).

Example:

"1985-05-20"

email
string

Email address of the beneficiary

Example:

"john.doe@example.com"

middleName
string

Middle name of the beneficiary

Example:

"James"

notes
string

Notes about the beneficiary

Example:

"Regular client, prefers SEPA Instant"

postcode
string

Postal code of the beneficiary

Example:

"10115"