VUZ Partner API

​
What you can build

The VUZ Partner API lets enterprise platforms — aggregators, marketplaces, delivery apps, gig-economy services — issue Israeli tax documents on behalf of every merchant on their platform. You manage the customer relationship. We handle:
  • חשבונית מס / קבלה generation with full Israeli tax-authority compliance
  • Sequential document numbering per merchant (audit-grade)
  • Digital signing (per VAT Circular 24/2004)
  • PDF rendering, branded with your design
  • Email + SMS delivery to the end customer
  • Webhook events for every state change

5-minute Quickstart

Issue your first invoice in 5 minutes — sandbox key to PDF.

API Reference

Every endpoint, every field, every error. With live API explorer.

Recipes

End-to-end working flows: orders, refunds, reconciliation.

AI-Friendly Docs

Copy any page as Markdown straight into Claude / Cursor / ChatGPT.

​
The mental model

Your Platform (e.g. food delivery app)
    │
    │ owns / parents
    ▼
N Merchants  (bakeries, restaurants, ...)        ← regular VUZ Businesses, "Lite" tier
    │
    │ sells to
    ▼
End Customers  (consumers who ordered through your app)
  • The merchant is the legal issuer of every invoice (their name, ע.מ./ח.פ., business type)
  • You are annotated as the collecting agent on each document
  • VUZ signs digitally, handles tax compliance, sends to the end customer
  • The end customer receives the invoice directly from VUZ infrastructure with your branding

​
What this is NOT

To set expectations clearly:
  • Not a payment processor. You collect payment your own way (Tranzila, Stripe, cash). We document the transaction.
  • Not an accounting application. Your merchants don’t log into VUZ. The API runs headless on their behalf.
  • Not a credit-card-on-file vault. D120 credit-card metadata (brand, last 4, installments) is captured for the document, not for re-charging.

​
Built for AI-augmented developers

This documentation was designed assuming you have Cursor, Claude, ChatGPT, or Copilot open alongside it.
  • Copy any page as Markdown with one click (top-right of every page)
  • /llms.txt and /llms-full.txt for AI assistants to crawl
  • Interactive API explorer on every endpoint page — paste your API key, click Send, see real responses
  • (Coming Phase 2) First-party MCP server so your AI tooling can call our API directly

​
Environments today

Honest status: VUZ currently runs two environments — your local dev box (https://localhost:3020) while we co-integrate, and production (https://api.vuz.co.il). A dedicated sandbox with data isolation (api.sandbox.vuz.co.il + isolated DB) is on the roadmap; until it ships, the vuz_test_* key prefix is informational only and hits the same production DB. See API Reference → Environments.

​
Next steps

1

Get an API key

Email partners@vuz.co.il with your platform name. We’ll issue your initial key within 1 business day.
2

Issue your first document

Follow the 5-minute Quickstart — API key to first signed invoice end-to-end.
3

Go to production

Once your integration is tested against your dev environment, request a vuz_live_* key. We coordinate the cutover, including IP allowlisting and webhook URL switch.