Skip to Content
Apex Settlement
Beneficiaries

List Beneficiaries

Required permissioncustomer:read
GET
/v1/beneficiaries

Every Beneficiary of the Customer, in each state: pending_verification (waiting for the operations team), verified (it can be quoted and paid) or blocked (final). Another Customer added by its Receiving Code shows only account_hint, never its account, and available says whether it can be paid now.

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.

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
[index: integer]?
Example Request
curl -X GET 'http://localhost:3480/v1/beneficiaries'
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"  }]