Skip to main content
This is one of two ways to integrate the Investments API. If you hold your own regulatory permissions and want to run your own ledger, use the Direct model instead.

Who this is for

You are not a regulated entity, so you cannot hold client assets on your own book. Instead you act as an intermediary: your app is the interface, and GetEquity holds the account and the assets for each of your users. Every user you onboard becomes a member of your organisation’s syndicate — a real GetEquity account with its own credentials, wallet, balances, orders and transaction history. You act on their behalf through the api/members/{id}/* routes using your organisation’s secret key.

How your end users are represented

You provision a member with Create Member. Unlike a Direct-model customer, this creates an account:
POST api/member
The response returns the member’s id — which every subsequent call is scoped to — along with their KYC and verification state. Because a member is a full account, GetEquity is the ledger of record for their holdings, and their funds sit in their own wallet rather than a pooled organisation wallet.
Members are created with credentials, so the same account can be reached both through your integration and directly on GetEquity. Retrieve an existing one with Get Member by Email rather than creating a duplicate.

The flow

1

Create the member

Create Member returns the id used by every later call. Listen for the member.created webhook to confirm provisioning.
2

Find something to trade

Token discovery is shared with the Direct model — use Get All Tokens, Get Raising Tokens or Search Token.
3

Fund and buy on their behalf

Funding and investing are one step. Fund Invest raises the payment and places the buy in a single flow once it clears, so you never have to top up a wallet and then trade from it; quote it first with Fund Invest Quote. For secondary trades against an existing balance, use Buy Token and Sell Token. To credit a member for value settled off-platform, use POST api/manual-credits. Either way the balance is the member’s, not yours.
4

Report back to them

Member Token Balance, Member Currency Balance, Member Orders and Member Transactions give you everything you need to render their portfolio.
5

Pay them out

Withdraw from Member Wallet debits their currency wallet to a bank account. Watch the withdrawal.created and withdrawal.approved webhooks.

Endpoints in this model

Members

The full set — provisioning, funding, trading, balances, orders, transactions and withdrawals.

Market data

Token listings, prices, historicals and search. Read-only and shared with the Direct model.

Webhooks

member.created, order, transaction and withdrawal events for your syndicate.

Compare with Direct

Side-by-side comparison of the two models.

Authentication

Members hold credentials of their own, but your integration does not use them. Every call you make is authenticated with your organisation’s secret key, and the member is identified by the id in the path.
Your secret key can act on behalf of every member in your syndicate. Keep it server-side — never ship it to a browser or mobile client.