v1

latestOpenAPI 3.1.02026-07-24680631.6 KB

List Beneficiaries

List all existing beneficiaries on an account

get/beneficiary/{customerId}

Path parameters

customerIdstring required

Customer identifier

Headers

api-keystring required

API key

auth-keystring

Auth key generated using API key & secret

Response

200

statusinteger

Example response

{
  "status": 200,
  "doc": [
    {
      "stoBeneficiaryId": "27303095",
      "stoUserName": "user@009",
      "isPrimary": true,
      "beneficiaryType": "ENTITY",
      "beneficiaryName": "Toos Trust2",
      "benefitPct": "0.18",
      "beneficiaryPhone": "9090909090",
      "beneficiaryEmail": "tomstrust@gmail.com",
      "primaryContact": "Tommy Franklin",
      "formationDt": "2021-12-21"
    }
  ]
}