Entitlements

"Entitlements" refer to the list of clients that each advisor or support user has access to. advisor and support users need entitlement records; only admin users have access to all clients and do not require entitlement records.

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

The Entitlements file is a full load: send the complete set of entitlements every time. Wealth.com compares the file to the previous day's, and an entitlement that no longer appears is revoked. Do not send it incrementally — absence is how removal is expressed.

SFTP

Entitlements File Specification

JSONL File Schema

  • Name
    user_id
    Type
    string (Max 255)
    Description

    The id for the advisor or support user (from the Users file).

  • Name
    client_id
    Type
    string (Max 255)
    Description

    The id for the client that the user is entitled to see.

Example JSONL File

entitlements.jsonl

{"user_id": "ebe43b23-10a0-4586-a97b-05bc7ce749c5", "client_id": "123e4567-e89b-12d3-a456-426614174000"}
{"user_id": "ebe43b23-10a0-4586-a97b-05bc7ce749c5", "client_id": "987e6543-e21b-45c6-b789-123456789abc"}