Claim link

{
  "success": true,
  "data": {
    "external_id": "user_8412",
    "url": "https://id.cabalspy.xyz/claim/Zt3kV9...",
    "expires_at": "2026-10-27T08:04:11Z"
  },
  "meta": {
    "request_id": "req_5162c7cf7f87",
    "cached": false,
    "cache_age_seconds": 0,
    "version": "v1",
    "timestamp": "2026-10-26T08:04:11Z"
  }
}

{
  "success": true,
  "data": {
    "external_id": "user_8412",
    "url": "https://id.cabalspy.xyz/claim/Zt3kV9...",
    "expires_at": "2026-10-27T08:04:11Z"
  },
  "meta": {
    "request_id": "req_5162c7cf7f87",
    "cached": false,
    "cache_age_seconds": 0,
    "version": "v1",
    "timestamp": "2026-10-26T08:04:11Z"
  }
}

Creates a link that lets the person behind a platform user take their managed account into their own, normal CabalSpy ID. Send the link to the user, for example from their settings page on your platform. The link is valid for 24 hours and can be used once. Each call creates a new link.

What a claim does

The person opens the link on id.cabalspy.xyz, signs in with their own CabalSpy ID and confirms. Then:

their payment-verified wallets move to their own CabalSpy ID; unverified wallets do not move,
X and Telegram move along if their CabalSpy ID has none yet; their theses and Trade Feed move along too,
your instance keeps access to them as a user, csid_id becomes the id of their own account, and claimed turns true,
you receive the platform_user.claimed webhook with the previous csid_id.

From then on the person manages the account themselves. Calls that change it return account_claimed, and deleting the user only removes the link to your platform. The claim page refuses the claim when the person’s account would end up with more than 5 Solana or 5 EVM wallets, or when their account is already linked to another of your users. They see the reason on the page.

Claim links are off when your instance is marked white_label and on otherwise, until you set claim_links in the settings.

Body

string

required

Your id of the user. Alternatively pass csid_id.

string

Where the person goes back after the claim. Must be on one of your instance’s verified domains, registered origins or redirect URIs (https), or http://localhost.

Usage Example

curl -X POST "https://api-id.cabalspy.xyz/v1/platform-users/claim-link" \
  -H "Authorization: Bearer YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"external_id": "user_8412", "return_url": "https://app.example.com/settings"}'

import requests

r = requests.post("https://api-id.cabalspy.xyz/v1/platform-users/claim-link",
                  json={"external_id": "user_8412", "return_url": "https://app.example.com/settings"},
                  headers={"Authorization": "Bearer YOUR_KEY"})
print(r.json()["data"]["url"])

const res = await fetch("https://api-id.cabalspy.xyz/v1/platform-users/claim-link", {
  method: "POST",
  headers: { Authorization: "Bearer YOUR_KEY", "Content-Type": "application/json" },
  body: JSON.stringify({ external_id: "user_8412" }),
});
const { data } = await res.json();
console.log(data.url, data.expires_at);

Response

string

Your id of the user.

string

The claim link, on https://id.cabalspy.xyz/claim/....

string

When the link expires, 24 hours after it was created.

{
  "success": true,
  "data": {
    "external_id": "user_8412",
    "url": "https://id.cabalspy.xyz/claim/Zt3kV9...",
    "expires_at": "2026-10-27T08:04:11Z"
  },
  "meta": {
    "request_id": "req_5162c7cf7f87",
    "cached": false,
    "cache_age_seconds": 0,
    "version": "v1",
    "timestamp": "2026-10-26T08:04:11Z"
  }
}

Errors

Status	Code	Meaning
400	missing_parameter	external_id missing.
400	invalid_return_url	return_url is not on one of your instance’s sites.
401	missing_api_key	API key missing.
403	invalid_api_key	API key invalid or not enabled for CabalSpy ID.
403	claim_disabled	Claim links are off for your instance.
404	platform_user_not_found	No user with this id in your instance.
409	account_claimed	The account was already claimed.
429	rate_limit_exceeded	Rate limit exceeded.

See Errors for the full list.

Introduction

Login

Data API

Users

Trading

Theses

Streams

White-Label

Competitions

Reference

What a claim does

Body

Usage Example

Response

Errors

​What a claim does

​Body

​Usage Example

​Response

​Errors

What a claim does

Body

Usage Example

Response

Errors