Get All Beneficiaries

GET /beneficiaries

Description

Retrieve all beneficiaries.

Path Parameters

Name	Type	Description
None		No parameters

Request Headers

Name	Type	Description
countryCode	string	Country code (required)
tenantId	string	Tenant ID (required)
userId	string	User ID (required)

Query Parameters

Name	Type	Description
userId	string	User ID (optional)
isRecent	boolean	Flag to filter recent beneficiaries (optional)
type	string	Type of beneficiaries (optional)
search	string	Search query for beneficiaries (optional)

Example

GET /beneficiaries?userId=123&isRecent=true&type=personal&search=john
countryCode: US
tenantId: tenant_01
userId: user_123

Response Code: 200 - Successful Description

Successful response.

Response Body

Content Type: application/json

{
  "status": true,
  "statusCode": 0,
  "message": "string",
  "data": {},
  "errors": [
    {
      "message": "string",
      "descriptiveMessage": "string"
    }
  ]
}

Example

{
  "status": true,
  "statusCode": 0,
  "message": "Request successful",
  "data": {
    "beneficiaries": [
      {
        "id": "1",
        "name": "John Doe",
        "type": "personal",
        "isRecent": true
      },
      {
        "id": "2",
        "name": "Jane Smith",
        "type": "business",
        "isRecent": false
      }
    ]
  },
  "errors": []
}

Method: GET

>http://20.87.230.105/platform/wallets/beneficiaries

Headers

Content-Type	Value
countryCode	US
tenantId	tenant_01
userId	user_123
apiKey	{{apiKey}}

Query Parameters

Name	Value
userId	123
isRecent	true
type	personal
search	john

###🔑 Authentication bearer

Param	Value	Type
token	{{accessCode}}	string