Apple Parameters
Parameters organized by pass type. Each pass type has different image and field capabilities.
Coupon
For discounts, offers, and promotional passes. Supports strip image.
Appearance
brand.logo
file image (png)
The logo image displayed at the top of the pass. Recommended size: 160x50px @1x.
brand.text
string
default: Brand Text
Text displayed next to or below the logo. Typically the organization name.
label.color
string
default: #ffffff
Color used for field labels. Accepts hex color codes or rgb() values.
background.color
string
default: #000000
Background color of the pass. Accepts hex color codes or rgb() values.
foreground.color
string
default: #ffffff
Color used for field values and other text. Accepts hex color codes or rgb() values.
icon.link
file image (png)
The pass icon shown in notifications and on the lock screen. Required size: 29x29px @1x.
strip.image
file image (png)
A strip image displayed behind the primary fields. Recommended size: 375x144px @1x (760x294px @2x).
Header Fields
header.label
string
default: Header Label
Label text displayed above the header field value.
header.value
string
default: Header Value
Value displayed in the header field, shown at the top right of the pass.
Primary Fields
primary.label
string
default: Store Credit
Label text for the primary field. Often used for the offer description.
primary.value
string
default: $25.00
The main content displayed prominently on the pass. Typically the discount or offer amount.
Secondary Fields
secondary.0.label
string
default: To be used
Label for the first secondary field.
secondary.0.value
string
default: Any purchases
Value for the first secondary field.
secondary.1.label
string
default: Discount code
Label for the second secondary field.
secondary.1.value
string
default: SUMMER2025
Value for the second secondary field.
Auxiliary Fields
auxiliary.0.label
string
default: Valid in
Label for the first auxiliary field.
auxiliary.0.value
string
default: Miami
Value for the first auxiliary field.
auxiliary.1.label
string
default: Valid from
Label for the second auxiliary field.
auxiliary.1.value
string
default: October 1, 2023
Value for the second auxiliary field.
auxiliary.2.label
string
default: Valid until
Label for the third auxiliary field.
auxiliary.2.value
string
default: October 1, 2024
Value for the third auxiliary field.
Back Fields
back.label
string
default: More information
Label for the back field, shown when the pass is flipped.
back.value
string
Value for the back field. Supports data detectors for links, phone numbers, addresses, and calendar events.
Barcode
barcode.alt
string
Alternative text displayed below the barcode for manual entry.
barcode.data
string
The data encoded in the barcode. This value is scanned by barcode readers.
barcode.type
enum<string>
The barcode format to display on the pass.
Available options:
PKBarcodeFormatQR(2D square barcode, high data capacity)PKBarcodeFormatPDF417(2D stacked barcode, used for IDs and transport)PKBarcodeFormatCode128(1D barcode for alphanumeric data)
NFC
nfc.message
string
The message transmitted when the pass is tapped on an NFC reader. Maximum 64 bytes.
Locations
location.latitude
string
Latitude coordinate for the location-based notification trigger.
location.longitude
string
Longitude coordinate for the location-based notification trigger.
location.message
string
Message displayed when the user is near the location.
Dates
relevant.date
datetime
Date and time when the pass becomes relevant. The pass appears on the lock screen near this time. Format: ISO 8601.
expiration.date
datetime
Date and time when the pass expires. After this time, the pass is marked as expired. Format: ISO 8601.
Loyalty
For membership cards, rewards programs, and store cards. Supports strip image.
Appearance
brand.logo
file image (png)
The logo image displayed at the top of the pass. Recommended size: 160x50px @1x.
brand.text
string
default: Brand Text
Text displayed next to or below the logo. Typically the organization name.
label.color
string
default: #ffffff
Color used for field labels. Accepts hex color codes or rgb() values.
background.color
string
default: #000000
Background color of the pass. Accepts hex color codes or rgb() values.
foreground.color
string
default: #ffffff
Color used for field values and other text. Accepts hex color codes or rgb() values.
icon.link
file image (png)
The pass icon shown in notifications and on the lock screen. Required size: 29x29px @1x.
strip.image
file image (png)
A strip image displayed behind the primary fields. Recommended size: 375x144px @1x (760x294px @2x).
Header Fields
header.label
string
default: Membership
Label text displayed above the header field value.
header.value
string
default: Gold
Value displayed in the header field, shown at the top right of the pass. Often used for membership tier.
Primary Fields
primary.label
string
default: Member Name
Label text for the primary field.
primary.value
string
default: John Doe
The main content displayed prominently on the pass. Typically the member's name.
Secondary Fields
secondary.0.label
string
default: Member ID
Label for the first secondary field.
secondary.0.value
string
default: 1234567890
Value for the first secondary field.
secondary.1.label
string
default: Joined since
Label for the second secondary field.
secondary.1.value
string
default: October 1, 2023
Value for the second secondary field.
Auxiliary Fields
auxiliary.0.label
string
default: Reward points
Label for the first auxiliary field.
auxiliary.0.value
string
default: 410
Value for the first auxiliary field.
auxiliary.1.label
string
default: Points to go
Label for the second auxiliary field.
auxiliary.1.value
string
default: 10
Value for the second auxiliary field.
auxiliary.2.label
string
default: Last visit
Label for the third auxiliary field.
auxiliary.2.value
string
default: October 1, 2024
Value for the third auxiliary field.
Back Fields
back.label
string
default: More information
Label for the back field, shown when the pass is flipped.
back.value
string
Value for the back field. Supports data detectors for links, phone numbers, addresses, and calendar events.
Barcode
barcode.alt
string
Alternative text displayed below the barcode for manual entry.
barcode.data
string
The data encoded in the barcode. This value is scanned by barcode readers.
barcode.type
enum<string>
The barcode format to display on the pass.
Available options:
PKBarcodeFormatQR(2D square barcode, high data capacity)PKBarcodeFormatPDF417(2D stacked barcode, used for IDs and transport)PKBarcodeFormatCode128(1D barcode for alphanumeric data)
NFC
nfc.message
string
The message transmitted when the pass is tapped on an NFC reader. Maximum 64 bytes.
Locations
location.latitude
string
Latitude coordinate for the location-based notification trigger.
location.longitude
string
Longitude coordinate for the location-based notification trigger.
location.message
string
Message displayed when the user is near the location.
Dates
relevant.date
datetime
Date and time when the pass becomes relevant. The pass appears on the lock screen near this time. Format: ISO 8601.
expiration.date
datetime
Date and time when the pass expires. After this time, the pass is marked as expired. Format: ISO 8601.
Event Ticket
For concerts, sports events, movies, and flights.
Basic Event Ticket
Standard event ticket. Supports strip, thumbnail, and background images.
Appearance
brand.logo
file image (png)
The logo image displayed at the top of the pass. Recommended size: 160x50px @1x.
brand.text
string
default: Brand Text
Text displayed next to or below the logo. Typically the event organizer or venue name.
label.color
string
default: #ffffff
Color used for field labels. Accepts hex color codes or rgb() values.
background.color
string
default: #000000
Background color of the pass. Accepts hex color codes or rgb() values.
foreground.color
string
default: #ffffff
Color used for field values and other text. Accepts hex color codes or rgb() values.
icon.link
file image (png)
The pass icon shown in notifications and on the lock screen. Required size: 29x29px @1x.
strip.image
file image (png)
A strip image displayed behind the primary fields. Recommended size: 375x98px @1x for event tickets.
thumbnail.image
file image (png)
Event Ticket only
A thumbnail image displayed on the right side of the pass. Recommended size: 90x90px @1x (270x270px @3x). Typically used for artist/performer photos or event logos.
background.image
file image (png)
Event Ticket only
Background image for the pass. The image is blurred and used as a backdrop behind the pass content. Recommended size: 180x220px @1x.
Header Fields
header.label
string
default: Info on back
Label text displayed above the header field value.
header.value
string
default: →
Value displayed in the header field, shown at the top right of the pass.
Primary Fields
primary.label
string
default: Event
Label text for the primary field.
primary.value
string
default: Event Name
The main content displayed prominently on the pass. Typically the event name or title.
Secondary Fields
secondary.0.label
string
default: Date
Label for the first secondary field.
secondary.0.value
string
default: August 16, 2025
Value for the first secondary field.
secondary.1.label
string
default: Time
Label for the second secondary field.
secondary.1.value
string
default: 8:00 PM
Value for the second secondary field.
Auxiliary Fields
auxiliary.0.label
string
default: Venue
Label for the first auxiliary field.
auxiliary.0.value
string
default: Venue Name
Value for the first auxiliary field.
auxiliary.1.label
string
default: Gate
Label for the second auxiliary field.
auxiliary.1.value
string
default: 1
Value for the second auxiliary field.
auxiliary.2.label
string
default: Section
Label for the third auxiliary field.
auxiliary.2.value
string
default: A
Value for the third auxiliary field.
auxiliary.3.label
string
default: Row
Label for the fourth auxiliary field.
auxiliary.3.value
string
default: 1
Value for the fourth auxiliary field.
auxiliary.4.label
string
default: Seat
Label for the fifth auxiliary field.
auxiliary.4.value
string
default: 1
Value for the fifth auxiliary field.
Back Fields
back.label
string
default: More information
Label for the back field, shown when the pass is flipped.
back.value
string
Value for the back field. Supports data detectors for links, phone numbers, addresses, and calendar events.
Barcode
barcode.alt
string
Alternative text displayed below the barcode for manual entry.
barcode.data
string
The data encoded in the barcode. This value is scanned by barcode readers.
barcode.type
enum<string>
The barcode format to display on the pass.
Available options:
PKBarcodeFormatQR(2D square barcode, high data capacity)PKBarcodeFormatPDF417(2D stacked barcode, used for IDs and transport)PKBarcodeFormatCode128(1D barcode for alphanumeric data)
NFC
nfc.message
string
The message transmitted when the pass is tapped on an NFC reader. Maximum 64 bytes.
Locations
location.latitude
string
Latitude coordinate for the location-based notification trigger.
location.longitude
string
Longitude coordinate for the location-based notification trigger.
location.message
string
Message displayed when the user is near the location.
Dates
relevant.date
datetime
Date and time when the pass becomes relevant. The pass appears on the lock screen near this time. Format: ISO 8601.
expiration.date
datetime
Date and time when the pass expires. After this time, the pass is marked as expired. Format: ISO 8601.
Advanced Event Ticket (Poster) iOS 18+ beta
Enhanced event ticket with rich media, venue maps, and additional event information. Requires iOS 18+.
Appearance
primary.logo
file image (png)
Primary logo displayed prominently on the poster pass. Used for home team or main performer.
secondary.logo
file image (png)
Secondary logo for the poster pass. Used for away team or supporting performer.
artwork.image
file image (png)
Main artwork image for the event poster. Recommended size: 1170x1464px (3:4 aspect ratio).
venue.image
file image (png)
Venue map or seating chart image displayed in the event guide view.
brand.logo
file image (png)
Brand logo displayed at the top of the pass. Recommended size: 160x50px @1x.
brand.text
string
default: Brand Text
Brand name or organization text displayed with the logo.
icon.link
file image (png)
required
Pass icon for notifications and lock screen. Required size: 29x29px @1x.
label.color
string
default: #ffffff
Color for field labels. Accepts hex color codes or rgb() values.
background.color
string
default: #000000
Background color of the pass. Accepts hex color codes or rgb() values.
foreground.color
string
default: #ffffff
Color for field values and text. Accepts hex color codes or rgb() values.
Event Details
event.type
enum<string>
The type of event for the poster ticket.
Available options:
PKEventTypeGeneric(general purpose event type)PKEventTypeLivePerformance(concerts, theater, live shows)PKEventTypeMovie(film screenings and cinema events)PKEventTypeSports(sporting events and matches)PKEventTypeConference(professional conferences and summits)PKEventTypeConvention(fan conventions and expos)PKEventTypeWorkshop(educational workshops and classes)PKEventTypeSocialGathering(parties and social events)
event.name
string
The name of the event displayed on the pass.
venue.region.name
string
The region or city where the venue is located.
venue.name
string
The name of the venue hosting the event.
event.live.message
string
Message displayed during the live event (e.g., "Event in progress").
admission.level
string
The admission or ticket level (e.g., "VIP", "General Admission").
event.start.date
datetime
Event start date and time. Format: ISO 8601.
event.end.date
datetime
Event end date and time. Format: ISO 8601.
gates.open.date
datetime
When venue gates open for entry. Format: ISO 8601.
Venue Location Info
venue.latitude
string
Latitude coordinate of the venue for maps and location-based notifications.
venue.longitude
string
Longitude coordinate of the venue for maps and location-based notifications.
location.message
string
Message shown when user is near the venue location.
Event Guide View
entrance.description
string
Description of the venue entrance to use (e.g., "Use Gate B on West Side").
album.ids
string
Comma-separated Apple Music album IDs for event-related music.
appstore.id
string
App Store ID for the event's associated iOS app.
Action Panel
footer.mode
enum<string>
Display mode for the footer action panel.
Available options:
none(no action panel displayed)barcode(displays barcode for scanning)nfc(enables tap-to-pay NFC functionality)both(displays both barcode and NFC options)
seat.section
string
Section designation for the seat (e.g., "Section 101").
seat.row
string
Row number or letter for the seat.
seat.number
string
Specific seat number within the row.
seat.identifier
string
Unique identifier for the seat in the venue system.
seat.description
string
Additional description for the seating area.
seat.type
string
Type of seating (e.g., "Floor", "Balcony", "Box").
attendee.name
string
Name of the ticket holder or attendee.
Additional Info Fields
additional.0.label
string
Label for the additional info field displayed in the event guide.
additional.0.value
string
Value text for the additional info field.
additional.0.dataDetectorType
enum<string>
Type of data detector for the attributed value.
Available options:
link(tappable URL that opens in Safari)phone(tappable phone number that initiates a call)address(tappable address that opens in Maps)calendar(tappable date that creates a calendar event)
additional.0.attributedValue
string
The URL, phone number, address, or date for tappable content.
Actions
merchandise.url
string
URL for event merchandise store.
contact.phone
string
Contact phone number for event support.
contact.email
string
Contact email address for event support.
contact.url
string
URL for event contact or support page.
directions.url
string
URL for venue directions (opens in Maps).
parking.url
string
URL for parking information.
bagpolicy.url
string
URL for venue bag policy information.
orderfood.url
string
URL for in-venue food ordering.
accessibility.url
string
URL for accessibility information.
addon.url
string
URL for purchasing add-on experiences.
purchaseparking.url
string
URL for purchasing parking passes.
transit.url
string
URL for public transit information to the venue.
sell.url
string
URL to resell or transfer the ticket.
transfer.url
string
URL to transfer the ticket to another person.
Performer Info
performer.names
string
Comma-separated list of performer or artist names.
artist.ids
string
Comma-separated Apple Music artist IDs for performer links.
Sports Info
sports.home.abbrev
string
Abbreviation for the home team (e.g., "NYY", "LAL").
sports.away.abbrev
string
Abbreviation for the away team (e.g., "BOS", "GSW").
Movie Info
movie.title
string
Title of the movie.
movie.genre
string
Genre of the movie (e.g., "Action", "Comedy").
movie.rating
string
Movie rating (e.g., "PG-13", "R").
Venue Info
venue.room
string
Specific room or hall within the venue.
Relevant Dates
relevant.0.start
datetime
Start of the time range when the pass becomes relevant. Format: ISO 8601.
relevant.0.end
datetime
End of the time range when the pass is relevant. Format: ISO 8601.
NFC
nfc.message
string
Message transmitted when the pass is tapped on an NFC reader. Maximum 64 bytes. If empty, the pass defaults to Barcode if set to anything other than none.
Barcode
barcode.alt
string
Alternative text displayed below the barcode for manual entry.
barcode.data
string
The data encoded in the barcode. This value is scanned by barcode readers.
barcode.type
enum<string>
The barcode format to display on the pass.
Available options:
PKBarcodeFormatQR(2D square barcode, high data capacity)PKBarcodeFormatPDF417(2D stacked barcode, used for IDs and transport)PKBarcodeFormatCode128(1D barcode for alphanumeric data)
Access Control
For employee badges, visitor passes, and ID cards. Supports thumbnail image.
Appearance
brand.logo
file image (png)
The logo image displayed at the top of the pass. Recommended size: 160x50px @1x.
brand.text
string
default: Brand Text
Text displayed next to or below the logo. Typically the organization name.
label.color
string
default: #ffffff
Color used for field labels. Accepts hex color codes or rgb() values.
background.color
string
default: #000000
Background color of the pass. Accepts hex color codes or rgb() values.
foreground.color
string
default: #ffffff
Color used for field values and other text. Accepts hex color codes or rgb() values.
icon.link
file image (png)
The pass icon shown in notifications and on the lock screen. Required size: 29x29px @1x.
thumbnail.image
file image (png)
Access Control only
A thumbnail image displayed on the right side of the pass. Recommended size: 90x90px @1x (270x270px @3x) or 2:3 aspect ratio. Typically used for employee photos or ID portraits.
Header Fields
header.label
string
default: Info on back
Label text displayed above the header field value.
header.value
string
default: →
Value displayed in the header field, shown at the top right of the pass.
Primary Fields
primary.label
string
default: Employee ID
Label text for the primary field.
primary.value
string
default: John Doe
The main content displayed prominently on the pass. Typically the person's name.
Secondary Fields
secondary.0.label
string
default: Campus
Label for the first secondary field.
secondary.0.value
string
default: Miami
Value for the first secondary field.
secondary.1.label
string
default: Department
Label for the second secondary field.
secondary.1.value
string
default: Engineering
Value for the second secondary field.
Auxiliary Fields
auxiliary.0.label
string
default: Building
Label for the first auxiliary field.
auxiliary.0.value
string
default: 123
Value for the first auxiliary field.
auxiliary.1.label
string
default: Floor
Label for the second auxiliary field.
auxiliary.1.value
string
default: 4
Value for the second auxiliary field.
auxiliary.2.label
string
default: Room
Label for the third auxiliary field.
auxiliary.2.value
string
default: 101
Value for the third auxiliary field.
Back Fields
back.label
string
default: More information
Label for the back field, shown when the pass is flipped.
back.value
string
Value for the back field. Supports data detectors for links, phone numbers, addresses, and calendar events.
Barcode
barcode.alt
string
Alternative text displayed below the barcode for manual entry.
barcode.data
string
The data encoded in the barcode. This value is scanned by barcode readers.
barcode.type
enum<string>
The barcode format to display on the pass.
Available options:
PKBarcodeFormatQR(2D square barcode, high data capacity)PKBarcodeFormatPDF417(2D stacked barcode, used for IDs and transport)PKBarcodeFormatCode128(1D barcode for alphanumeric data)
NFC
nfc.message
string
The message transmitted when the pass is tapped on an NFC reader. Maximum 64 bytes.
Locations
location.latitude
string
Latitude coordinate for the location-based notification trigger.
location.longitude
string
Longitude coordinate for the location-based notification trigger.
location.message
string
Message displayed when the user is near the location.
Dates
relevant.date
datetime
Date and time when the pass becomes relevant. The pass appears on the lock screen near this time. Format: ISO 8601.
expiration.date
datetime
Date and time when the pass expires. After this time, the pass is marked as expired. Format: ISO 8601.