Partners
API referenceEndpointsRaffles

A buyer's prizes, with buyback and redeem state

GET
/users/{externalUserRef}/prizes

Your buyer's prize history across your raffles, newest first, including bought-back and redeemed prizes. An unknown reference returns an empty array. References are scoped to your platform. Use redeemable and redeem_blocked_reason for shipping eligibility; the wallet API checks current ownership before preparing payment. Partner buyback is currently unavailable. A non-null amount or expiry does not override buyback.eligible=false. Refresh when the buyer opens their prizes or receives prize.won.

Authorization

PartnerApiKey
headerAuthorizationBearer <token>

Authorization: Bearer <your_api_key>

Keep this credential on your server, never in browser or mobile app code. A missing, invalid or disabled key returns 401 PLATFORM_KEY_INVALID. Ask Verity to replace a lost or exposed key.

Path Parameters

externalUserRef*string

The buyer's external_user_ref.

Response Body

OK

application/json
  1. response
success*boolean
data*array<>
Example Request
curl -X GET 'https://api-staging.theverity.xyz/api/v1/platform/users/usr_8812/prizes' \  -H 'Authorization: Bearer <your_partner_api_key>'
Example Response
{  "success": true,  "data": [    {      "id": 0,      "raffle_id": 0,      "raffle_name": "string",      "prize_item": {        "name": "string",        "description": "string",        "category": "string",        "market_value_usd": 0,        "image_urls": [          "string"        ]      },      "won_at": "2019-08-24T14:15:22Z",      "distributed_at": "2019-08-24T14:15:22Z",      "distribution_status": "string",      "mint_status": "pending",      "mint_address": "string",      "redeemable": true,      "can_ship_now": true,      "redeem_blocked_reason": "VALUE_EXCEEDS_LIMIT",      "redemption": {        "id": 0,        "status": "string",        "tracking_number": "string"      },      "buyback": {        "enabled": true,        "rate_pct": 0,        "amount_usd": 0,        "deadline": "2019-08-24T14:15:22Z",        "bought_back_at": "2019-08-24T14:15:22Z",        "amount_paid_usd": 0,        "eligible": true      }    }  ]}