# Sub-Accounts & White-Label Retail KYC

> Customer onboarding, KYC submission, sub-account portfolios, account activities, watchlists, and notification devices.

Product 3 in the [Partner API product catalog](/partners/docs/api-products), covering **32 operations**.

Customer onboarding, KYC submission, sub-account portfolios, account activities, watchlists, and notification devices.

## Integration guides

[broker api](/partners/docs/broker-api) · [sub accounts](/partners/docs/sub-accounts) · [kyc aml sanctions](/partners/docs/kyc-aml-sanctions)

## Endpoint catalog

Paths are relative to `https://mystocks.africa/api/v1/partner` in production and `https://mystocks.africa/api/sandbox/v1/partner` in sandbox.

Open the [API Reference](/partners/docs/api-reference) and search the operation ID for request parameters, schemas, response codes, and examples. Use the [API Tester](/partners/docs/api-tester) to exercise an operation.

Sandbox availability is taken from each operation's OpenAPI metadata. Production-only operations and unsupported sandbox stubs are explicitly distinguished; account entitlements and instrument eligibility still apply.

| Method and path                                   | Operation ID                     | Purpose                                     | Sandbox          |
| ------------------------------------------------- | -------------------------------- | ------------------------------------------- | ---------------- |
| `POST /auto-register`                             | `createAutoRegister`             | Auto-register sub-account                   | Available        |
| `GET /users`                                      | `listUsers`                      | List sub-accounts                           | Available        |
| `POST /users`                                     | `createUsers`                    | Create sub-account                          | Available        |
| `DELETE /users/{userId}`                          | `closeUsers`                     | Close sub-account                           | Available        |
| `GET /users/{userId}`                             | `getUsers`                       | Get sub-account                             | Available        |
| `PATCH /users/{userId}`                           | `updateUsers`                    | Update sub-account                          | Available        |
| `GET /users/{userId}/buying-power`                | `getSubAccountBuyingPower`       | Sub-account buying power (settlement-aware) | Available        |
| `POST /users/{userId}/deposit`                    | `createDeposit`                  | Deposit to sub-account                      | Available        |
| `GET /users/{userId}/devices`                     | `listUserDevices`                | List notification devices                   | Available        |
| `POST /users/{userId}/devices`                    | `registerUserDevice`             | Register notification device                | Available        |
| `DELETE /users/{userId}/devices/{deviceId}`       | `revokeUserDevice`               | Revoke notification device                  | Available        |
| `GET /users/{userId}/dividends`                   | `listDividends`                  | Sub-account dividends                       | Available        |
| `GET /users/{userId}/gains`                       | `getSubAccountGains`             | Realized capital gains (sub-account)        | Available        |
| `POST /users/{userId}/kyc`                        | `createKyc`                      | KYC assertion                               | Available        |
| `GET /users/{userId}/orders`                      | `listUserOrders`                 | Sub-account orders                          | Available        |
| `DELETE /users/{userId}/orders/{orderId}`         | `deleteUsersUserIdOrdersOrderId` | Cancel sub-account order                    | Available        |
| `GET /users/{userId}/orders/{orderId}`            | `getUserOrder`                   | Get sub-account order                       | Available        |
| `PATCH /users/{userId}/orders/{orderId}`          | `replaceUserOrder`               | Replace (modify) a resting order            | Unsupported stub |
| `GET /users/{userId}/orders/{orderId}/executions` | `getUserOrderExecutions`         | Get sub-account order execution reports     | Available        |
| `GET /users/{userId}/portfolio`                   | `getUserPortfolio`               | Sub-account portfolio                       | Available        |
| `GET /users/{userId}/portfolio/history`           | `getUserPortfolioHistory`        | Sub-account equity history                  | Available        |
| `GET /users/{userId}/portfolio/performance`       | `getUserPortfolioPerformance`    | Sub-account cash-flow-adjusted performance  | Available        |
| `POST /users/{userId}/redeem`                     | `createRedeem`                   | Redeem fund units                           | Available        |
| `POST /users/{userId}/subscribe`                  | `createSubscribe`                | Subscribe (bond/fund/deal)                  | Available        |
| `GET /users/{userId}/tax-lots`                    | `getSubAccountTaxLots`           | Open tax lots (sub-account)                 | Available        |
| `POST /users/{userId}/trade`                      | `createUserTrade`                | Trade on behalf                             | Available        |
| `GET /users/{userId}/transactions`                | `listTransactions`               | Sub-account transactions                    | Available        |
| `GET /users/{userId}/wallet`                      | `listWallet`                     | Sub-account wallet                          | Available        |
| `GET /users/{userId}/watchlist`                   | `listWatchlist`                  | List sub-account watchlist                  | Available        |
| `POST /users/{userId}/watchlist`                  | `addToWatchlist`                 | Add symbol to watchlist                     | Available        |
| `DELETE /users/{userId}/watchlist/{symbol}`       | `removeFromWatchlist`            | Remove symbol from watchlist                | Available        |
| `POST /users/{userId}/withdraw`                   | `createWithdraw`                 | Withdraw from sub-account                   | Available        |

## Shared contracts

[auth](/partners/docs/auth) · [errors](/partners/docs/errors) · [rate limits](/partners/docs/rate-limits) · [contract guarantees](/partners/docs/contract-guarantees)

[Download the September 2026 specification PDF](/docs/PartnerAPI.pdf). Read the [online clarifications](/partners/docs/partner-specification) before using the PDF's general examples.