API product catalogSub-Accounts & White-Label Retail KYC

List notification devices

Sub-Accounts & White-Label Retail KYC

GET

/users/{userId}/devices

Sandbox availablelistUserDevices

Lists mobile/web push devices registered for a sub-account. Tokens are never returned; only tokenLast4 is exposed for support correlation.

Parameters

userIdstringpathRequired

Example: usr_abc123

Headers

AuthorizationstringRequired

Bearer sk_sandbox_<your_key> for sandbox requests.

Response fields

devicesobject[]

devices[].deviceIdstring

Example: "dev_6f9a4d2c1b0e8a7c3d5f9012"

devices[].platformios | android | web

devices[].providerfcm | apns | expo | webpush

devices[].tokenLast4string

Last 4 characters of the token for support correlation.

devices[].appIdstring

devices[].localestring

devices[].timezonestring

devices[].externalDeviceIdstring

devices[].tagsstring[]

devices[].enabledboolean

devices[].statusactive | disabled | revoked

devices[].createdAtstring

devices[].updatedAtstring

devices[].lastSeenAtstring

countinteger

Response codes

200Registered notification devices.

Sandbox playground

Read-only sandbox request

userId Required · pathSandbox API keyYour key stays in this page’s memory.

https://mystocks.africa/api/sandbox/v1/partner/users/%7BuserId%7D/devices

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "properties": {
    "devices": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "deviceId": {
            "type": "string",
            "example": "dev_6f9a4d2c1b0e8a7c3d5f9012"
          },
          "platform": {
            "type": "string",
            "enum": [
              "ios",
              "android",
              "web"
            ]
          },
          "provider": {
            "type": "string",
            "enum": [
              "fcm",
              "apns",
              "expo",
              "webpush"
            ]
          },
          "tokenLast4": {
            "type": "string",
            "nullable": true,
            "description": "Last 4 characters of the token for support correlation."
          },
          "appId": {
            "type": "string",
            "nullable": true
          },
          "locale": {
            "type": "string",
            "nullable": true
          },
          "timezone": {
            "type": "string",
            "nullable": true
          },
          "externalDeviceId": {
            "type": "string",
            "nullable": true
          },
          "tags": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "enabled": {
            "type": "boolean"
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "disabled",
              "revoked"
            ]
          },
          "createdAt": {
            "type": "string",
            "nullable": true,
            "format": "date-time"
          },
          "updatedAt": {
            "type": "string",
            "nullable": true,
            "format": "date-time"
          },
          "lastSeenAt": {
            "type": "string",
            "nullable": true,
            "format": "date-time"
          }
        }
      }
    },
    "count": {
      "type": "integer"
    }
  }
}

curl -X GET 'https://mystocks.africa/api/sandbox/v1/partner/users/%7BuserId%7D/devices' \
  -H "Authorization: Bearer $MYSTOCKS_SANDBOX_API_KEY"

POST /users/{userId}/deposit

POST /users/{userId}/devices