Skip to Content
Apex Settlement
Beneficiaries

Get a Beneficiary

Required permissioncustomer:read
GET
/v1/beneficiaries/{id}

One of the Customer's Beneficiaries, as GET /v1/beneficiaries lists it.

Requires the customer:read permission. A Platform may call it for one of its End Customers with Apex-End-Customer.

Authorization

ApiKey
headerAuthorizationBearer <API key>

A Customer API key, created by a Customer admin in the Customer panel and shown once: Authorization: Bearer ak_live_… in production, ak_test_… elsewhere. A key holds a subset of its creator's permissions and may be limited to named IP addresses and an expiry date. Keys never manage people, other keys or approval rules, and never approve a Payout.

Path Parameters

id*string

The Beneficiary's id.

Formatuuid

Header Parameters

Apex-End-Customer?string

A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers end_customer_not_found.

Formatuuid

Response Body

OK

application/json
  1. response
account_hint?string

account_hint is the last four characters of the account paid.

asset*string

asset is what the Beneficiary is paid in.

available*boolean

available is false for a Beneficiary that is another Customer which cannot be paid now (neither a Receiving Account nor a balance it can be credited in, or it may not receive); it keeps its state, and a Payout to it is refused while it lasts.

country*string
created_at*string
Formatdate-time
delivers_to?string

delivers_to is, for another Customer, where a Payout to it would end now: balance (its balance on the platform; account_hint is then empty when it has no Receiving Account) or bank_account. Absent for other kinds and while it is unavailable.

Value in"balance""bank_account"
details*

details are the account fields, as registered; empty for another Customer.

id*string
kind*string

kind is external (an outside party), own_account (the Customer's own account elsewhere) or customer (another Customer, added by its Receiving Code).

Value in"external""own_account""customer"
name*string
party_type*string
Value in"individual""business"
state*string
Value in"pending_verification""verified""blocked"
updated_at*string
Formatdate-time
verified_at?string
Formatdate-time
Example Request
curl -X GET 'http://localhost:3480/v1/beneficiaries/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response
{  "account_hint": "3000",  "asset": "EUR",  "available": true,  "country": "DE",  "created_at": "2026-11-12T08:02:11Z",  "delivers_to": "balance",  "details": {    "iban": "DE89370400440532013000",    "name": "Berlin Supplies GmbH"  },  "id": "7a1e4c2b-9d3f-4e8a-b6c5-1f2e3d4c5b6a",  "kind": "external",  "name": "Berlin Supplies GmbH",  "party_type": "business",  "state": "verified",  "updated_at": "2026-11-12T08:15:00Z",  "verified_at": "2026-11-12T08:15:00Z"}