Users

A "user" is someone with the ability to log in to Wealth.com's application.

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.

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. This field is required.

  • Name
    first_name
    Type
    string (Max 255)
    Description

    The first name of the user. This field is required.

  • Name
    last_name
    Type
    string (Max 255)
    Description

    The last name of the user. This field is required.

  • Name
    email
    Type
    string (Max 500)
    Description

    The email address of the user. This field is required.

  • Name
    role_type
    Type
    string (Max 255) or enum (client | advisor | admin | support)
    Description

    The role type of the user. This field is required.

  • 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.

Example JSONL File

users.jsonl

{"id": "0f3cb7d4-f5f9-44ce-9694-affd4f10e61d", "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com", "role_type": "client"}
{"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"}