FAQs

What’s the difference between clients and client profiles?

A client is meant to be an entity that an advisor can create, pull in from a CRM and manage separately from being a user. This resource is available at the /v2/org/clients endpoint.

A client profile is a user on the system that's able to login to the client portal and available at the /v2/user-management/client-profiles endpoint.

In the future when an advisor integrates with their CRM, Clients will be generated, which can then be converted to users upon adoption of the client portal.

How can Balance history for more than 1 month be obtained for Account and Household Balance history?

There's nothing on our API limiting you to just one month of data for accounts. Households have a 1 month time window as required by the start / end date because the data is aggregated on the fly. You cannot fetch more than one month at a time; if you need a full year of data you need to make 12 requests, for example.

For account-level data there are no limits on start, end dates or time range, although you can optionally filter on dates with the /filter endpoint. By default you'll receive 10,000 objects per page and can paginate through the results to unravel the full time series.

Does the Atlas frontend application have any significant business logic or calculations?

No. It's a thin client- meaning it's largely driven by the API. The logic frontend application is largely doing data shaping and association, rendering, formatting, and API interaction.

There are no calculations around reporting, billing, etc. happening on the frontend. To obtain performance, reporting, invoices or fee calculations you should invoke endpoints to invoke reporting and billing jobs.

How does one get a household (or list of accounts) for a client (end customer)?

Today most advisors use households to represent a client or client relationship. However households will be deprecated and replaced with Clients and Reporting Groups by the end of 2022.

You can obtain households from the /v2/reporting/households

Each end client user has a household ID, which can be obtained either from the currently authenticated user or the /v2/user-management/client-profiles endpoint.

Once you have a household ID you can filter on the corresponding accounts using /v2/account-management/accounts/filter

Alternatively listing our all accounts gives you a household ID, which you can use to group client relationships by: /v2/account-management/accounts

How do I obtain information about the currently authenticated user?

We recommend using JWT tokens as the Bearer token, which can be decoded for standard and claims specific to Atlas, which are prefixed with bft:

jwt.io) lists common libraries in several programming languages to decode the claims in a JWT token.

API keys are associated with a specific user, but are meant to be firm-centric and tied to the firm owner. API keys are only recommended for backend machine-to-machine communication that benefit from authentication without expiration.

How do I list all the accounts associated with my authenticated user?

The authenticated user is either going to be a firm user (e.g., an advisor) or an end-client user. If it's a firm user the accounts available under /v2/account-management/accounts are all those you're permissioned to view. For firm owners this is the list of all accounts within the firm; firm owners cannot be denied access to any accounts (to prevent accidental lockout).

For an end-client the accounts available at/v2/account-management/accounts will only return the list of accounts associated with your household ID.

How do I see performance data for a particular account or household?

For example:

  • YTD Returns
  • MTD Returns
  • Gain/Loss, etc

There are multiple ways to see performance data for a particular account/household. 

  1. Run a Web Report
  2. Run a Printable Report Job
  3. Use the /v2/analytics/account-performance or /v2/analytics/household-performance endpoints.

Running a Web Report

Make a POST request to /v2/reporting/web-reports with the following payload:

{
  "start": "2022-01-01",
  "end": "2022-12-31",
  "account_id": SOME_ACCOUNT_ID,
}

The API will calculate a report for the provided entity and return a JSON report payload. An example can be seen here: https://s3.amazonaws.com/support-content.bridgeft.com/reporting/example-report.json 

Running a Printable Report

Running a printable report will yield the same results as a web report, but is an a synchronous job that runs in the background. 

Make a POST request to /v2/reporting/printable-reports with the following payload:

{
  "account_ids": [
    217036
  ],
  "start_date": "2022-01-01",
  "end_date": "2022-12-31"
}

A background job record will be returned:

{
  "created_at_utc": "2022-07-22T19:48:22.018117Z",
  "created_by_user_id": 265,
  "current_step": 0,
  "email_notification": false,
  "email_notification_dt_utc": null,
  "failed_dt_utc": null,
  "finished_dt_utc": null,
  "firm_id": 39,
  "id": 544995,
  "is_failed": false,
  "is_finished": false,
  "is_queued": true,
  "is_revoked": false,
  "is_running": false,
  "job_type": "pdfrp",
  "num_steps": null,
  "queued_dt_utc": "2022-07-22T19:48:22Z",
  "revoked_dt_utc": null,
  "started_dt_utc": null,
  "updated_at_utc": "2022-07-22T19:48:22.055631Z"
}

You can then use the /v2/jobs/{job_id} endpoint to track the status of the job. 

Alternatively, if you are connected to the API's websocket at https://websocket.bridgeft.com/?queryauth={YOUR_ID_TOKEN} you will receive a message that the report has completed along with a url to download the printable report.

Performance Endpoints

Documentation for the performance endpoints can be found here: 

https://docs.bridgeft.com/reference/gethouseholdperformance

I'm not seeing household or account balances for historical data

Make sure you're querying the proper endpoint. Historical balances are populated at the time of onboarding and represent data that created outside of Atlas. Those endpoints are:

/v2/data/luca/account-historical-balances for accounts
/v2/data/luca/household-historical-balances for households

However live balances that are generated by Atlas are available at these endpoints:

/v2/data/luca/account-balances for accounts
/v2/data/luca/household-balances for households

This is admittedly confusing and we're working to collapse these two balances endpoints to a single endpoint with indicators as to whether the balance is "live" (created by Atlas) or "historical" (ingested from a different system at the time of onboarding an advisor).

Where do I find the current Asset Classification for an account?

Asset classifications are applied to securities and holdings, not accounts.

A user first defines Class Tags, which are available at /v2/reporting/class-tags

A tag could be named, "International Equities", for example.

Those tags are associated with securities through the asset classifications endpoint: /v2/reporting/asset-classifications

Certain reports, such as the appraisals report, then consume these classifications when grouping performance data together.