Skip to main content
PATCH
/
cases
/
{case_id}
/
bank-accounts
/
{account_id}
/
beneficiaries
/
{beneficiary_id}
Update beneficiary
curl --request PATCH \
  --url https://api.example.com/v1/cases/{case_id}/bank-accounts/{account_id}/beneficiaries/{beneficiary_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "designation_type": "pod",
  "relationship": "<string>",
  "percentage_share": 123,
  "is_contingent": true,
  "contact_info": {
    "email": "jsmith@example.com",
    "phone": "<string>",
    "address": {
      "address1": "123 Main Street",
      "address2": null,
      "city": "Salt Lake City",
      "state": "UT",
      "zip": "84101"
    }
  },
  "status": "active"
}
'
{
  "data": {
    "id": "01K6AB05EJ3T10HRYE78AN7BCD",
    "name": "John Jonas Johnson",
    "relationship": "son",
    "percentage_share": 50,
    "designation_type": "pod",
    "is_contingent": false,
    "contact_info": {
      "email": "jsmith@example.com",
      "phone": "<string>",
      "address": {
        "address1": "123 Main Street",
        "address2": null,
        "city": "Salt Lake City",
        "state": "UT",
        "zip": "84101"
      }
    },
    "status": "active",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

case_id
string
required

Unique case identifier (ULID format).

account_id
string
required
beneficiary_id
string
required

Body

application/json
name
string
required
designation_type
enum<string>
required
Available options:
pod,
tod
relationship
string
percentage_share
number<double>
is_contingent
boolean
contact_info
object
status
enum<string>
Available options:
active,
claimed,
pending_verification

Response

Beneficiary updated.

data
object