โ† Docs/

API Reference

Authentication

All authenticated endpoints require a Bearer token in the Authorization header. Get your API key from the Partner Dashboard.

Authorization: Bearer YOUR_API_KEY
๐Ÿ”‘

Authentication

POST/api/auth/api-keyPublic

Exchange partner credentials for an API key.

Parameters

partner_idstringrequiredYour partner account ID
secretstringrequiredYour partner secret

Example

curl -X POST https://www.bosstag.co/api/auth/api-key \
  -H "Content-Type: application/json" \
  -d '{"partner_id": "your-id", "secret": "your-secret"}'
๐Ÿ“ฆ

Assets

GET/api/assets

List assets. Supports filtering by sector, status, and owner.

Parameters

sectorstringoptionalFilter by sector (collectibles, automotive, etc.)
statusstringoptionalFilter by status (verified, listed, sold)
limitnumberoptionalResults per page (max 100, default 20)
offsetnumberoptionalPagination offset
GET/api/assets/:id

Get a single asset by ID including verification status and metadata.

POST/api/assets

Create a new asset for digitization.

Parameters

titlestringrequiredAsset name or title
sectorstringrequiredAsset sector
descriptionstringoptionalDetailed description
estimated_valuenumberoptionalEstimated value in USD
metadataobjectoptionalSector-specific metadata
POST/api/assets/:id/verify

Submit an asset for AI verification via Boss Vision.

Parameters

imagesstring[]requiredArray of image URLs for verification
documentsstring[]optionalSupporting document URLs
๐Ÿช

Marketplace

GET/api/listingsPublic

Browse all active marketplace listings. Public endpoint.

Parameters

sectorstringoptionalFilter by sector
min_pricenumberoptionalMinimum price in USD
max_pricenumberoptionalMaximum price in USD
listing_typestringoptionalbuy-now or auction
POST/api/listings

Create a marketplace listing for a verified asset.

Parameters

asset_idstringrequiredID of verified asset to list
pricenumberrequiredListing price in USD
listing_typestringrequiredbuy-now or auction
๐Ÿ””

Webhooks

POST/api/partner/webhooks

Register a webhook endpoint to receive platform events.

Parameters

urlstringrequiredHTTPS endpoint to receive events
eventsstring[]requiredEvent types to subscribe to
secretstringoptionalSigning secret for HMAC verification

Example

// Verify webhook signature
const sig = req.headers['x-bosstag-signature'];
const expected = crypto
  .createHmac('sha256', YOUR_SECRET)
  .update(JSON.stringify(req.body))
  .digest('hex');
if (sig !== expected) throw new Error('Invalid signature');
๐Ÿท๏ธ

White-Label

POST/api/admin/white-label/tenants

Create a new white-label tenant deployment.

Parameters

namestringrequiredTenant display name
domainstringrequiredCustom domain (e.g. assets.yoursite.com)
themeobjectoptionalBrand colors and logo URLs
sectorsstring[]optionalEnabled sectors for this tenant
fee_pctnumberoptionalCustom platform fee percentage

Webhook Event Types

asset.createdasset.verifiedasset.listedasset.soldkyc.approvedkyc.rejecteddispute.fileddispute.resolvedtransfer.completed

Rate Limits

1000 / min

Read endpoints

100 / min

Write endpoints

20 / min

AI endpoints

Rate limit headers are included in every response: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.