Passes
Engage

Issue a signed Apple Wallet pass

Changed on

Authenticated. Issues a signed Apple Wallet .pkpass for the caller (pass type pass.com.dsports.wallet). passKind is fan_id (default), club_membership (teamId required; only for an Engage partner club the caller has joined, else 403) or arena_event (gameId and/or teamId). format binary (default) returns application/vnd.apple.pkpass bytes as an attachment; format base64 returns { success, data: { passTypeIdentifier, serialNumber, passKind, contentType, filename, pkpassBase64 } } for PKAddPassesViewController. Both responses send Cache-Control: no-store. The body is capped at 4 KB. Returns 503 CONFIGURATION_ERROR until the pass signing certificates are configured on the server.

post/api/v1/passes/apple-wallet

Request

  • Base URL
    https://app.d-sports.org
  • Auth
    HTTP bearer

Request body

passKind'fan_id' | 'club_membership' | 'arena_event'
teamIdstring
gameIdstring
format'binary' | 'base64'

Response

Signed pass: application/vnd.apple.pkpass bytes (format binary) or { success, data: { pkpassBase64, ... } } (format base64)

successtrue required

Changes