Get a beneficiary

Get beneficiary by ID

get
/v1/beneficiaries/{beneficiaryId}
Authorizations
Path parameters
beneficiaryIdstringRequired

Beneficiary ID

Responses
chevron-right
200

The beneficiary

application/json
idstringRequired

Unique beneficiary identifier

typestring · enumRequired

Beneficiary type

Possible values:
namestringOptional

Beneficiary name (for business type)

firstNamestringOptional

First name

lastNamestringOptional

Last name

emailstringOptional

Email address

telephonestringOptional

Telephone number

externalIdstringOptional

External identifier

addressLine1stringOptional

Address line 1

addressLine2stringOptional

Address line 2

buildingNamestringOptional

Building name

postalCodestringOptional

Postal code

citystringOptional

City

countrystringOptional

Country

statestringOptional

State

businessIdstringRequired

Associated business ID

createdAtstring · date-timeRequired

Beneficiary creation timestamp

updatedAtstring · date-timeOptional

Beneficiary last update timestamp

get
/v1/beneficiaries/{beneficiaryId}
200

The beneficiary

Last updated