API product catalogSub-Accounts & White-Label Retail KYC

Revoke notification device

Sub-Accounts & White-Label Retail KYC

DELETE

/users/{userId}/devices/{deviceId}

Sandbox availablerevokeUserDevice

Soft-revokes a registered push device. The record is retained for audit and support correlation.

Parameters

userIdstringpathRequired

Example: usr_abc123

deviceIdstringpathRequired

Example: dev_6f9a4d2c1b0e8a7c3d5f9012

Headers

AuthorizationstringRequired

Bearer sk_sandbox_<your_key> for sandbox requests.

Idempotency-KeystringheaderRequired

Unique string that makes write calls safe to retry on network failure. Required for money movement, trading, KYC, subscriptions, and webhook creation. Deduplicated for 24 hours -- duplicate keys return the cached response. HTTP 409 if a concurrent request with the same key is still in progress.

Example: dep_user42_1743152580

Response fields

messagestring

subAccountIdstring

externalIdstring

deviceIdstring

statusstring

Example: "revoked"

Response codes

200Device revoked.

404Device not found.

Request reference

Sandbox available

userId Required · pathdeviceId Required · path

Use the API Tester for write requests, including request bodies and idempotency keys.

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

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "subAccountId": {
      "type": "string"
    },
    "externalId": {
      "type": "string"
    },
    "deviceId": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "example": "revoked"
    }
  }
}

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

POST /users/{userId}/devices

GET /users/{userId}/dividends