Top Accounts

A "top account" is a family in the largest sense; within a top account, you will be able to create one or more client groups, which would represent separate households or reporting groups within that top account (family).

The SFTP interface allows connected systems to programmatically add or update top account information in bulk. Deleting top accounts via SFTP is currently not supported (given the irreversible nature of that operation). Adding or updating top accounts is performed by uploading a JSONL (JSON Lines) file, where each line represents a top account object.

SFTP

Top Accounts File Specification

JSONL File Schema

  • Name
    id
    Type
    string (Max 255)
    Description

    Your firm's unique identifier for the top account. This field is required.

  • Name
    name
    Type
    string (Max 255)
    Description

    The name of the top account. This field is required.

Example JSONL File

top-accounts.jsonl

{"id": "123e4567-e89b-12d3-a456-426614174000", "name": "Doe Family"}
{"id": "987e6543-e21b-45c6-b789-123456789abc", "name": "Smith Family"}