> For the complete documentation index, see [llms.txt](https://docs.kaio.xyz/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.kaio.xyz/guide-to-using-kaio/kaio-platform/dealer/dealer.md).

# Dealer / Distributor APIs

## User

### Account

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

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><strong>Initiate Login</strong></td><td><em>/auth/login</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#19707a78-0ed9-455b-a307-ad52ab8746f0">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#19707a78-0ed9-455b-a307-ad52ab8746f0</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>Complete Login (with MFA code)</strong></td><td><em>/auth/login/mfa</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#ee883516-db00-4cbe-89f5-126e74a204a6">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#ee883516-db00-4cbe-89f5-126e74a204a6</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>Validate MFA</strong></td><td><em>/auth/mfa/validate</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#40688b97-ca43-4cb7-bdf6-5aba1bad7dd2">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#40688b97-ca43-4cb7-bdf6-5aba1bad7dd2</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>View Full Profile</strong></td><td><em>/profile</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#11b0fc01-4b12-4c9d-b91c-6e82127a1091">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#11b0fc01-4b12-4c9d-b91c-6e82127a1091</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>View Profile Summary</strong></td><td><em>/user/myprofile</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#f9ada140-b058-496d-b065-6472582c52ff">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#f9ada140-b058-496d-b065-6472582c52ff</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>Set Password</strong></td><td><em>/auth/confirm-password</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#ea875770-20bf-461c-b476-ae577c0f4298">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#ea875770-20bf-461c-b476-ae577c0f4298</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>Change Password</strong></td><td><em>/auth/change-password</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#50777b00-af87-4d30-aa62-f7edc0da4d00">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#50777b00-af87-4d30-aa62-f7edc0da4d00</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>Change Default Password</strong></td><td><em>/auth/login/temp</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#f1457ab4-51ac-456e-88fb-59f25e7d4beb">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#f1457ab4-51ac-456e-88fb-59f25e7d4beb</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>Reset Forgotten Password</strong></td><td><em>/auth/forgot-password</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#66fecbb2-7862-4480-844b-2bb868c186ef">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#66fecbb2-7862-4480-844b-2bb868c186ef</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td>Manage User access</td><td>/auth/access</td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#9dee0675-13ed-4fd1-b5bb-2c7d2e3eb54b">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#9dee0675-13ed-4fd1-b5bb-2c7d2e3eb54b</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr></tbody></table>

### Roles

Handle roles derived from your current one.

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><strong>Create Role</strong></td><td><em>/profile/role/create</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#9fc08af6-132f-4529-a41e-21ab93296b2c">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#9fc08af6-132f-4529-a41e-21ab93296b2c</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>Grant Role</strong></td><td><em>/profile/role/grant</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#60fd83f8-ef81-4be7-bf84-b585642b66c8">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#60fd83f8-ef81-4be7-bf84-b585642b66c8</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>Grant Access</strong></td><td><em>/profile/role/grant/access</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#8d9d9775-1c3e-423e-bf47-c4532bf22e4a">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#8d9d9775-1c3e-423e-bf47-c4532bf22e4a</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>Revoke Access</strong></td><td><em>/profile/role/revoke</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#f960ce14-de9d-43a0-b946-e446c06c4458">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#f960ce14-de9d-43a0-b946-e446c06c4458</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>Reset Access</strong></td><td><em>/profile/role/reset</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#a8a0688d-b2d8-4a08-a42d-22f6f0a87976">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#a8a0688d-b2d8-4a08-a42d-22f6f0a87976</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr></tbody></table>

### Wallets

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

<table data-view="cards" data-full-width="false"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><strong>Create Investor Wallet</strong></td><td><em>/user/:userId/wallet</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#5a4ed0fc-b4b6-4c26-99d5-460cd9362158">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#5a4ed0fc-b4b6-4c26-99d5-460cd9362158</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>View Wallets</strong></td><td><em>/wallet</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#74a6fb63-1a38-4859-b33f-37c33823e4f2">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#74a6fb63-1a38-4859-b33f-37c33823e4f2</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>View Wallet (by user)</strong></td><td><em>/user/:userId/wallet</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#fb33f1d5-c1ad-471a-882e-2d5247baf9ab">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#fb33f1d5-c1ad-471a-882e-2d5247baf9ab</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>View Wallet (by address)</strong></td><td><em>/user/:userId/wallet/:address</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#c1ce4f03-50c1-4bf5-957a-98601f450c06">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#c1ce4f03-50c1-4bf5-957a-98601f450c06</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>Update Wallet Label</strong></td><td><em>/user/:userId/wallet/:address</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#281aff1a-059a-401f-978b-186b8572ff26">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#281aff1a-059a-401f-978b-186b8572ff26</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr></tbody></table>

### Portfolio

View an Investor's current holdings and past settlements.

<table data-view="cards" data-full-width="false"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><strong>View Current Holdings</strong></td><td><em>/portfolio</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#f33d37b3-ee1c-427f-8fc3-7f53dfe40836">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#f33d37b3-ee1c-427f-8fc3-7f53dfe40836</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>View Past Settlements</strong></td><td><em>/portfolio/settlement</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#d15db161-52e6-42f3-b4a7-8590f768fbc6">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#d15db161-52e6-42f3-b4a7-8590f768fbc6</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr></tbody></table>

## Management

### Dealers

View Dealer information.

<table data-view="cards" data-full-width="false"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><strong>View Action Summary</strong></td><td><em>profile/summary</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#35e85155-1b5a-4353-9d5b-691849168fc3">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#35e85155-1b5a-4353-9d5b-691849168fc3</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr></tbody></table>

### Investors

Create and view Investors, handle their data and access.

<table data-view="cards" data-full-width="false"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><strong>Create Investor</strong></td><td>/<em>auth/register</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#90ae9682-be7e-43d2-b2d2-5a5f9d005e54">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#90ae9682-be7e-43d2-b2d2-5a5f9d005e54</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>Update Investor</strong></td><td><em>/user/:investorId</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#26722947-c173-41c4-8653-e2c45b7cd391">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#26722947-c173-41c4-8653-e2c45b7cd391</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>View Investors</strong></td><td><em>/user</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#8d1c1e7a-c8ad-42fb-8140-a15d3440942f">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#8d1c1e7a-c8ad-42fb-8140-a15d3440942f</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>View Investor (by Id)</strong></td><td><em>/user/:investorId</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#9a4758f4-88d0-4d2c-ba83-124ac40b9b03">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#9a4758f4-88d0-4d2c-ba83-124ac40b9b03</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>View Access to Instrument</strong></td><td><em>/profile/investor/:investorId/verify/:instrumentId</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#86db687c-541f-456c-91eb-d89a5024c236">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#86db687c-541f-456c-91eb-d89a5024c236</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>View Investor's Orderbook</strong></td><td><em>/user/:investorId/orderbook</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#6ad7c479-4253-4b5c-bdc0-e94b9c922bdc">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#6ad7c479-4253-4b5c-bdc0-e94b9c922bdc</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>Restrict Investor from Instrument</strong></td><td><em>/profile/investor/:investorId/restrict</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#6b61a39f-56bd-4e08-96bf-5eb37d6b3109">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#6b61a39f-56bd-4e08-96bf-5eb37d6b3109</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>Set Investor's AML/KYC/Sanction Status</strong></td><td><em>/profile/investor/:invetsorId/sanction</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#d543eade-169e-4aa4-9129-e8c1cdbcc06e">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#d543eade-169e-4aa4-9129-e8c1cdbcc06e</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>View Investor's Instruments</strong></td><td><em>/user/:userId/fund/:instrumentId</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#bfad0260-9681-40e7-9be5-30edfa6a514a">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#bfad0260-9681-40e7-9be5-30edfa6a514a</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>Manage Investor Access</strong></td><td><em>/auth/access</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#9dee0675-13ed-4fd1-b5bb-2c7d2e3eb54b">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#9dee0675-13ed-4fd1-b5bb-2c7d2e3eb54b</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>View Investor Data Update Requests</strong></td><td><em>/profile/investor/:investorId/updates</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#60ae8dc5-d08a-42a9-a025-6f66dae2306a">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#60ae8dc5-d08a-42a9-a025-6f66dae2306a</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>View Data Update Requests from Associated Investors</strong></td><td><em>/profile/investor/updates</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#d26a2d64-2d99-40ca-b2bd-8718b70271ff">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#d26a2d64-2d99-40ca-b2bd-8718b70271ff</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>Accept/Reject Investor Data Update Request</strong></td><td><em>/profile/investor/:investorId/updates</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#6f748604-3772-4930-ae21-862f339dbb1b">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#6f748604-3772-4930-ae21-862f339dbb1b</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>Get all Onboarding inputs</strong></td><td>user/dealer/onboard-config</td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#75eaeda5-fda4-4d9e-b509-7715a5ecb24d">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#75eaeda5-fda4-4d9e-b509-7715a5ecb24d</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>Get editable inputs created by the dealer</strong></td><td>user/dealer/editable-form</td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#5fda9dea-c340-48b0-accb-051c30817d94">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#5fda9dea-c340-48b0-accb-051c30817d94</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>Dealer update his onboarding inputs</strong></td><td>user/dealer/editable-form</td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#a59b466a-c2a6-4501-a0e1-6a17ee13c84b">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#a59b466a-c2a6-4501-a0e1-6a17ee13c84b</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>Get Onchain onboarding fields</strong></td><td>user/dealer/onchain-fields</td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#8670b02d-94fd-4227-9183-2a5c51a0b5a4">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#8670b02d-94fd-4227-9183-2a5c51a0b5a4</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr></tbody></table>

### Investor's Subscriptions

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

<table data-view="cards" data-full-width="false"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><strong>Create Subscription Order</strong></td><td><em>/orderbook/subscription/order</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#2bf8203d-ca40-4d68-b117-18d4f4e1bd74">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#2bf8203d-ca40-4d68-b117-18d4f4e1bd74</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>View Subscription Orders</strong></td><td><em>/orderbook/order</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#dfd1c88a-062c-4e5d-986e-6c182a96e075">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#dfd1c88a-062c-4e5d-986e-6c182a96e075</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>View Subscription Order (by Id)</strong></td><td><em>/orderbook/order/:orderId</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#af2e56ec-b42d-4eac-ab84-69083a8852a4">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#af2e56ec-b42d-4eac-ab84-69083a8852a4</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>Confirm Subscription Order</strong></td><td><em>/orderbook/subscription/order/confirm</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#ef1d1146-9b75-4191-a19b-cebb279848c9">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#ef1d1146-9b75-4191-a19b-cebb279848c9</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>Cancel Subscription Order</strong></td><td><em>/orderbook/subscription/order/cancel</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#acdc5dd6-170b-4577-aede-30c97184545b">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#acdc5dd6-170b-4577-aede-30c97184545b</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr></tbody></table>

### Investor's Redemptions

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

<table data-view="cards" data-full-width="false"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><strong>Create Redemption Order</strong></td><td><em>/orderbook/redemption/order</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#04fd8f1c-31c1-42f7-90ab-9c96c464459d">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#04fd8f1c-31c1-42f7-90ab-9c96c464459d</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>View Redemption Orders</strong></td><td><em>/orderbook/order</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#dfd1c88a-062c-4e5d-986e-6c182a96e075">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#dfd1c88a-062c-4e5d-986e-6c182a96e075</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>View Redemption Order (by Id)</strong></td><td><em>/orderbook/order/:orderId</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#af2e56ec-b42d-4eac-ab84-69083a8852a4">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#af2e56ec-b42d-4eac-ab84-69083a8852a4</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>Confirm Redemption Order</strong></td><td><em>/orderbook/redemption/order/confirm</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#9bb4dfa3-dde2-44ff-9d62-8982abd3d922">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#9bb4dfa3-dde2-44ff-9d62-8982abd3d922</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>Lock Redemption Order</strong></td><td><em>/orderbook/redemption/order/lock</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#f3f805b5-ccf9-43d9-b8ed-feb8ac8e5952">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#f3f805b5-ccf9-43d9-b8ed-feb8ac8e5952</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>Cancel Redemption Order</strong></td><td><em>/orderbook/redemption/order/cancel</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#703f4a22-f827-4d68-868c-fcef91fe3a60">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#703f4a22-f827-4d68-868c-fcef91fe3a60</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr></tbody></table>

### Funds

View subscribed Funds and their information.

<table data-view="cards" data-full-width="false"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><strong>View Funds</strong></td><td><em>/security/fund</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#ecf45e72-3abd-4b0b-80b3-1b3a0c407da8">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#ecf45e72-3abd-4b0b-80b3-1b3a0c407da8</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>View Fund (by Id)</strong></td><td><em>/security/fund/:fundId</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#e6957477-b38f-486f-b9af-4716ec6b3294">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#e6957477-b38f-486f-b9af-4716ec6b3294</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr></tbody></table>

### Instruments

View Instruments and their information.

<table data-view="cards" data-full-width="false"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><strong>View Instruments</strong></td><td><em>/security/fund/:fundId/instrument</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#fc8feb71-ba2c-4c6d-b7ba-a6b0f50a25aa">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#fc8feb71-ba2c-4c6d-b7ba-a6b0f50a25aa</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>View Instrument (by Id)</strong></td><td><em>/security/fund/:id/instrument/:instrumentId</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#034d1911-942a-40a9-90e3-7cc88f262309">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#034d1911-942a-40a9-90e3-7cc88f262309</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>View NAV</strong><br><em>/security/fund/:fundId/instrument/:instrumentId/nav</em></td><td></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#7d48b6ba-922e-4ea0-bc78-ac346cc789f5">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#7d48b6ba-922e-4ea0-bc78-ac346cc789f5</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr></tbody></table>

## Requests

### Agreement Requests

Handle agreement requests on behalf of an Investor.

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><strong>Create Agreement Request</strong></td><td><em>/docusign</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#ce69d23b-bae2-487a-921c-eadd5c0b99cc">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#ce69d23b-bae2-487a-921c-eadd5c0b99cc</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><p><strong>View Full Agreement Requests</strong></p><p><em>/docusign</em></p></td><td></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#0ec6de5f-9684-416b-8d89-05d6020e4acb">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#0ec6de5f-9684-416b-8d89-05d6020e4acb</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>View Full Agreement Request (by Id)</strong></td><td><em>/order-request/:requestId</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#d4c22c9c-18cc-44f0-96df-7ed5682abcb8">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#d4c22c9c-18cc-44f0-96df-7ed5682abcb8</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>View Agreement Document (by Id)</strong></td><td><em>/docusign/document/:documentId</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#56201678-d1b8-4f2b-92eb-3532b80b5869">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#56201678-d1b8-4f2b-92eb-3532b80b5869</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>View Custom Fields from Document (by Id)</strong></td><td><em>/docusign/custom-fields/:orderId</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#dd06c0e5-9ad0-4073-870c-b4af51985a7d">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#dd06c0e5-9ad0-4073-870c-b4af51985a7d</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>View Document Envelope (by Id)</strong></td><td><em>/docusign/envelop/:orderId</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#4387087b-4170-4d80-b3d9-f6539031c791">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#4387087b-4170-4d80-b3d9-f6539031c791</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr></tbody></table>

### Access Requests

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

<table data-view="cards" data-full-width="false"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><strong>Request Access to Fund/Instrument</strong></td><td><em>/user/:userId/subscribe</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#c4c8550a-f501-4c35-9eb3-4a58716e8bf6">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#c4c8550a-f501-4c35-9eb3-4a58716e8bf6</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>View Access Requests</strong></td><td><em>/user/fund-admin/request-access</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#2fdbb5f3-5d26-42ae-bc76-672b215bde5d">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#2fdbb5f3-5d26-42ae-bc76-672b215bde5d</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>View Access Request (by Id)</strong></td><td><em>/user/fund-admin/request-access/:requestId</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#aca23bbd-d84c-452b-93cd-ece15fcea7f5">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#aca23bbd-d84c-452b-93cd-ece15fcea7f5</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr></tbody></table>

### General Requests

Create and view your general requests towards the KAIO Admin.

<table data-view="cards" data-full-width="false"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><strong>Send General Request to Admin</strong></td><td><em>/request</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#b803c439-dafb-4a15-b4db-47b5962254b2">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#b803c439-dafb-4a15-b4db-47b5962254b2</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>View General Requests</strong></td><td><em>/request</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#378b5e84-2caa-416d-bade-1118fe22bad4">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#378b5e84-2caa-416d-bade-1118fe22bad4</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>View General Request (by Id)</strong></td><td><em>/request/:requestId</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#16405492-bb38-4079-a003-33969d47e635">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#16405492-bb38-4079-a003-33969d47e635</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr></tbody></table>

## Compliance

### Rule Modules

Handle your rule modules containing rules for your investors.

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><strong>Register Module</strong></td><td><em>/profile/module/register</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#0e930155-c657-47cb-9755-a1d6c3078fef">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#0e930155-c657-47cb-9755-a1d6c3078fef</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>View Modules</strong></td><td><em>/module</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#6186ec79-0258-46c7-8ff6-b9b6fadbb663">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#6186ec79-0258-46c7-8ff6-b9b6fadbb663</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>View Module (by Id)</strong></td><td><em>/module/:moduleId</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#3360d30f-427c-4945-9da7-f9c3f7191876">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#3360d30f-427c-4945-9da7-f9c3f7191876</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>Delete Module</strong></td><td><em>/module/dealer</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#ad037add-cad9-4585-9727-9356f3c8bd5d">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#ad037add-cad9-4585-9727-9356f3c8bd5d</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr><tr><td><strong>Enable/Disable Module</strong></td><td><em>/profile/module/dealer</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#fb627120-ffd3-4f80-9000-b2982fa40821">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#fb627120-ffd3-4f80-9000-b2982fa40821</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr></tbody></table>

### On-chain Transactions

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

<table data-view="cards"><thead><tr><th></th><th></th><th data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Submit a transaction to smart contract</strong></td><td><em>transaction/submit</em></td><td></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#756940d3-586a-4832-be7b-a24df22552c8">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#756940d3-586a-4832-be7b-a24df22552c8</a></td></tr><tr><td><strong>Query or simulate a transaction to smart contract</strong></td><td><em>transaction/query</em></td><td></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#a06fe6c0-4691-42a5-a754-e6e225f3201d">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#a06fe6c0-4691-42a5-a754-e6e225f3201d</a></td></tr></tbody></table>

### Legal Documents

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

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Get All Platform legal documen</strong>ts</td><td><em>legal-document</em></td><td></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#63133608-d090-4926-bc07-a66468ba26a2">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#63133608-d090-4926-bc07-a66468ba26a2</a></td></tr><tr><td><strong>Get legal document details</strong></td><td></td><td><em>legal-document/:id</em></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#0d04fcb0-903f-44a2-aef4-10bec769139b">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#0d04fcb0-903f-44a2-aef4-10bec769139b</a></td></tr><tr><td><strong>Download document</strong></td><td></td><td><em>legal-document/:id/file</em></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#80656859-b111-4ca0-add5-0b03dfc642f2">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#80656859-b111-4ca0-add5-0b03dfc642f2</a></td></tr></tbody></table>

### Registries

Handle Investor registry data directly.

{% hint style="warning" %}
Editing registry data directly is an advanced feature. To avoid issues, it should only be done with a good understanding of [how registries work](https://github.com/NethermindEth/libre-documentation/blob/release/using-libre/understanding-projects/broken-reference/README.md).
{% endhint %}

<table data-view="cards" data-full-width="false"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><strong>Edit Investor Registry Data</strong></td><td><em>/profile/registries/:registryId/dynamic-fields</em></td><td><a href="https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#d7d0b275-a608-4c41-80bf-5bad1d599929">https://documenter.getpostman.com/view/26092879/2s93Xu36Mm#d7d0b275-a608-4c41-80bf-5bad1d599929</a></td><td><a href="https://3175396519-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0VHmHWbaiKARXrxAh2Wg%2Fuploads%2Fgit-blob-a3f7ff6292c20520d6ee89577a4b3179af5380bd%2FpostmanLogo.png?alt=media">postmanLogo.png</a></td></tr></tbody></table>