Skip to content

Managing partners

A partner is the outside party — an affiliate, an introducing broker, or an external CRM — that you let create end-client accounts and read data through the Partner API for one of your brands. This page is for operators: how to create a partner, scope it, restrict it, and revoke it in the Backoffice.

Everything here is an operator task. The partner never signs in to the Backoffice; they receive a username and password and call the API with them.

Prerequisites

  • You are signed in with a role that lets you manage the firm whose brand you are configuring (write access to the workspace).
  • The brand the partner is for already exists. Partners are per-brand.

Open the Partners page

In the Backoffice, open the Partners page. First select a brand — partners belong to a single brand, and everything you create and configure applies to the brand you pick.

Create a partner

  1. Enter a username and a display label that describes who the partner is for, for example the affiliate's name.
  2. Set a password. It is shown once, at creation, with a copy-to-clipboard control.
  3. Copy the password now and deliver it to the partner over a secure channel. It is shown a single time and can never be retrieved again — if it is lost, reset it here and give the partner the new one.

The partner exchanges this username and password for a bearer token at POST /token; see Authentication.

Configure the partner

A freshly created partner is least privilege: it can do almost nothing until you grant scopes. Each of the settings below is saved on its own, so change one row and save it independently of the others.

Lead owner

Set the default owner for accounts the partner creates — one CRM user or one business unit. New leads from this partner are assigned to that owner. Leave it clear to use the brand's normal lead routing. See Configure lead assignment for how ownership and routing work.

Scope

Decide what the partner may do:

  • Account visibility — Own (only the accounts this partner created) or All (all accounts under the brand).
  • Transactions — None, Ftd, All, or CustomFtd. This controls whether the partner can read monetary transactions and which fields it sees.
  • Positions — on or off, controlling access to the positions endpoint.
  • Creation scopes — the account-creation methods the partner may call, chosen as checkboxes: CreateLead, CreateReal, and RegistrationWithSSO. A partner needs the matching creation scope — for example CreateLead — before it can create accounts.

Grant only what the partner needs. A read-only affiliate might get Own visibility, Ftd transactions, and no creation scopes; an external CRM that registers clients needs the relevant creation scope.

IP allow-list

Restrict the partner to known addresses. Add one row per IP address or CIDR range (IPv4 or IPv6); each entry is validated as you add it. An empty list means no restriction — the partner works from anywhere — so add at least one entry when the partner calls from fixed infrastructure. See Authentication for how the restriction is enforced.

Revoke a partner

Revoking is a soft revoke. The row and its label stay on the page, badged Revoked, so you keep an audit trail of what existed. A revoked partner immediately fails authentication — every call it makes returns 401. Revoking is idempotent, so revoking an already-revoked partner is safe. To restore access, create a new partner.