Choosing your integration

Before writing any code, decide which product you are integrating. The three products use different endpoints, model your end users differently, and place the ledger of record in different places.

Investments API · Direct

You are regulated. You keep your own ledger and attach a customer object to each trade.

Investments API · Managed

You are not regulated. GetEquity holds an account for each of your users as a member.

Credit API

You are a credit provider lending against portfolios held on GetEquity.

At a glance

	Direct	Managed	Credit
You are	A regulated entity	An intermediary without your own permissions	A credit provider
Ledger of record for the end user	You	GetEquity	You (the loan); GetEquity (the collateral)
Who GetEquity sees as the counterparty	Your organisation	The individual member	Your organisation as creditor
End user has GetEquity credentials	No	Yes	No
End user representation	A `customer` object on each trade	A member account with its own wallet	An existing GetEquity user you lend to
Primary routes	`api/token/`, `api/customers/`	`api/member`, `api/members/{id}/*`	`api/credit/`, `api/creditor/`
Funds settle into	Your organisation wallet	The member’s own wallet	—

Direct — for regulated entities

If your company already holds the permissions to hold client assets and run a ledger, you integrate as the principal. You have one organisation account and one wallet, and you trade as yourself. Every trade carries a customer object identifying which of your end users the activity belongs to. GetEquity records that attribution and surfaces it back through the Customers endpoints, but it never provisions an account for that person — reconciling positions to your individual users remains your responsibility.

POST api/token/{id}/buy

{
  "amount": 20,
  "price": 10,
  "currency": "USD",
  "customer": {
    "name": "Rema Divine",
    "email": "rema@example.com"
  }
}

Read the Direct integration guide

Managed — for non-regulated entities

If you do not hold those permissions, you act as an intermediary between your users and GetEquity. GetEquity provisions a real account — a member — for each of your users, sitting inside your organisation’s syndicate. A member has their own credentials, their own wallet, their own balances, orders and transactions. You create them with Create Member and then act on their behalf through the api/members/{id}/* routes.

POST api/member

{
  "email": "willmember@example.com",
  "password": "William01",
  "fname": "William",
  "lname": "Ajasco",
  "username": "willmember",
  "phone": "08026662262"
}

Read the Managed integration guide

Credit — for credit providers

The Credit API is a separate product. Rather than distributing investments, you lend against them: a GetEquity user pledges their existing portfolio as collateral, and you issue and service the loan against it.

Read the Credit API guide

Shared across all three

Authentication

Every product uses the same Bearer secret key issued to your organisation.

Market data

Token listings, prices, historicals and search are read-only and identical in every model.

Webhooks

One webhook URL per organisation receives events for whichever products you use.

Sandbox

All three products are available on the staging base URL before you go live.

Direct and Managed are not mixed within one integration. Pick the one that matches your regulatory position — if you are unsure which applies to you, contact support before you build.

Investments API · Direct

Investments API · Managed

Credit API

​At a glance

​Direct — for regulated entities

Read the Direct integration guide

​Managed — for non-regulated entities

Read the Managed integration guide

​Credit — for credit providers

Read the Credit API guide

​Shared across all three

Authentication

Market data

Webhooks

Sandbox

At a glance

Direct — for regulated entities

Managed — for non-regulated entities

Credit — for credit providers

Shared across all three