# API ## Content Guide The API section of the KAIO documentation provides a learning resource to become familiar with the platform and provides references for partner integrations. This page provides an overview of the KAIO platform, its users, what they can do, and the relationships between them. Each sub-section relates to a particular user type and contains: * **\[User] How-Tos:** The how-to guides contain the most usual flows for each type of user, with explanations and lists of steps. * **\[User] References:** The reference pages contain the complete list of API calls available to each type of user. Individual cards link to the corresponding API call on Postman for easy access, also containing a description and some examples for each one. An additional guide for the Postman content can be found in . ## KAIO API {% hint style="info" %} **NOTE**: We are in the process of moving our API documentation to Swagger at {% endhint %} The KAIO API enables users to interact with KAIO directly without using the KAIO Website. Once logged in, users can make certain API calls according to their user type. ## User Types There are four user types, as described in the following table:

User Type	Description	Main Viewing Calls	Main Interaction Calls
Investor	Investors are clients of private banks. They mostly sign agreement contracts and let their Dealer manage their orders on their behalf. They can create orders on their own if allowed by the Dealer	→View access to Funds and Instruments →View all past orders	→Create/Confirm/Lock/Cancel orders →Submit general requests to the KAIO Admin
Dealer	Dealers are private banks and advisors that are responsible for onboarding investors, managing their profiles, and creating orders on their behalf.	→View Funds they have access to →View orders of Investors they manage →View information of Investors they manage	→Onboard Investors →Update Investor data →Create/Confirm/Lock/Cancel Investor orders →Upload agreement contracts to be signed on DocuSign →Submit general requests to the KAIO Admin
Fund Admin	Fund Admins are responsible for managing the Funds they control, and all the Instruments within the Fund.	→View Funds they manage →View Instruments belonging to their Funds →View orders submitted in their Instruments. →View agreement contracts signed by Investors	→Update Fund information →Update Instrument information →Set up instrument configuration →Update audited/unaudited Net Asset Value (NAV) →Approve/Reject orders
KAIO Admin	The KAIO Admin has control of the KAIO platform. They are responsible for answering requests, onboarding new Dealers and Fund Admins, and creating new Funds and Instruments.	→View all Fund information →View all Instrument information →View all Investor information →View all Dealer information	→Onboard Fund Admins and Dealers →Set Roles →Create Funds and Instruments →Lock and Settle orders

## Object Definitions * **Fund**: Houses a set of Instruments, and is managed by a Fund Admin. * **Instrument**: Describes the tokenized asset itself, also containing the custom logic of the asset. * **Order**: Request made to subscribe or redeem the tokenized asset, going through multiple stages before being finalized. An order's status can be one of the following: * CREATED * CONFIRMED * CANCELED * REJECTED * UNDER\_REVIEW * ACCEPTED * LOCKED SETTLED ## Examples Below are some example sequence diagrams illustrating operation flows between users, in this case the most usual subscription and redemption lifecycles: #### Subscriptions

#### Redemptions

## Postman Content Guide In the [Postman documentation](https://documenter.getpostman.com/view/26092879/2s93Xu36Mm) you can find the endpoints to use when interacting with KAIO using API calls. For each endpoint you can find a short description and some example requests. Some endpoints require requests to have a body, these additionally contain the raw body example and a table with the fields it contains, with additional information. Some endpoints also include path variables and/or parameters in the URL, in which case they contain sections with examples and descriptions for them. It is strongly encouraged to use the documentation on GitBook for navigation, where you can find links to the specific endpoints you want more details on (leading to Postman). In order to improve navigation and readability, color codes have been used to represent the different types of users as follows: * ⚪: **All Users** * 🟡: **Investors** * 🟠: **Dealers** * 🔵: **Fund Admins** * 🟣: **KAIO Admin** These colors are used in a variety of contexts, and their meaning might change slightly in each one:

Name	Description	Color meaning
Name	Description	Color meaning	Location
Endpoint Titles	Name of the endpoint that can be called using the API.	The color indicates which types of users can call the endpoint. Special authorization might be required in addition to the user being the correct type.	Can be found at the beginning of each endpoint section, on the top left.
Request Examples	Examples of requests made using the API. They show different scenarios and options when calling an endpoint, and the return values when they succeed or fail.	The color indicates which type of user performed the request in each particular example. Multiple ones mean the examples is the same for multiple kinds of users. ✔️ and ❌ are used to show if the request was successful or not.	Can be found to the right of each endpoint section. The dropdown to change between examples is at the top right.
Field Tables	Tables defining the body fields required to call an endpoint, and providing additional information such as constraints or the optionality of the field.	The color indicates if the fields are only available/required by a specific type of user.	Can be found below the description for each endpoint, for the ones that have a body.

--- # Agent Instructions: 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: ``` GET https://docs.kaio.xyz/guide-to-using-kaio/understanding-projects.md?ask= ``` The question should be specific, self-contained, and written in natural language. 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.