Skip to main content

Guides for your firm. An API reference for your scripts.

Create your firm and manage your clients

Sign Up

Follow these guides in the order shown.

  1. Sign Up a New FirmEnter your details, your firm's details and your custodian master accounts to create your firm and your user account.
  2. Connect Custodian Data FeedsFollow the instructions for your custodian. This process takes approximately 5–10 business days.
  3. Invite UsersEnter a person's email address on the Firm settings page to invite that person to your firm.

Clients & Accounts

HouseholdsSee what a household contains, and connect your households to the records in your CRM.AccountsAssign your clients' investment accounts to their households on the Household Assignments page.

Call the AdviceCloud API from your scripts

Use the AdviceCloud API to read and change your firm's investment settings: risk levels, the allocations of asset classes and security categories, security asset-category overrides, and minimum trade sizes.

Read this first

The sections of the API reference

Get an access token, then call the API

  1. Get an access tokenYour script asks for a code, a person approves the code in a browser, and your script receives tokens.
    # 1. Start. Show verification_uri_complete, or verification_uri and user_code, to the person.
    curl -s -X POST "https://$ISSUER_HOST/oauth/device/code" \
      -d client_id="$CLIENT_ID" -d audience="$SCRIPT_AUDIENCE" \
      -d scope="offline_access read:firm"

    # 2. Poll every `interval` seconds until the person approves.
    #    Save refresh_token before you use access_token.
    curl -s -X POST "https://$ISSUER_HOST/oauth/token" \
      -d grant_type="urn:ietf:params:oauth:grant-type:device_code" \
      -d device_code="$DEVICE_CODE" -d client_id="$CLIENT_ID"
    Authentication
  2. Call the APICall the API with the access token as a bearer token in the Authorization header.
    curl -s "$API_ROOT/v1/firm/risk" -H "Authorization: Bearer $ACCESS_TOKEN"
    List risk levels

$API_ROOT is the base URL, https://app.advicecloudft.com/api. The Authentication section explains the other values.