Skip to main content
Read and change the White-Label settings of your instance. A POST changes only the settings you pass and returns all of them. See Settings in the overview for what each one does. The same settings are on the instance’s White-label tab in the dashboard. Saving them there always sends all of them.

Read the settings

GET /v1/platform-users/settings

Change the settings

POST /v1/platform-users/settings
boolean
Dashboard: No CabalSpy ID branding. The verify widget, the embedded Theses and Trade Feed widgets and the Telegram messages your users get show your platform instead of CabalSpy ID. Default false.
string
Dashboard: Where your users’ data is visible. csid (default): your users are part of the CabalSpy ID network: profiles, leaderboard, Trade Feed and theses. platform: only your instance sees them, nothing appears on CabalSpy ID’s public pages or other platforms.
string
Dashboard: Wallets that count. all: unverified wallets you send count for data, profiles and leaderboards. verified_only: only payment-verified wallets count; unverified ones get the status needs_verification.
string
Dashboard: Leaderboard. all or verified_only: which wallets the platform leaderboard ranks. trust=verified on the leaderboard request can only narrow it further.
boolean
Dashboard: Telegram alerts for your users. Trade Feed alerts through the CabalSpy ID Telegram bot for platform users who linked Telegram.
boolean
Older form of data_scope: true is csid, false is platform.
Unknown settings are refused with invalid_parameter, which lists the allowed ones.

Response

string
The instance’s name.
boolean
White-label flag.
string
csid or platform.
boolean
The same as data_scope, as a boolean.
string
all or verified_only.
string
all or verified_only.
boolean
Telegram alerts on or off.
object
enabled and last_event_at of the inbound URL.

Errors

See Errors for the full list.