Skip to main content

Overview

Subject to bank approval, a customer can designate beneficiaries of their account. This is commonly known as a payable-on-death (POD) designation: on the account holder’s death, the balance passes to the named beneficiaries in the allocated proportions. In the Synctera platform a beneficiary is modeled as:
  • A person holding the beneficiary’s identification (name, date of birth, SSN, contact information). Beneficiaries are not customers of the bank, so they are stored as PROSPECTs and are not run through KYC.
  • An account relationship of type BENEFICIARY linking that person to the account and carrying the ownership_percentage the beneficiary is entitled to.
Key characteristics:
  • Reuses the existing Persons and account Relationships APIs; no special endpoint.
  • Each BENEFICIARY relationship carries an ownership_percentage. An account can have multiple beneficiaries whose percentages represent the share of funds each is entitled to receive.

Prerequisites

This guide assumes you are familiar with: It also assumes you have already created a personal or business customer and opened an account for them. The curl examples authenticate with an apikey environment variable. Some examples depend on identifiers generated by previous steps; these are shown as placeholders like {ACCOUNT_ID}.

The account relationship object

A BENEFICIARY designation is an account relationship with the following key fields:
See the API reference for the full request and response schemas.

Adding a beneficiary

1

Create the beneficiary as a person

Collect at a minimum the beneficiary’s name and contact information, and create a person with POST /v2/persons.
The response includes the system-generated id, used to link the beneficiary to the account:
Beneficiaries are prospects, not customers. They do not need to pass KYC, so there is no verification step.
2

Link the beneficiary to the account

Create an account relationship of type BENEFICIARY with POST /v2/accounts/{ACCOUNT_ID}/relationships. Provide the beneficiary’s person ID in customer_id, and use ownership_percentage to record the share of funds they are entitled to.
The response returns the created relationship:
Repeat both steps for each additional beneficiary. For example, a second beneficiary with "ownership_percentage": 50 splits the account evenly between the two.

Managing beneficiaries

List beneficiaries on an account

Use GET /v2/accounts/{ACCOUNT_ID}/relationships to retrieve all relationships for an account, then filter for a relationship_type of BENEFICIARY:

Edit a beneficiary’s details

Beneficiary identification lives on the person resource. Patch it with PATCH /v2/persons/{PERSON_ID}:

Change a beneficiary’s percentage

Update the ownership_percentage on the account relationship with PUT /v2/accounts/{ACCOUNT_ID}/relationships/{RELATIONSHIP_ID}:

Remove a beneficiary

Delete the account relationship with DELETE /v2/accounts/{ACCOUNT_ID}/relationships/{RELATIONSHIP_ID}. This removes the POD designation; the person resource is unaffected.

Best practices

Beneficiary designations are subject to bank approval. Confirm your program supports POD designations before exposing the flow to customers.
  • Collect full identification — capture name, date of birth, SSN, and contact information so the beneficiary can be identified when funds are disbursed.
  • Keep allocations consistent — track each beneficiary’s ownership_percentage so totals reflect your program’s rules for splitting funds.
  • Reuse people where possible — if a beneficiary already exists as a person, link the existing id instead of creating a duplicate.
  • Treat PII carefully — expect vaulted fields like ssn to be returned masked, and never log full values.

Create a Personal Customer

Create the person resource used to represent a beneficiary.

Create Accounts

Open the account that beneficiaries are designated on.

API reference