Environments & authentication

API environmentsCopy Anchor Link

Use the credentials issued for the selected environment. Retrieve payment parameters from the API for each purchase; do not hardcode a treasury address, token mint, or memo.

Server authenticationCopy Anchor Link

Every partner API request uses this header:

Authorization: Bearer <your_partner_api_key>

Store the key in a server-side environment variable or secret manager. A missing, invalid, or disabled key returns 401 PLATFORM_KEY_INVALID. Ask Verity to rotate a lost or exposed key.

The documentation does not require login. API calls do.

Identify each buyerCopy Anchor Link

Send a stable external_user_ref with purchases. This is your own account identifier, scoped to your platform.

• Use an opaque ID such as buyer_123; avoid emails and other personal details.
• Keep it stable across purchases, prizes, and notifications.
• Use 1–255 characters with no leading or trailing whitespace.
• URL-encode it when it appears in a request path.

An optional display_name can contain 1–64 characters, or be null. It may be shown publicly alongside draw results; use a name the buyer expects others to see.

Response formatCopy Anchor Link

{"success":true,"data":{"items":[],"total":0}}

{"success":false,"error":"PLATFORM_KEY_INVALID"}

Check both HTTP status and the error code. Validation errors can include details. Allow additional response fields so an additive API update does not break your integration.

Wallet authentication for redemptionCopy Anchor Link

Redemption is optional and uses a separate wallet session at /api/v1/redeem. Your partner API key does not authorize shipping on a buyer's behalf. See Prize redemption.