Propose an account debit restriction or its release after reviewing a confirmed death

POST/accounts/{id}/death-controls

Staff evidence only. Writes require accounts:servicing:write and MFA within five minutes; decisions additionally require operations:approve and an independent reviewer.

Path parameters

idstringRequired

Headers

Idempotency-KeystringRequired

Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.

Body parameters

actionstringRequired

customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

evidence_refstringRequired

policy_refstringRequired

reasonstringRequired

report_idstringRequired

Example strp_2tVh8nqLxq4GbDe0K1F6S9zRcWm

restriction_idstringOptional

revisionintegerRequired

Returns

200 OK

account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

decisionobject or nullOptional

5 child attributes

approvebooleanRequired

decided_atstring · date-timeRequired

decided_bystringRequired

evidence_refstringRequired

reasonstringRequired

idstringRequired

Example dctl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

ownersarray of stringsRequired

ownershipobjectRequired

Ownership is how an account is titled, apart from who its owners are: the form of ownership decides who can act on it, who takes it at death, how it is insured and how its interest is reported. The owners themselves are customer ids on the account.

11 child attributes

beneficiariesarray of objectsOptional

Pod (payable on death / in trust for), custodial (for the benefit of), utma (the minor)

5 child attributes

customer_idstringOptional

The customer record carrying the beneficiary's TIN; required where the interest is reported to the beneficiary (utma, custodial)

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

date_of_birthstringOptional

namestringRequired

relationshipstringOptional

share_bpsintegerRequired

Pod: the beneficiaries' shares sum to 10,000

custodianstringOptional

Utma, custodial: the custodian's customer id (an owner)

decedentstringOptional

Estate, inherited ira: confirmed deceased customer ID

fiduciarystringOptional

Estate: separately verified executor/administrator customer ID, not an ownership grant

firmstringOptional

Iolta: the law firm as titled

ira_typestringOptional

Ira: traditional, roth, sep, simple

survivorshipbooleanOptional

Joint: with right of survivorship

tax_reportingstringOptional

Derived: how the interest is reported

trust_namestringOptional

Trust: the trust's name as titled

trusteesarray of stringsOptional

Trust: customer ids among the owners acting as trustees

typestringRequired

Individual, joint, pod, trust, estate, utma, iolta, hsa, ira, custodial

proposed_atstring · date-timeRequired

proposed_bystringRequired

requestobjectRequired

8 child attributes

actionstringRequired

customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

evidence_refstringRequired

policy_refstringRequired

reasonstringRequired

report_idstringRequired

Example strp_2tVh8nqLxq4GbDe0K1F6S9zRcWm

restriction_idstringOptional

revisionintegerRequired

statusstringRequired

Errors

Every error is a problem document with a stable code. See Errors.

400401403404409412413422424429500503