Skip to main content
GET
Get Beneficiary

Path Parameters

string
required
The account’s external ID (starts with acc_)
string
required
The beneficiary’s external ID (starts with bene_)

Response

string
Beneficiary identifier (starts with bene_)
string
Always returns "beneficiary"
string
Parent account external ID
string
Beneficiary type: individual or business
string
Title (e.g., Mr, Ms, Dr)
string
First name
string
Middle name
string
Last name
string
Display name
string
Company name (for business beneficiaries)
string
Email address
string
Phone number
object
Beneficiary address
string
Payout country code
string
Beneficiary status: active, disabled, or inactive
boolean
Whether beneficiary has been verified
array
Array of payout destination objects associated with this beneficiary
string
ISO 8601 timestamp when created
string
ISO 8601 timestamp when last updated

Response Example