HeyPeppy API Reference

Welcome to the HeyPeppy REST API reference. Use this API to integrate automated Vision AI receipt extraction, proof-of-payment auditing, and scholarship purchasing policy validation into your Education Savings Account (ESA) portal or SFO platform.

Interactive API Playground

Every endpoint has its own dedicated sub-page featuring parameter tables, response schemas, code generators, and an interactive right-hand Test Console where you can plug in your API key and send test requests.

---

Base URLs

The HeyPeppy API provides multiple environments:

Environment	Base URL	Purpose
Production	https://api.heypeppy.ai/v1	Live production tenant traffic and Cloud Tasks workers.
Sandbox / Staging	https://staging-api.heypeppy.com/v1	Testing and integration staging environment.
Interactive Mock	https://mock.heypeppy.com/v1	Instant simulated responses for rapid local UI testing.

---

Authentication & Headers

All requests require authentication using Bearer tokens in the Authorization header:

Authorization: Bearer <YOUR_API_KEY>
X-Tenant-ID: stepup
Content-Type: application/json

• Authorization (Required): Your tenant API key prefixed with Bearer .
• X-Tenant-ID (Optional): B2B tenant identifier (stepup, odyssey, classwallet). Inferred automatically from your API key if omitted.
• Content-Type (Required for POST/PUT): Must be application/json.

---

Available Endpoints

Explore the dedicated endpoint documentation and test consoles:

Method	Endpoint	Description	Link
POST	/receipts/extract	Submit receipt image/PDF for asynchronous extraction via Cloud Tasks queue.	View Endpoint & Test →
POST	/receipts/extract-sync	Real-time synchronous extraction for interactive single-page receipts (<6s).	View Endpoint & Test →
POST	/submissions/audit	Comprehensive compliance audit against Florida PEP/UA handbook rules.	View Endpoint & Test →
POST	/batches	Enqueue a bulk batch of up to 1,000 receipts or claims in parallel.	View Endpoint & Test →
GET	/jobs/{jobId}	Inspect the status, execution metrics, and full results of an async job.	View Endpoint & Test →

---

OpenAPI 3.1 Specification

The machine-readable OpenAPI specification is available for download at /openapi.yaml.