Get beneficiary

Retrieves a single beneficiary by ID.

Authentication

AuthorizationBearer
Token obtained via the login flow.

Path parameters

beneficiaryIdstringRequired

Response

Beneficiary details.
beneficiaryIdstring
statusenum

Poll until active before referencing in a withdrawal.

currencystring
One currency per beneficiary.
namestring
Legal name.
entityTypeenum
accountDetailslist of objects
routingDetailslist of objects
createdAtdatetime
statusReasonenum or null
addressobject
activatedAtdatetime or null

Errors

401
Unauthorized Error
404
Not Found Error