Sign in

v1

latestOpenAPI 3.0.12026-07-268028223.9 KB
Trusts

Create a trust

Create a new trust for a household

post/v1/households/{household_id}/trusts

Headers

Idempotency-Keystring

Unique key to ensure idempotent request handling. If a request with the same key was already processed, the original response will be returned.

Request body

namestring required

Trust name

tax_idstring

Tax ID

additional_infostring

Additional information

Example request

{
  "name": "Smith Family Trust",
  "tax_id": "12-3456789",
  "additional_info": "Revocable living trust"
}

Response

trust created

idstring required

The trust ID

book_idstring required

The book ID

household_idstring required

The household ID

namestring required

Trust name

tax_idstring nullable

Tax ID

additional_infostring nullable

Additional information

created_atstring date-time required

When the trust was created

updated_atstring date-time required

When the trust was last updated

Example response

{
  "id": "abc123xyz",
  "book_id": "book123xyz",
  "household_id": "household123xyz",
  "name": "Smith Family Trust",
  "tax_id": "12-3456789"
}