API product catalogDeveloper Platform, Sandbox & Key Management

My status and workspace access

Developer Platform, Sandbox & Key Management

GET

/me

Sandbox availablePortal sign-in requiredlistMe

Returns the current partner account status. The production-only workspace=1 variant requires verified email and returns deploymentPreference, hosted approval and nextAction, sandbox status, installations (at most 50), limit and environment eligibility. Summary contains no raw installation secrets. Installation evaluation is Sandbox-only; Hosted approval and installation licensing are independent. Legacy organizations without an explicit Hosted decision retain their existing grant checks. Authentication: This endpoint requires a Firebase ID token (Authorization: Bearer <firebase-token>), not a partner API key. It is used by the partner portal dashboard on login. Response varies by account state: - Active live key → returns status: active, maskedKey, businessName, email maskedKey is for display only — it is not a usable credential. API keys are stored as SHA-256 hashes, so the raw key is shown exactly once (at issue or rotation) and cannot be retrieved afterwards. To call the API from a signed-in portal session, exchange the Firebase ID token for a short-lived access token via POST /api/v1/partner/session. - Suspended key → returns status: suspended, businessName - Pending/rejected application (no live key yet) → returns status, businessName, applicationSubmittedAt, applicationRejectionReason - No application → returns status: not_found

Parameters

workspace1query

Use 1 for the verified-email workspace summary instead of the legacy status response.

Headers

AuthorizationstringRequired

Bearer Firebase ID token from your partner portal session.

Response fields

deploymentPreferencehosted | onprem | both

Present in workspace=1 summaries; preference does not grant authority.

hostedobject

hosted.statusstring

hosted.liveAllowedboolean

hosted.codestring | null

hosted.nextActionstring

hosted.keyLast4string | null

sandboxobject

sandbox.statusstring

sandbox.nextActionstring

environmentobject

environment.liveAllowedboolean

environment.statusstring

limitinteger

installationsobject[]

installations[].idstring

installations[].requestIdstring | null

installations[].domainstring | null

installations[].statusstring

installations[].domainVerificationstring

installations[].licenseStatusstring

installations[].accessLevelstring

installations[].accessTypestring | null

installations[].expiresAtstring | null

installations[].keyLast4string | null

installations[].installationStatestring

installations[].identityStatusstring

installations[].retrievalStatestring

installations[].nextActionstring

sandboxActiveboolean

True when this Firebase user has an active isolated sandbox identity.

maskedKeystring

Display-only mask of the partner's live key (e.g. pk_live_a1b2c3d4...9f2e). Present when status is active. NOT a usable credential — sending it as a Bearer token returns 401. Use POST /api/v1/partner/session for a credential the portal can actually call with.

businessNamestring | null

emailstring | null

applicationSubmittedAtstring | null

When the partner application was submitted. Present for pending/approved/rejected states.

applicationRejectionReasonstring | null

Admin-provided rejection reason. Present when status is rejected.

Response codes

200Legacy partner account status, or workspace summary when workspace=1. Additional workspace fields are described above.

401Missing or invalid Firebase identity token.

403Email unverified, inactive membership or installation authorization denied.

500Admin service unavailable.

Request reference

Sandbox available

workspace Optional · query

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

https://mystocks.africa/api/sandbox/v1/partner/me

API Reference Authentication guide

Response schema

{
  "type": "object",
  "properties": {
    "deploymentPreference": {
      "type": "string",
      "enum": [
        "hosted",
        "onprem",
        "both"
      ],
      "description": "Present in workspace=1 summaries; preference does not grant authority."
    },
    "hosted": {
      "type": "object",
      "properties": {
        "status": {
          "type": "string"
        },
        "liveAllowed": {
          "type": "boolean"
        },
        "code": {
          "type": [
            "string",
            "null"
          ]
        },
        "nextAction": {
          "type": "string"
        },
        "keyLast4": {
          "type": [
            "string",
            "null"
          ]
        }
      }
    },
    "sandbox": {
      "type": "object",
      "properties": {
        "status": {
          "type": "string"
        },
        "nextAction": {
          "type": "string"
        }
      }
    },
    "environment": {
      "type": "object",
      "properties": {
        "liveAllowed": {
          "type": "boolean"
        },
        "status": {
          "type": "string"
        }
      }
    },
    "limit": {
      "type": "integer",
      "const": 50
    },
    "installations": {
      "type": "array",
      "maxItems": 50,
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "requestId": {
            "type": [
              "string",
              "null"
            ]
          },
          "domain": {
            "type": [
              "string",
              "null"
            ]
          },
          "status": {
            "type": "string"
          },
          "domainVerification": {
            "type": "string"
          },
          "licenseStatus": {
            "type": "string"
          },
          "accessLevel": {
            "type": "string"
          },
          "accessType": {
            "type": [
              "string",
              "null"
            ]
          },
          "expiresAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "keyLast4": {
            "type": [
              "string",
              "null"
            ]
          },
          "installationState": {
            "type": "string"
          },
          "identityStatus": {
            "type": "string"
          },
          "retrievalState": {
            "type": "string"
          },
          "nextAction": {
            "type": "string"
          }
        }
      }
    },
    "status": {
      "type": "string",
      "enum": [
        "active",
        "suspended",
        "pending",
        "approved",
        "rejected",
        "sandbox_active",
        "not_found"
      ]
    },
    "sandboxActive": {
      "type": "boolean",
      "description": "True when this Firebase user has an active isolated sandbox identity."
    },
    "maskedKey": {
      "type": "string",
      "description": "Display-only mask of the partner's live key (e.g. `pk_live_a1b2c3d4...9f2e`). Present when status is active. NOT a usable credential — sending it as a Bearer token returns 401. Use POST /api/v1/partner/session for a credential the portal can actually call with."
    },
    "businessName": {
      "type": [
        "string",
        "null"
      ]
    },
    "email": {
      "type": [
        "string",
        "null"
      ]
    },
    "applicationSubmittedAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "When the partner application was submitted. Present for pending/approved/rejected states."
    },
    "applicationRejectionReason": {
      "type": [
        "string",
        "null"
      ],
      "description": "Admin-provided rejection reason. Present when status is rejected."
    }
  }
}

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

GET /installations

POST /me