Skip to main content
POST
Create secure Apple Wallet pass

Authorizations

Authorization
string
header
required

API key authentication. Include your API key as a Bearer token.

Example: Bearer sk_prod_xxxxxx

Get your API key from the Stell Dashboard.

Body

application/json

Data for Apple secure pass with account binding.

programId
string
required

ID of the program to create pass for

Minimum string length: 1
creationSource
object

Detailed tracking of how the pass was created

templateOverrides
object

Template overrides for dynamic pass customization based on business logic (e.g., member tiers, promotions). All fields are optional.

payload
string

NFC or QR payload (defaults to pass ID if not provided)

externalId
string

External reference ID

semanticTagOverrides
object

Semantic tags for Apple Wallet passes: seating, flight, event and location details that Wallet and Siri use for suggestions. All fields are optional; send the ones that apply to your pass type.

membershipStatus
string

Merchant-defined account status (e.g., "Active", "Suspended", "On Hold")

Maximum string length: 255
customer
object

Customer information

Response

201 response

Apple secure pass creation response.

data
object
required

Created pass and its secure access URL

requestId
string
required

Unique request identifier for debugging

Pattern: ^[0-9A-Z]{26}$