Users

A "user" is a member of your firm's staff — an advisor, admin, or support user — with the ability to log in to Wealth.com's application.

This file is only for firm staff. Clients are not listed here — they are provisioned through the Clients file, where setting send_invitation_email invites the client so they can create their login.

The SFTP interface allows connected systems to programmatically add, update, or delete users in bulk. This operation is performed by uploading a JSONL (JSON Lines) file, where each line represents a user object.

The Users file is a full load: send the complete set of staff users every time. Wealth.com compares the file to the previous day's and revokes access for any user that no longer appears. Do not send it incrementally — absence is how removal is expressed.

Note: Wealth.com does not immediately delete the users that are removed from the Users feed (as compared to the previous day's feed). Instead we revoke access for that user and later delete the data in accordance with our data retention policy.

SFTP

Users File Specification

JSONL File Schema

  • Name
    id
    Type
    string (Max 255)
    Description

    Your firm's unique identifier for the user.

  • Name
    first_name
    Type
    string (Max 255)
    Description

    The first name of the user.

  • Name
    last_name
    Type
    string (Max 255)
    Description

    The last name of the user.

  • Name
    email
    Type
    string (Max 500)
    Description

    The email address of the user.

  • Name
    role_type
    Type
    string (Max 255)
    Description

    The role of the user. Use one of the recognized values below, or a custom value of your own (in which case role_description is required).

    Recognized values:

    • advisor: advisor who has full access to the clients specified in the entitlement file
    • admin: advisor who has full access to all clients (no explicit entitlement records required for this user)
    • support: advisor who has read-only access to the clients specified in the entitlement file
  • Name
    role_description
    Type
    string (Max 255), optional
    Description

    A description of the user's role. This field is optional unless the role_type provided is custom (i.e., not one of the recognized values above).

Example JSONL File

users.jsonl

{"id": "ebe43b23-10a0-4586-a97b-05bc7ce749c5", "first_name": "Sarah", "last_name": "Advisor", "email": "sarah.advisor@example.com", "role_type": "advisor"}
{"id": "73be3d43-8e63-4082-a0ef-b857e79daecc", "first_name": "Alice", "last_name": "Boss", "email": "alice.boss@example.com", "role_type": "admin"}