People/Trusts/Entities
In the Wealth.com application, there are cards representing people (individuals), trusts, and other entities (e.g., LLCs).
The SFTP interface allows connected systems to programmatically add or update people, trust, and entity cards in bulk. Deleting people, trust, and entity cards via SFTP is currently not supported (given the irreversible nature of that operation). Adding or updating these cards is performed by uploading a JSONL (JSON Lines) file, where each line represents a person, trust, or entity object.
People/Trusts/Entities File Specification
The schema for people, trust, and entity cards are different. See below for the respective schemas. These should all appear in a single file. The field type
in each row will indicate what type of card it is, and therefore how it should be processed.
JSONL File Schema for People
- Name
id
- Type
- string (Max 255)
- Description
Your firm's unique identifier for the person. This field is required.
- Name
top_account_id
- Type
- string (Max 255)
- Description
The
id
of the top account associated with the person. This should correspond to an already existing top account, or to theid
of a top account within the Add/Update Top Accounts file. This field is required.
- Name
type
- Type
- string (constant)
- Description
This field must always be
"Individual"
for people.
- Name
first_name
- Type
- string (Max 255)
- Description
The first name of the person. This field is required.
- Name
middle_name
- Type
- string (Max 255), optional
- Description
The middle name of the person. This field is optional.
- Name
last_name
- Type
- string (Max 255)
- Description
The last name of the person. This field is required.
Example JSONL Rows for People
people-trusts-entities.jsonl
{
"id": "ca7e299a-5404-4d10-82f4-584ebb1bee54",
"top_account_id": "123e4567-e89b-12d3-a456-426614174000",
"type": "Individual",
"first_name": "John",
"middle_name": "Michael",
"last_name": "Doe"
}
{
"id": "4c59a99e-49e9-4364-afa6-22d62d9af3a7",
"top_account_id": "123e4567-e89b-12d3-a456-426614174000",
"type": "Individual",
"first_name": "Jane",
"last_name": "Doe"
}
{
"id": "1694a501-5aad-48d0-8888-75801e16b1e2",
"top_account_id": "987e6543-e21b-45c6-b789-123456789abc",
"type": "Individual",
"first_name": "John",
"middle_name": "A.",
"last_name": "Smith"
}
JSONL File Schema for Trusts
- Name
id
- Type
- string (Max 255)
- Description
Your firm's unique identifier for the trust. This field is required.
- Name
top_account_id
- Type
- string (Max 255)
- Description
The
id
of the top account associated with the trust. This should correspond to an already existing top account, or to theid
of a top account within the Add/Update Top Accounts file. This field is required.
- Name
type
- Type
- string (constant)
- Description
This field must always be
"Trust"
for trusts.
- Name
legal_name
- Type
- string (Max 500)
- Description
The legal name of the trust. This field is required.
- Name
trust_type
- Type
- enum (IndividualRevocableTrust | JointRevocableTrust | IrrevocableLifeInsuranceTrust | GrantorRetainedAnnuityTrust | CharitableRemainderUnitTrust | CharitableRemainderAnnuityTrust | SpousalLifetimeAccessTrust | DynastyTrust | QualifiedPersonalResidenceTrust | OtherIrrevocableTrust)
- Description
The type of trust. This field is required.
- Name
trust_creator
- Type
- array of strings (Max 255 per string), optional
- Description
The
id
s of the trust creators. This field is optional.
- Name
initial_trustee
- Type
- array of strings (Max 255 per string), optional
- Description
The
id
s of the initial trustees. This field is optional.
- Name
governing_state
- Type
- enum (two-letter US state abbreviation), optional
- Description
The two-letter US state abbreviation for the governing state of the trust. For example,
"AZ"
for Arizona. This field is optional.
- Name
creation_date
- Type
- date (YYYY-MM-DD), optional
- Description
The creation date (YYYY-MM-DD) of the trust. This field is optional.
Example JSONL Rows for Trusts
people-trusts-entities.jsonl
{
"id": "893703bf-041b-45e2-8f41-9ff8d705a6bd",
"top_account_id": "123e4567-e89b-12d3-a456-426614174000",
"type": "Trust",
"legal_name": "The Doe Family Trust",
"trust_type": "JointRevocableTrust",
"trust_creator": ["ca7e299a-5404-4d10-82f4-584ebb1bee54", "4c59a99e-49e9-4364-afa6-22d62d9af3a7"],
"initial_trustee": ["ca7e299a-5404-4d10-82f4-584ebb1bee54", "4c59a99e-49e9-4364-afa6-22d62d9af3a7"],
"governing_state": "OR",
"creation_date": "2020-01-02"
}
{
"id": "9351bd69-4348-4415-8b3b-f3482e92d723",
"top_account_id": "987e6543-e21b-45c6-b789-123456789abc",
"type": "Trust",
"legal_name": "The John A. Smith Trust",
"trust_type": "IndividualRevocableTrust",
"trust_creator": ["1694a501-5aad-48d0-8888-75801e16b1e2"]
}
JSONL File Schema for Entities
- Name
id
- Type
- string (Max 255)
- Description
Your firm's unique identifier for the entity. This field is required.
- Name
top_account_id
- Type
- string (Max 255)
- Description
The
id
of the top account associated with the entity. This should correspond to an already existing top account, or to theid
of a top account within the Add/Update Top Accounts file. This field is required.
- Name
type
- Type
- string (constant)
- Description
This field must always be
"Entity"
for entities.
- Name
legal_name
- Type
- string (Max 255)
- Description
The legal name of the entity. This field is required.
- Name
incorporation_state
- Type
- enum (two-letter US state abbreviation), optional
- Description
The two-letter US state abbreviation for the state of incorporation. For example,
"CA"
for California. This field is optional.
- Name
incorporation_form
- Type
- enum (CCorporation | SCorporation | DonorAdvisorFund | LimitedLiabilityCompany | PrivateFoundation | SoleProprietorship | Other), optional
- Description
The form of incorporation of the entity. This field is optional.
- Name
ownership
- Type
- array of JSON, optional
- Description
An array of ownership details for the entity. If ownership is provided, then each ownership entry must include:
- type: enum (Individual | Joint | Trust | Entity) - The type of ownership.
"Individual"
is used for a single person."Joint"
indicates when one or more people own the entity jointly with rights of survivorship (JWROS)."Trust"
and"Entity"
indicate that a trust or entity owns the entity, respectively. This field is required. - percentage: float - The percentage of ownership (between 0 and 100). This field is required.
- owner_id: array of strings (Max 255 per string) - The
id
of the owner(s). If"Individual"
ownership was indicated as the ownershiptype
, then this should be theid
of that person. If"Trust
" or"Entity"
was indicated as ownershiptype
, then this should be theid
of that trust or entity, respectively. If"Joint"
was indicated as the ownershiptype
, then this should be the list ofid
s of the persons who own the asset jointly. This field is required.
- type: enum (Individual | Joint | Trust | Entity) - The type of ownership.
Example JSONL Rows for Entities
people-trusts-entities.jsonl
{
"id": "c6f68d35-61d3-4e92-b206-18391ba61cdb",
"top_account_id": "123e4567-e89b-12d3-a456-426614174000",
"type": "Entity",
"legal_name": "Doe Family Corporation",
"incorporation_form": "CCorporation"
}
{
"id": "c3eafedf-35dc-470c-96ee-b360b34c942c",
"top_account_id": "987e6543-e21b-45c6-b789-123456789abc",
"type": "Entity",
"legal_name": "Smith LLC",
"incorporation_state": "TX",
"incorporation_form": "LimitedLiabilityCompany",
"ownership": [
{
"type": "Trust",
"percentage": 100.0,
"owner_id": ["9351bd69-4348-4415-8b3b-f3482e92d723"]
}
]
}