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
Important: Exported CSV and JSON files frequently contain passholder Personally Identifiable Information (PII) such as names, email addresses,
externalIdvalues, 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
/api/v1/passes/exportContent-Type)text/csv; charset=utf-8passes-export.csv) for an explicit list of up to 2000 UUIDs (request payload: { passIds, format: "csv" })./api/v1/validation/configs/:id/scans/exportContent-Type)text/csv; charset=utf-8ScannerConfiguration./api/v1/validation/scans/exportContent-Type)text/csv; charset=utf-8/api/v1/validation/scan-results/export/csvContent-Type)text/csv; charset=utf-8decision, reasonCode, operator ID, and balance effects./api/v1/validation/configs/:id/scanner-keys/export/csvContent-Type)text/csv; charset=utf-8Content-Type)/api/v1/batch-processing/:id/result.csvContent-Type)text/csv; charset=utf-8/api/v1/billing/invoices/:id/downloadContent-Type)application/pdf/api/v1/customer/:customerId/privacy-settings/data-subject-exportContent-Type)application/jsonIDataSubjectExportPayload) matching request payload.query./api/v1/audit-log/export.csvContent-Type)text/csv; charset=utf-81000 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"):
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/1.1 200 OK
Content-Type: text/csv; charset=utf-8
Content-Disposition: attachment; filename="passes-export.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:
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>
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:
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"
}
{
"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 Documentation
-
Review scan decision codes in Scanning & Redemption Reports.
-
Download tax invoices in Invoices & Billing History.
-
Learn about automated data retention and erasure in Data Privacy & GDPR.
