Skip to main content
DELETE
/
v1
/
beneficiaries
/
{beneficiaryId}
cURL
curl --request DELETE \
  --url https://api.nxos.io/v1/beneficiaries/{beneficiaryId} \
  --header 'Authorization: <authorization>'
{
  "object": "beneficiary",
  "beneficiaryId": "bene_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
  "deleted": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.nxos.io/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
Authorization
string
required

Bearer token. Format: Bearer <api_key>

​
Idempotency-Key
string

Unique key per logical operation. UUID v4 recommended. Max 255 characters.

Path Parameters

​
beneficiaryId
string
required

Query Parameters

​
accountId
string
required

Account this beneficiary belongs to.

Response

The request has succeeded.

Confirmation that a beneficiary was archived.

​
object
enum<string>
required

Object type. Always beneficiary.

Available options:
beneficiary
​
beneficiaryId
string
required

The archived beneficiary's identifier.

​
deleted
boolean
required

Always true for delete responses.