KAIO Admin References

All operations the KAIO Admin can perform using the API

User

Account

Handle logging into your account, viewing it, password management, and Multi-factor authentication.

Initiate Login

/auth/login

Complete Login (with MFA code)

/auth/login/mfa

Validate MFA

/auth/mfa/validate

View Full Profile

/profile

View Profile Summary

/user/myprofile

Set Password

/auth/confirm-password

Change Password

/auth/change-password

Change Default Password

/auth/login/temp

Reset Forgotten Password

/auth/forgot-password

Roles

Handle roles in the system.

Create Role

/profile/role/create

Grant Role

/profile/role/grant

Grant Access

/profile/role/grant/access

Revoke Access

/profile/role/revoke

Reset Access

/profile/role/reset

Set Contract Manager

/admin/role/contract-manager

Wallets

Create and view user wallets, and update their labels.

Create Wallet

/user/:userId/wallet

View Wallets

/wallet

View Wallet (by user)

/user/:userId/wallet

View Wallet (by address)

/user/:userId/wallet/:address

Update Wallet Label

/user/:userId/wallet/:address

Portfolio

View an Investor's current holdings and past settlements.

View Current Holdings

/portfolio

View Past Settlements

/portfolio/settlement

Management

Funds

Create, view, and update Funds.

Create Fund

/security/fund

Update Fund

/security/fund/:fundId

View Funds

/security/fund

View Fund (by Id)

/security/fund/:fundId

View Fund Orderbooks

/security/fund/:fundId/orderbook

View Fund Clients

/security/fund/:fundId/clients

Instruments

Create, view, and manage Instruments.

Create Instrument

/security/fund/:fundId/instrument

View Instruments

/security/fund/:fundId/instrument

View Instrument (by Id)

/security/fund/:id/instrument/:instrumentId

Update Instrument Description

/security/fund/:fundId/instrument/:instrumentId

Set up Subscription and Redemption Details for an Instrument

/profile/registries/:instrumentId/dynamic-fields

Initialize Instrument

/security/fund/:fundId/instrument/:instrumentId

Update NAV

/security/fund/:fundId/instrument/:instrumentId/nav

View NAV

/security/fund/:fundId/instrument/:instrumentId/nav

Set Approval Number for Settlement

/orderbook/:orderbookId/settlement

View Settlement Approval Details

/orderbook/settlement

View Settlement Approval Details (by Id)

/orderbook/:orderbookId/settlement

Fund Admins

Create, view, and handle Fund Admins.

Create Fund Admin

/auth/register

Update Fund Admin

/user/:fundAdmin

View Fund Admins

/user

View Fund Admin (by Id)

/user/:userId

Assign Fund Admin to Fund

/user/:fundAdminId/subscribe

Manage Fund Admin Access

/auth/access

Dealers

Create, view, and handle Dealers.

Create Dealer

/auth/register

Update Dealer

/user/:dealerId

View Dealers

/user

Give Dealer Access to Fund

/user/:dealerId/subscribe

View Dealer's Instruments

/user/:userId/fund/:instrumentId

Manage Dealer Access

/auth/access

Investors

View Investors.

Change Dealer

/user/:investorId/assign/dealer

Allow Investor for Instrument

/user/fund-admin/request-access/instrument/investor

View Investors

/user

View Investor (by Id)

/user/:investorId

View Investor's Orderbook

/user/:investorId/orderbook

View Investor's Instruments

/user/:userId/fund/:instrumentId

Manage Investor Access

/auth/access

Investor's Subscriptions

Settle, create, view, and handle an Investor's subscription orders through their lifecycle.

View Subscription Orders

/orderbook/order

View Subscription Order (by Id)

/orderbook/order/:orderId

Lock Subscription Order

/orderbook/subscription/order/lock

Settle Subscription Orders

/orderbook/subscription/order/settle

Cancel Subscription Order

/orderbook/subscription/order/cancel

Investor's Redemptions

Settle, create, force, view, and handle an Investor's redemption orders through their lifecycle. You can also rebalance redemptions.

View Redemption Orders

/orderbook/order

View Redemption Order (by Id)

/orderbook/order/:orderId

Settle Redemption Orders

/orderbook/redemption/order/settle

Cancel Redemption Order

/orderbook/redemption/order/cancel

Rebalance Redemption Orders

/orderbook/redemption/order/rebalance

Force Redemption

/orderbook/redemption/order/force

Fill Redemption Order

/orderbook/redemption/order/fill

Requests

Agreement Requests

View agreement requests from Investors.

Accept/Reject Agreement Request

/order-request/:requestId

View Agreement Requests

/order-request

View Full Agreement Request (by Id)

/order-request/:requestId

View Agreement Document (by Id)

/docusign/document/:documentId

View Custom Fields from Document (by Id)

/docusign/custom-fields/:orderId

View Document Envelope (by Id)

/docusign/envelop/:orderId

Access Requests

Reply to requests, or handle them towards an admin on behalf of an Investor.

Respond to Access Request

/user/fund-admin/request-access/:requestId

View Access Requests

/user/fund-admin/request-access

View Access Request (by Id)

/user/fund-admin/request-access/:requestId

General Requests

Update and view your general requests.

Update General Request Status

/request/:requestId

View General Requests

/request

View General Request (by Id)

/request/:requestId

Compliance

Jurisdictions

Handle jurisdiction compliance data.

Set Jurisdiction Data

/admin/jurisdiction/

Rule Modules

Handle your rule modules containing rules for all investors using KAIO.

Register Universal Module

/module/dealer/rules-engine/register

View Universal Modules

/module

View Universal Module (by Id)

/module/:moduleId

Delete Universal Module

/module/dealer/rules-engine/delete

Enable/Disable Universal Module

/module/dealer/rules-engine/update

Registries

Handle any registry data directly.

Editing registry data directly is an advanced feature. To avoid issues, it should only be done with a good understanding of how registries work.

Edit Registry Data

/profile/registries/:registryId/dynamic-fields

On-chain Transactions

Submit transactions, query data or simulate transactions from any smart contract

Submit a transaction to smart contract

transaction/submit

Query or simulate a transaction to smart contract

transaction/query