REST API Reference & SDKs

Passinstance Developer Documentation

Build high-volume Apple Wallet (.pkpass) and Google Wallet integrations. Issue, update, scan, and broadcast real-time lockscreen notifications via production-grade REST APIs.

Get API Keys

Developer Docs/Batch Operations

REST API v1

All API Reference Passes Templates Scanner & Devices Push & Delivery Webhooks Batch Operations

POSThttps://api.passinstance.com/api/v1/api-keys

Bearer

Generate API Key

Generate a scoped API key (pi_live_ or pi_test_) for secure server-to-server integration.

CreateApiKeyDto configuration for key name, environment (test/live), and permissions scopes.

Request Body1 required • 3 optional

namestring

Required

Human-readable label for this key (max 100 chars).

example: Mobile App Integration Key

Response Status Codes

201Created

ApiResponseDto containing the raw secret key (displayed only once).

POSThttps://api.passinstance.com/api/v1/batch-pass-operations/create

Bearer

Bulk issue passes

Issue multiple wallet passes in an atomic batch operation with validation and failure reporting.

BatchPassCreationDto containing array of pass configurations.

Request Body1 required

passesarray of objects

Required

Array of pass items with templateId, barcodeValue, and additionalData.

example: [
  {
    "templateId": "tpl_8f2a1e0b-3c4d-4e5f-9a1b-2c3d4e5f6a7b",
    "barcodeValue": "BULK-001",
    "additionalData": { "name": "Member #001" }
  },
  {
    "templateId": "tpl_8f2a1e0b-3c4d-4e5f-9a1b-2c3d4e5f6a7b",
    "barcodeValue": "BULK-002",
    "additionalData": { "name": "Member #002" }
  }
]

Response Status Codes

201Created

ApiResponseDto<BatchPassResult> containing summary and created pass records.

POST/api-keys

API Keys

Request

curl -X POST https://api.passinstance.com/api/v1/api-keys \
  -H "Authorization: Bearer <YOUR_DASHBOARD_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Mobile App Integration Key",
    "environment": "live",
    "scopes": ["passes", "templates", "scans"]
  }'

Response

CreatedApiResponseDto containing the raw secret key (displayed only once).

{
  "success": true,
  "data": {
    "id": "key_7c9a8b1d-4e2f-4a3b-9c0d-1e2f3a4b5c6d",
    "name": "Mobile App Integration Key",
    "key": "pi_live_9f8e7d6c5b4a3f2e1d0c9b8a7f6e5d4c3b2a1",
    "prefix": "pi_live_",
    "environment": "live",
    "scopes": [
      "passes",
      "templates",
      "scans"
    ],
    "lastUsedAt": null,
    "expiresAt": null,
    "createdAt": "2026-08-21T20:30:00.000Z"
  },
  "description": "API key generated successfully. Save this secret key now.",
  "errors": [],
  "statusCode": 201
}

Envelope: ApiResponseDto<T>HTTPS (TLS 1.3)