API product catalogDeveloper Platform, Sandbox & Key Management

Submit upgrade request

Developer Platform, Sandbox & Key Management

POST

/upgrade-request

Sandbox availablePortal sign-in requiredcreateUpgradeRequest

Submits an upgrade request to the MyStocks partnerships team. Authentication: Firebase ID token required (Authorization: Bearer <firebase-token>). Two modes: - Sandbox → live key (default, no targetTier): for partners without a live key yet. Triggers KYB review; live pk_live_ key issued within 1–2 business days. - Tier upgrade (targetTier required): for partners with an active live key who want to move from starter → growth or enterprise.

Parameters

This endpoint has no path or query parameters.

Headers

AuthorizationstringRequired

Bearer Firebase ID token from your partner portal session.

Request body

messagestring

Optional message to the reviewing team.

targetTiergrowth | enterprise

Required for tier upgrade requests. Omit for sandbox-to-live requests.

Response fields

messagestring

requestIdstring

Response codes

201Request submitted.

400Invalid targetTier or already on that tier.

Request reference

Sandbox available

This operation requires a partner portal session. Follow the authentication guide.

https://mystocks.africa/api/sandbox/v1/partner/upgrade-request

API Reference Authentication guide

Response schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "requestId": {
      "type": "string"
    }
  }
}

curl -X POST 'https://mystocks.africa/api/sandbox/v1/partner/upgrade-request' \
  -H "Authorization: Bearer $FIREBASE_ID_TOKEN"

GET /upgrade-request

GET /webhooks