Skip to main content
POST
Exchange a fan experience launch token
Required scope
  • read:experience — Exchange a fan’s experience token for the resolved experience and the fan’s identity, so an embedded fan-facing experience can render the right content.

Authorizations

Authorization
string
header
required

OAuth 2.0 access token, presented as a JWT bearer token in the Authorization header. Obtain a token via the authorization-code flow; the scopes granted to the token determine which operations it may call.

Headers

X-Fanvue-API-Version
string
default:2025-06-26
required

API version to use for the request

Example:

"2025-06-26"

Body

application/json
token
string
required

The opaque experience launch token appended to the surface iframe URL.

Minimum string length: 1
Example:

"exp_2f1c…"

Response

The resolved experience, fan identity, and entitlement

experience
object
required
fanUuid
string<uuid>
required
entitlement
object
required
walletBalance
integer | null
required

The fan's Fanvue wallet balance in minor units (cents, USD), so you can show their spending power as the surface loads. null when the wallet is not available to this fan at all, which is not the same as an empty balance — do not offer a wallet charge then. A snapshot, never an authorisation: charge with POST /experiences/{experienceUuid}/action-purchases and read the fresh balance off that response.

Example:

2500