HEhellosunset
Account Beneficiaries

Update beneficiary

Update a beneficiary designation.

patch/cases/{case_id}/bank-accounts/{account_id}/beneficiaries/{beneficiary_id}

Request

  • Base URL
    https://api.example.com/v1
  • Auth
    none declared

Request body

namestring required
relationshipstring
percentage_sharenumber double
designation_type'pod' | 'tod' required
is_contingentboolean
status'active' | 'claimed' | 'pending_verification'

Example request

{
  "contact_info": {
    "address": {
      "address1": "123 Main Street",
      "city": "Salt Lake City",
      "state": "UT",
      "zip": "84101"
    }
  }
}

Response

Beneficiary updated.

Example response

{
  "data": {
    "id": "01K6AB05EJ3T10HRYE78AN7BCD",
    "name": "John Jonas Johnson",
    "relationship": "son",
    "percentage_share": 50,
    "designation_type": "pod",
    "contact_info": {
      "address": {
        "address1": "123 Main Street",
        "city": "Salt Lake City",
        "state": "UT",
        "zip": "84101"
      }
    },
    "status": "active"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.