Skip to content
Help Center Guide
3 min readVerified 2026-11-16

Data Exports & Reporting

Export filtered pass lists and analytics via CSV downloads, automated FTP/SFTP uploads, or REST reporting endpoints.

In This Guide

Overview

Passinstance provides streaming data export endpoints across every core operational domain—including pass instances (POST /api/v1/passes/export), validation scan histories, scanner device keys, executive dashboard reports, VAT tax invoices, GDPR data-subject archives, and compliance audit logs (GET /api/v1/audit-log/export.csv or in the Dashboard at /settings/workspace/developer/audit-logs). All exports are scoped strictly to your authenticated workspace (Customer) and streamed with standard MIME headers for immediate consumption by spreadsheet software, ERP pipelines, or SIEMS.

Multi-Domain Data Export Architecture

SYSTEM ARCHITECTURE FLOW
INTERACTIVE ARCHITECTURE
STREAMING DATA EXPORT & COMPLIANCE ENGINE
STAGE 01 CLIENT & AUTOMATION REQUEST LAYER
Dashboard Export UI
(Filtered Table Views)
Scheduled BI / ERP Job
(x-api-key / Bearer)
Compliance & Legal
(GDPR DSR & Audit)
STAGE 02 PASSINSTANCE EXPORT CONTROLLERS (API)
Operational Exports (UTF-8 CSV)
POST/api/v1/passes/export
GET/api/v1/validation/scans/*
GET/api/v1/dashboards/export
Financial & Compliance Exports
GET/api/v1/billing/invoices/*
POST .../data-subject-export
GET/api/v1/audit-log/export.csv
STAGE 03 OUTPUT FORMATS & DESTINATIONS
text/csv; charset=utf8
RFC 4180 Escaped Rows (Passes, Scans, Keys)
application/pdf
Itemized Tax Invoices
& Dashboard Snapshots
application/json
GDPR Archives &
Dashboard JSON

Important: Exported CSV and JSON files frequently contain passholder Personally Identifiable Information (PII) such as names, email addresses, externalId values, and transaction histories. Always store and purge downloaded exports in accordance with your organization's Data Privacy & GDPR retention policies.

Complete Catalog of Export Endpoints

Pass Instances
POST
Endpoint Path
/api/v1/passes/export
Output Formats (Content-Type)
text/csv; charset=utf-8
Description
Streams CSV rows (passes-export.csv) for an explicit list of up to 2000 UUIDs (request payload: { passIds, format: "csv" }).
Config Scan History
GET
Endpoint Path
/api/v1/validation/configs/:id/scans/export
Output Formats (Content-Type)
text/csv; charset=utf-8
Description
Exports scan events and mechanic redemptions scoped to a single ScannerConfiguration.
Workspace Scans
GET
Endpoint Path
/api/v1/validation/scans/export
Output Formats (Content-Type)
text/csv; charset=utf-8
Description
Exports workspace-wide validation scan history across all configurations.
Scan Audit Trail
GET
Endpoint Path
/api/v1/validation/scan-results/export/csv
Output Formats (Content-Type)
text/csv; charset=utf-8
Description
Full granular scan result audit trail including decision, reasonCode, operator ID, and balance effects.
Scanner Device Keys
GET
Endpoint Path
/api/v1/validation/configs/:id/scanner-keys/export/csv
Output Formats (Content-Type)
text/csv; charset=utf-8
Description
Inventory of issued scanner keys, pairing statuses, expiration dates, and device telemetry metadata.
Dashboard Summary
GET
Endpoint Path
`/api/v1/dashboards/export?format=csv\
HTTP Verb
json\
Output Formats (Content-Type)
pdf`
Batch Job Output
GET
Endpoint Path
/api/v1/batch-processing/:id/result.csv
Output Formats (Content-Type)
text/csv; charset=utf-8
Description
Downloads processed output rows from an asynchronous batch creation or update job.
Billing Invoices
GET
Endpoint Path
/api/v1/billing/invoices/:id/download
Output Formats (Content-Type)
application/pdf
Description
Streams the official itemized tax/VAT invoice PDF for a specific billing cycle.
GDPR Data Subject
POST
Endpoint Path
/api/v1/customer/:customerId/privacy-settings/data-subject-export
Output Formats (Content-Type)
application/json
Description
Generates a structured GDPR Article 15/20 portability payload (IDataSubjectExportPayload) matching request payload.query.
Security Audit Log
GET
Endpoint Path
/api/v1/audit-log/export.csv
Output Formats (Content-Type)
text/csv; charset=utf-8
Description
Exports up to 1000 immutable administrative activity rows (supports action, entityType, userId, startDate, endDate, customerId).

API Usage Examples

1. Pass Instance CSV Export (POST /api/v1/passes/export)

Query matching pass UUIDs via GET /api/v1/passes or POST /api/v1/passes/query-builder, then stream them as passes-export.csv via POST /api/v1/passes/export (request payload requires 1–2,000 UUIDs in passIds and "format": "csv"):

HTTP
POST /api/v1/passes/export HTTP/1.1
Host: api.passinstance.com
Authorization: Bearer <access_token>
Content-Type: application/json

{
  "passIds": [
    "55a19c88-102b-4f33-8d99-ccddff001122",
    "77b20d99-304c-4a11-9e00-112233445566"
  ],
  "format": "csv"
}

Response Headers & Streamed CSV (200 OK)

HTTP
HTTP/1.1 200 OK
Content-Type: text/csv; charset=utf-8
Content-Disposition: attachment; filename="passes-export.csv"
CSV
id,serialNumber,externalId,status,walletPlatform,activeRegistrations,firstName,email,tier,pointsBalance,createdAt
55a19c88-102b-4f33-8d99-ccddff001122,PI-2026-994812,CRM-88210,ACTIVE,APPLE_WALLET,2,Elena,elena@example.com,GOLD,1450,2026-10-14T09:15:22.000Z
77b20d99-304c-4a11-9e00-112233445566,PI-2026-994815,CRM-88219,ACTIVE,GOOGLE_WALLET,1,Marcus,marcus@example.com,GOLD,980,2026-10-18T14:40:05.000Z

2. Scan Audit Trail & Security Audit Log CSV Exports

Export scan outcomes or administrative audit trails for compliance and finance reconciliation:

HTTP
GET /api/v1/validation/scan-results/export/csv?startDate=2026-11-01T00:00:00.000Z&endDate=2026-11-16T23:59:59.999Z&decision=SUCCESS HTTP/1.1
Host: api.passinstance.com
Authorization: Bearer <access_token>
HTTP
GET /api/v1/audit-log/export.csv?startDate=2026-11-01T00:00:00.000Z&endDate=2026-11-16T23:59:59.999Z HTTP/1.1
Host: api.passinstance.com
Authorization: Bearer <access_token>

3. GDPR Data Subject Portability Export (request payload)

When a passholder submits a verified Data Subject Access Request (DSAR), pass a single 3–256 character lookup query (such as email address, serial number, or externalId) to Privacy Compliance API:

HTTP
POST /api/v1/customer/cus_89a12b34-56c7-4d89-9e01-23456789abcd/privacy-settings/data-subject-export HTTP/1.1
Host: api.passinstance.com
Authorization: Bearer <access_token>
Content-Type: application/json

{
  "query": "elena@example.com"
}
JSON
{
  "exportedAt": "2026-11-16T10:34:10.000Z",
  "workspaceId": "cus_89a12b34-56c7-4d89-9e01-23456789abcd",
  "queryLength": 17,
  "totalCount": 2,
  "groups": [
    {
      "resourceType": "passes",
      "items": [
        {
          "id": "55a19c88-102b-4f33-8d99-ccddff001122",
          "identifier": "PI-2026-994812",
          "createdAt": "2026-10-14T09:15:22.000Z",
          "updatedAt": "2026-11-16T08:42:11.000Z",
          "source": "api",
          "processingPurpose": "loyalty_program",
          "retentionStatus": "ACTIVE",
          "relatedResourceIds": ["scn_019331f4-8e2a-7b00-9c11-44a8e2019b3c"]
        }
      ]
    }
  ]
}

Related Product & Developer Documentation

Ready to launch your first pass program?

Create your workspace, configure your pass template, and test a real pass in Apple Wallet and Google Wallet before you scale.