Skip to main content
POST
/
api
/
v1
/
wallets
/
pairs
/
initiate
Initiate wallet pairing
import requests

url = "https://api.example.com/api/v1/wallets/pairs/initiate"

payload = { "wallet_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a" }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
{
  "result": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "wallet_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "claimer_principal_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "agent_principal_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "token": "<string>",
    "status": "pending",
    "expires_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "pair_link": "<string>"
  },
  "success": true,
  "suggestion": "",
  "message": "",
  "meta": {
    "total": 123,
    "offset": 123,
    "limit": 123,
    "has_more": true,
    "after": "<string>",
    "before": "<string>"
  }
}

Headers

X-API-Key
string | null

Body

application/json

Request payload for an agent to generate a wallet pairing token.

wallet_id
string<uuid>
required

The ID of the wallet to pair.

Response

Already exists (idempotent). Successful Response

result
WalletPairInitiateRead · object
required

Wallet pairing initiate response payload.

success
boolean
default:true
suggestion
string
default:""
message
string
default:""
meta
PaginationMeta · object

Pagination metadata for list responses.

Supports both legacy offset-based and cursor-based pagination. Cursor fields (has_more, after, before) are populated for cursor-paginated endpoints. Legacy fields (offset, limit) are populated when the caller uses the deprecated offset parameter.