Client Groups

A top account, which represents a family in the largest sense, may contain one or more client groups, which would represent separate households or reporting groups within that top account.

The SFTP interface allows connected systems to programmatically add or update client group information in bulk. Deleting client groups via SFTP is currently not supported (given the irreversible nature of that operation). However, removing people, trusts, entities, and assets from a client group is supported. Adding or updating client groups is performed by uploading a JSONL (JSON Lines) file, where each line represents a client group object.

SFTP

Client Groups File Specification

JSONL File Schema

Name
id
Type
string (Max 255)
Description
Your firm's unique identifier for the client group.
Name
top_account_id
Type
string (Max 255)
Description
The unique identifier of the top account associated with the client group.
Name
name
Type
string (Max 255)
Description
The name of the client group.
Name
primary_client
Type
string (Max 255)
Description
The unique identifier of the person (as in the People/Trusts/Entities file) that is considered the main client for this client group.
Name
secondary_client
Type
string (Max 255), optional
Description
The unique identifier of the person (as in the People/Trusts/Entities file) that is considered the second main client for this client group. If primary_client is married, for example, this is their spouse.
Name
people_trust_entities
Type
array of strings (Max 255 per string), optional
Description
A list of unique identifiers for people, trusts, and entities (from the People/Trusts/Entities file) that belong to this client group. A person, trust, or entity may belong to multiple client groups.
Name
assets
Type
array of strings (Max 255 per string), optional
Description
A list of unique identifiers for assets (from the Assets file) that belong to this client group. An asset may belong to multiple client groups.

Example JSONL File

client-groups.jsonl

{
  "id": "1a098c90-8f7c-4000-b12c-9299bc1ade0e",
  "top_account_id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "John and Jane Doe",
  "primary_client": "ca7e299a-5404-4d10-82f4-584ebb1bee54",
  "secondary_client": "4c59a99e-49e9-4364-afa6-22d62d9af3a7",
  "people_trust_entities": ["ca7e299a-5404-4d10-82f4-584ebb1bee54", "4c59a99e-49e9-4364-afa6-22d62d9af3a7", "893703bf-041b-45e2-8f41-9ff8d705a6bd", "c6f68d35-61d3-4e92-b206-18391ba61cdb"],
  "assets": ["fa038f59-29e7-48a7-bee8-f93f4e4158e1", "a4a274db-7faa-4d09-b4b1-30fd83981021"]
}
{
  "id": "fbfece57-6215-449e-9f7a-7b49a70e9a4b",
  "top_account_id": "987e6543-e21b-45c6-b789-123456789abc",
  "name": "John Smith",
  "primary_client": "1694a501-5aad-48d0-8888-75801e16b1e2",
  "people_trust_entities": ["1694a501-5aad-48d0-8888-75801e16b1e2", "9351bd69-4348-4415-8b3b-f3482e92d723", "c3eafedf-35dc-470c-96ee-b360b34c942c"]
}
{
  "id": "8c343b96-817b-4eb3-aaa3-9776b6dd8c5d",
  "top_account_id": "987e6543-e21b-45c6-b789-123456789abc",
  "name": "Rebecca and James Smith",
  "primary_client": "56f0fdc7-c0d5-408d-a42d-17e52de2682f",
  "secondary_client": "4d89cf09-d77c-4d44-b682-f7fc4522099f",
  "people_trust_entities": ["56f0fdc7-c0d5-408d-a42d-17e52de2682f", "4d89cf09-d77c-4d44-b682-f7fc4522099f"]
}