Dealer References

All operations Dealers 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

Manage User access

/auth/access

Roles

Handle roles derived from your current one.

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

Wallets

Create and view investor wallets, and update their labels. You can also view your own wallets and update their labels.

Create Investor 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

Dealers

View Dealer information.

View Action Summary

profile/summary

Investors

Create and view Investors, handle their data and access.

Create Investor

/auth/register

Update Investor

/user/:investorId

View Investors

/user

View Investor (by Id)

/user/:investorId

View Access to Instrument

/profile/investor/:investorId/verify/:instrumentId

View Investor's Orderbook

/user/:investorId/orderbook

Restrict Investor from Instrument

/profile/investor/:investorId/restrict

Set Investor's AML/KYC/Sanction Status

/profile/investor/:invetsorId/sanction

View Investor's Instruments

/user/:userId/fund/:instrumentId

Manage Investor Access

/auth/access

View Investor Data Update Requests

/profile/investor/:investorId/updates

View Data Update Requests from Associated Investors

/profile/investor/updates

Accept/Reject Investor Data Update Request

/profile/investor/:investorId/updates

Get all Onboarding inputs

user/dealer/onboard-config

Get editable inputs created by the dealer

user/dealer/editable-form

Dealer update his onboarding inputs

user/dealer/editable-form

Get Onchain onboarding fields

user/dealer/onchain-fields

Investor's Subscriptions

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

Create Subscription Order

/orderbook/subscription/order

View Subscription Orders

/orderbook/order

View Subscription Order (by Id)

/orderbook/order/:orderId

Confirm Subscription Order

/orderbook/subscription/order/confirm

Cancel Subscription Order

/orderbook/subscription/order/cancel

Investor's Redemptions

Create, view, and handle an Investor's redemption orders through their lifecycle.

Create Redemption Order

/orderbook/redemption/order

View Redemption Orders

/orderbook/order

View Redemption Order (by Id)

/orderbook/order/:orderId

Confirm Redemption Order

/orderbook/redemption/order/confirm

Lock Redemption Order

/orderbook/redemption/order/lock

Cancel Redemption Order

/orderbook/redemption/order/cancel

Funds

View subscribed Funds and their information.

View Funds

/security/fund

View Fund (by Id)

/security/fund/:fundId

Instruments

View Instruments and their information.

View Instruments

/security/fund/:fundId/instrument

View Instrument (by Id)

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

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

Requests

Agreement Requests

Handle agreement requests on behalf of an Investor.

Create Agreement Request

/docusign

View Full Agreement Requests

/docusign

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

Handle access requests towards an admin on behalf of an Investor.

Request Access to Fund/Instrument

/user/:userId/subscribe

View Access Requests

/user/fund-admin/request-access

View Access Request (by Id)

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

General Requests

Create and view your general requests towards the KAIO Admin.

Send General Request to Admin

/request

View General Requests

/request

View General Request (by Id)

/request/:requestId

Compliance

Rule Modules

Handle your rule modules containing rules for your investors.

Register Module

/profile/module/register

View Modules

/module

View Module (by Id)

/module/:moduleId

Delete Module

/module/dealer

Enable/Disable Module

/profile/module/dealer

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

Legal Documents

Manage legal documents to be fetched and signed offline by the dealer

Get All Platform legal documents

legal-document

Get legal document details

legal-document/:id

Download document

legal-document/:id/file

Registries

Handle Investor 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 Investor Registry Data

/profile/registries/:registryId/dynamic-fields