---
title: "Issue a signed Apple Wallet pass"
method: POST
path: "/api/v1/passes/apple-wallet"
tags: ["Passes", "Engage"]
---

# Issue a signed Apple Wallet pass

`POST /api/v1/passes/apple-wallet`

## Request

- Base URL: `https://app.d-sports.org`
- URL: `https://app.d-sports.org/api/v1/passes/apple-wallet`
- Auth: HTTP bearer

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.

## Request body

- object
  - `passKind` 'fan_id' | 'club_membership' | 'arena_event'
  - `teamId` string
  - `gameId` string
  - `format` 'binary' | 'base64'

## Response `200`

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

- AppleWalletPassBase64Success
  - `success` true, required
  - `data` AppleWalletPassBase64, required
    - `passTypeIdentifier` string, required
    - `serialNumber` string, required
    - `passKind` 'fan_id' | 'club_membership' | 'arena_event', required
    - `contentType` 'application/vnd.apple.pkpass', required
    - `filename` string, required
    - `pkpassBase64` string, byte, required

## Other responses

- `400`: VALIDATION_ERROR (invalid JSON, unknown field, or teamId missing for club_membership)
- `401`: UNAUTHORIZED
- `403`: FORBIDDEN (club_membership pass for a non-partner club, or a partner club the caller has not joined)
- `404`: NOT_FOUND (team or game not found)
- `413`: PAYLOAD_TOO_LARGE (body over 4 KB)
- `503`: CONFIGURATION_ERROR (pass signing not configured)

## Changes

- **2026-11-21** `300d0b9a863b`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/d-sports-ecosystem/apis/d-sports-api/changes/api/v1/passes/apple-wallet/post.md)

---

[API](https://skmtc.dev/d-sports-ecosystem/apis/d-sports-api.md) - [All operations](https://skmtc.dev/d-sports-ecosystem/apis/d-sports-api/llms.txt) - [OpenAPI document](https://skmtc.dev/d-sports-ecosystem/apis/d-sports-api/revisions/63735cf90a04?raw)
