Get pair info by token

This operation retrieves pairing information by the 8-digit pairing code, including the agent and wallet details. pair tokens are not owner-bound before confirmation and may be queried with the code alone, while restore tokens require the caller to be the owner bound when the restore code was generated.

GET /api/v1/wallets/pairs/{token}

Get pair info by token

Python

import requests

url = "https://api.example.com/api/v1/wallets/pairs/{token}"

response = requests.get(url)

print(response.text)

200

{
  "result": {
    "token_status": "valid",
    "token_purpose": "pair",
    "token": "<string>",
    "agent": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "external_id": "<string>"
    },
    "wallet": {
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "wallet_type": "Custodial",
      "name": "<string>",
      "status": "preparing"
    }
  },
  "success": true,
  "suggestion": "",
  "message": "",
  "meta": {
    "total": 123,
    "offset": 123,
    "limit": 123,
    "has_more": true,
    "after": "<string>",
    "before": "<string>"
  }
}

Headers

X-API-Key · string | null

Path Parameters

token · string · required

Response

200

application/json

Successful Response

result · WalletPairInfoRead · object · required

Pair info response. Agent and wallet are only present when token is valid.

Show child attributes

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.

Show child attributes