List All Beneficiaries for a Customer

Retrieve all Beneficiaries for a Customer Account. Beneficiaries can only belong to a Business Customer (not an Individual Customer).

Endpoint

GET /v1/customers/{customerId}/beneficiaries

Authorization Header

Authorization: Bearer <access_token>

Path Parameters

customerId REQUIRED

string (UUID)

ID of the Customer Account to which the Beneficiary belongs.

Request Body

None

Returns

Returns a response with an array of Beneficiary Quick Info objects.

SAMPLE RESPONSE

				
					[
  {
    "parentId": "69248436-39f5-4074-9823-76d2580c82a6",
    "id": "997dec9d-afcb-4843-a9e3-5333b6228229",
    "firstName": "Natialie",
    "middleName": "Sue",
    "lastName": "Smith",
    "primaryPhoneNumber": {
      "number": "+17512312345",
      "type": "MOBILE",
      "provider": "XYZ Mobile",
      "extension": "",
      "verified": false
    },
    "primaryEmail": {
      "value": "nsmith@example.com",
      "verified": false
    },
    "controller": true
  },
  {...},
  {...}
]