Skip to main content
GET
/
v1
/
beneficiaries
cURL
curl --request GET \
  --url https://api.nxos.io/v1/beneficiaries \
  --header 'Authorization: <authorization>'
{
  "object": "list",
  "data": [
    {
      "object": "beneficiary",
      "beneficiaryId": "bene_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
      "accountId": "acct_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
      "type": "CRYPTO",
      "nickname": "Treasury Wallet",
      "status": "ACTIVE",
      "entityType": "INDIVIDUAL",
      "email": "[email protected]",
      "phoneNumber": null,
      "firstName": "John",
      "lastName": "Doe",
      "businessName": null,
      "country": "US",
      "crypto": {
        "chainName": "ethereum",
        "chainDisplayName": "Ethereum",
        "platform": "EVM",
        "address": "0x1234567890abcdef1234567890abcdef12345678"
      },
      "bank": null,
      "createdAt": "2025-03-10T12:00:00.000Z"
    }
  ],
  "hasMore": true,
  "nextCursor": "<string>"
}

Headers

​
Authorization
string
required

Bearer token. Format: Bearer <api_key>

Query Parameters

​
accountId
string
required

Account to list beneficiaries for.

​
type
enum<string>

Filter by beneficiary type. Beneficiary type.

Available options:
CRYPTO,
BANK
​
limit
integer<int32>
default:25

Maximum number of items to return. Defaults to 25, max 100.

​
cursor
string

Cursor for the next page of results, returned in previous responses.

Response

The request has succeeded.

Paginated list envelope. All list endpoints return this shape.

​
object
enum<string>
required

Object type. Always list for paginated responses.

Available options:
list
​
data
object[]
required

Array of results.

​
hasMore
boolean
required

Whether more results are available beyond this page.

​
nextCursor
string | null
required

Cursor to pass as cursor query parameter for the next page. Null when there are no more results.