Advisor SFTP

We provide an SFTP interface to simplify and secure the transfer of your top accounts; client groups; users, including both advisors and clients; entitlements, i.e., which top accounts an advisor or client can access; important people, trusts, and entities; and assets. That is, this SFTP interface supports all of the following methods:

  • Add/Update/Delete Users
  • Add/Update Top Accounts
  • Add/Update/Delete Entitlements
  • Add/Update People/Trusts/Entities
  • Add/Update Assets
  • Add/Update Client Groups

File Transfer Process

1. Uploading Files

All files must be uploaded to the /incoming directory within our SFTP server. Wealth.com will coordinate with your team in terms of when to expect and process the files; this way we can also alert you in case the files, for example, do not arrive.

2. Full Load (vs. Incremental Load)

All files should be full loads, not incremental loads. Wealth.com will take care of determining when to create, update, or delete based on comparison to the previous day's files.

3. File Naming Convention

All files must be named according to the following convention, where operation is one of users, top-accounts, entitlements, people-trusts-entities, assets, or client-groups; date is provided in YYYYMMDD format; and unique_id is any unique identifier for the specific file that you choose to provide. The unique_id exists to help troubleshoot in case we receive multiple files of a given type on a particular day.

Naming Convention

[operation]-[date]-[unique_id].jsonl

Examples:

  • users-20241220-001.jsonl
  • top-accounts-20241220-001.jsonl

4. File Processing

We will not process any of the files for a given day if:

  • At least one of the files is missing. That is, all files must be provided for a given date in order for any of them to be processed. A blank file should be sent in case there is no data of a particular type to be sent.
  • At least one of the files is unable to be parsed (e.g., it was encrypted, but we are unable to successfully decrypt it).

Once our system has determined that it is able to process the files (i.e., all present, all parseable), then it will process all valid rows. Any invalid rows (e.g., invalid schema, unknown ID referenced) will be skipped.

Processing Sequence

To ensure proper processing, files are always processed in the following order:

  1. /users
  2. /top-accounts
  3. /entitlements
  4. /people-trusts-entities
  5. /assets
  6. /client-groups

Processing Outcome

We will send an email alert if any issues are encountered. This alert will indicate if for any reason the files are unable to be processed; or, if processed, if any invalid rows were found and therefore not processed.

Optional: PGP Encryption for File Transfers

To enhance data security, we offer the option to use PGP encryption for file transfers. This ensures that file contents remain encrypted and accessible only by authorized parties during processing.

How It Works

1. Customer Provides a PGP Public Key:

  • If you already have a PGP key pair, you can share your PGP public key with us. We will use this key to securely decrypt the files you encrypt with your private key before uploading them to our SFTP server.

2. We Provide a PGP Public Key:

  • If you do not have a PGP key pair, we can generate and provide you with a unique PGP public key specific to your account. You will use this public key to encrypt your files before uploading them to our SFTP server.

Steps for Using PGP Encryption

1. If You Provide a PGP Public Key:

  • Share your PGP public key with our support team via a secure method (e.g., encrypted email or secure upload).
  • Ensure your key meets the following requirements:
    • Key Type: RSA or ECC
    • Key Length: 2048-bit or higher recommended
    • Expiration: Set an appropriate expiration date for enhanced security.
  • Once we confirm receipt, encrypt your files using your private key before uploading them to the SFTP server.

2. If We Provide a PGP Public Key:

  • Request a PGP public key from our team.
  • Use the provided public key to encrypt your files.
  • Ensure the encryption process produces a .gpg or .pgp file extension.

3. File Naming for Encrypted Files:

Encrypted files should include .pgp in the file name to indicate their format.

Example: users-20241220-001.jsonl.pgp

File Processing with PGP Encryption

  • Encrypted files will be decrypted automatically upon receipt using the corresponding private key stored securely on our servers.
  • Decryption is logged, and the original files remain encrypted during transit and until processing.

PGP Key Management

  • We securely store and manage PGP keys, limiting access to authorized personnel.
  • Key rotation is supported and recommended periodically for enhanced security.