> For the complete documentation index, see [llms.txt](https://synthesys-2.gitbook.io/synthesys-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://synthesys-2.gitbook.io/synthesys-docs/network-overview/api-reference/entities.md).

# Entities

The Synthesys network is built around a small set of **entities** that model the structure of a tokenized fund and the parties that interact with it. Understanding the entity model is the foundation for everything else in this documentation — every endpoint reads, writes, or references one of these objects, and the IDs you'll see in request bodies and response payloads all map back to entities defined here.

### The entity graph

The entities form a hierarchy that mirrors how funds are structured in the real world:

```
Issuer (IS) ──< Fund (FN) ──< Share class (SC) ──< Token (TK)
                                       ▲
Distributor (DT) ─────────────────────┘  (distributors operate against share classes)
Investor (IN) ─────────────────────────┘  (investors belong to distributors)
```

* An **Issuer** is the legal entity that owns one or more funds (e.g. an asset manager).
* A **Fund** is a single fund vehicle owned by an issuer.
* A **Share class** is a tradable unit of a fund. NAVs are published at the share-class level, fees are denominated per share class, and orders are placed against share classes.
* A **Token** is the on-chain representation of a share class on a specific blockchain. A share class has one *primary* token; that token's chain becomes the share class's `defaultChainId`.
* A **Distributor** is a partner organisation that onboards end-investors and places orders on their behalf.
* An **Investor** is an end-investor, always registered under exactly one distributor.

### ID format

Every entity is identified by a **6-digit zero-padded ID** with a 2-letter prefix:

| Prefix | Entity      | Example    |
| ------ | ----------- | ---------- |
| `IS`   | Issuer      | `IS000001` |
| `FN`   | Fund        | `FN000001` |
| `SC`   | Share class | `SC000001` |
| `DT`   | Distributor | `DT000001` |
| `IN`   | Investor    | `IN000001` |
| `TK`   | Token       | `TK000001` |

The prefix is part of the identifier and must be supplied verbatim where the API expects it. The numeric portion is allocated by the server at creation time — treat the returned ID as opaque and never try to predict or generate IDs locally.

### How entities are created

Most entities — issuers, funds, share classes, distributors, and tokens — are **created and managed by the Synthesys operations team** during your onboarding. You'll receive the identifiers for the entities relevant to your integration (your `distributorId`, the `shareClassId`s you have access to) once provisioning is complete.

The one entity you create yourself through this API is the **investor**, via `POST /investor/register`.

### Getting started

To onboard your organisation and get the entities you'll need provisioned, reach out to the Synthesys team at [**developer@synthesys.co**](mailto:developer@synthesys.co). The onboarding flow typically covers:

* Creating your **distributor** record and issuing your `distributorId`.
* Provisioning the **share classes** your organisation will distribute, including their NAV publication setup.
* Configuring **wallets** and **share-class grants** for your distributor and any test investors so you can place subscription orders.
* Sharing the environment hostname for the API base URL.

Once onboarded, your integration is ready to register investors and place orders — the rest of this documentation walks through the endpoints involved.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://synthesys-2.gitbook.io/synthesys-docs/network-overview/api-reference/entities.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.