Skip to main content
GET
Get a beneficiary

Authorizations

Authorization
string
header
required

Access token issued by POST /v1/auth/token.

x-zeam-auth
string
header
required

Application secret (the apiKey issued at registration), validated at the Kong edge.

Path Parameters

beneficiaryId
string<uuid>
required

Beneficiary identifier.

Response

The beneficiary.

id
string<uuid>
required
beneficiaryType
enum<string>
required
Available options:
Individual,
Business
reference
string
createdAt
string<date-time>
updatedAt
string<date-time>
individual
object
business
object
paymentDestinations
object[]
addresses
object[]
tags
object[]