Quickstart

Prerequisites

A Passform account - sign up at app.passform.io
An API key from your account dashboard

Step 1: Get your API key

Log in to app.passform.io, navigate to Settings → API Keys, and create a new key. You’ll use this as a Bearer token on every request.

Step 2: Create a template

A template defines the appearance of your pass. Create one by uploading images and setting colors via the dashboard or API.

curl -X POST https://api.passform.io/v1/templates/my-first-template \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "My First Pass",
    "issuerName": "Acme Co",
    "type": "offer",
    "foregroundColor": "#FFFFFF",
    "backgroundColor": "#1a1a2e",
    "icon": "https://example.com/icon.png",
    "logo": "https://example.com/logo.png",
    "banner": "https://example.com/banner.png",
    "fields": [
      { "key": "discount", "label": "Discount", "value": "20% off" }
    ]
  }'

Step 3: Issue a pass

With a template in place, create a pass instance:

curl -X POST https://api.passform.io/v1/pass/my-first-template \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "expiry": "2026-12-31T23:59:59Z",
    "validFrom": null,
    "voided": false
  }'

The response includes distribution URLs for each delivery format:

appleUrl - direct Apple Wallet download for iPhone users
googleUrl - Google Wallet save URL for Android users
webUrl - a browser-friendly pass viewer for users on desktop or devices without a wallet app installed

Use the right URL for the user’s device, or present all three options in your own UI.

Step 4: Update a pass or template

Once a pass has been issued, you can either update the individual pass data or update the template to change shared design and content across every pass issued from it. See the Updating passes guide for pass-level and template-level update examples.

Getting started

Guides

Integrations

Prerequisites

Step 1: Get your API key

Step 2: Create a template

Step 3: Issue a pass

Step 4: Update a pass or template

Next steps

API reference

Support

​Prerequisites

​Step 1: Get your API key

​Step 2: Create a template

​Step 3: Issue a pass

​Step 4: Update a pass or template

​Next steps

API reference

Support

Prerequisites

Step 1: Get your API key

Step 2: Create a template

Step 3: Issue a pass

Step 4: Update a pass or template

Next steps