Retrieve all beneficiaries for a customer. Required scope: beneficiary:read.
Authorization
oauth2ClientCredentials beneficiary:readAuthorizationBearer <token>
Use your OAuth client credentials to obtain a short-lived Bearer token from POST /oauth/token.
In: header
Scope: beneficiary:read
Path Parameters
customer_id*string
Customer ID
Response Body
application/json
application/json
List beneficiaries
curl --request GET \ --url 'https://example.com/api/external/customer/string/beneficiary'{ "message": "Customers retrieved successfully.", "data": [ { "id": "9d4c4ec5-59ea-4130-bf8a-6a5edec401ee", "business_id": "9d4c4ec5-572d-49de-a362-f01ed09f2b1b", "first_name": "Halie", "last_name": "Skiles", "business_name": null, "type": "individual", "email": "danyka66@example.org", "country": "NG", "id_type": "passport", "id_number": "1DaRjlBTMZ", "verification_status": "PENDING" } ]}DELETEDelete a customer owner
Removes a beneficial owner from the customer. Returns 400 if the owner is locked (status APPROVED or PROCESSING). Required scope: `customer:write`. Note: owners can also be created and edited as part of `POST /api/external/customer` and `PUT /api/external/customer/{id}` via the `owners` array — only deletion has its own dedicated endpoint.
GETGet beneficiary
Retrieve details of a specific beneficiary for a customer. Required scope: `beneficiary:read`.