Getting Started

TaxStreem API

TaxStreem is a tax automation API that connects to your product and handles compliance on your behalf. Authenticate once, then use our three core modules — Flux, Prism, and Numens — to file taxes, manage invoices, and classify transactions without building tax logic yourself.

Our developer-friendly API lets you embed TaxStreem's full compliance engine directly into your platform. Whether you're filing on behalf of your own business or orchestrating tax operations across multiple entities, TaxStreem gives you the flexibility to:

•Submit VAT and WHT filings to tax authorities in real time or in bulk
•Generate, route, and reconcile compliant invoices programmatically
•Classify transactions automatically and determine the correct tax treatment
•Receive filing and classification outcomes asynchronously via webhooks
•Operate across sandbox and live environments with a single API key prefix

Core Modules

Each module is a self-contained API surface. You can integrate them independently or together depending on your compliance requirements.

Module	What it does
🔁 Flux	Tax filing engine for VAT and WHT. Accepts single or batch filings, validates against authority rules, and tracks submission status end-to-end.
🧾 Prism	Invoice management layer. Create compliant invoices, route them to the right recipients, and reconcile against payments and filings automatically.
🔍 Numens	Transaction intelligence engine. Submit a transaction and Numens inspects its context — counterparty, amount, and nature — to determine whether VAT, WHT, or CIT applies. Supports single and batch inputs.

⚙️ How Requests Work

Filing and intelligence operations are processed asynchronously. When you submit a request, TaxStreem returns a 202 Accepted immediately — the actual result is delivered to your configured webhook endpoint once processing completes.

This design prevents timeout failures on bulk submissions and ensures your integration stays non-blocking regardless of filing volume. Events like vat.filing.success and transaction.classified are broadcast securely to your endpoint as they resolve.

🔐 Authentication & Encryption

All requests are authenticated via your x-api-key header. For requests that involve sensitive authority credentials, TaxStreem expects an encrypted payload rather than raw values.

✅Wrap sensitive values using AES-256-GCM with your organization's shared secret to produce the encryptedPayload field.

✅Pass your entity's Tax Identification Number (TIN) exactly as issued — no formatting, no truncation.

🏦 Environments

The environment is determined entirely by your API key prefix — there are no separate base URLs to configure.

test_Routes to the sandbox. No data is written to live tax authority systems. Use this throughout development and QA.

live_Routes to production. Submissions are live and irreversible. Only use once your integration is fully tested.

📌 Good to know

•Every filing and classification operation returns a unique id you can use for idempotency checks and audit trails.

•Rate limit responses return 429 with a Retry-After header indicating when you can resume.

•Webhook delivery is retried with exponential backoff on failed responses. Ensure your endpoint returns 200 promptly to acknowledge receipt.

Explore the Modules

🔁

Flux API

VAT & WHT Filing Engine

Submit single or batch VAT and Withholding Tax filings directly to tax authorities. Flux handles calculation, validation, and status tracking — returning real-time filing events to your application via webhooks.

Read the docs

🧾

Prism API

Invoicing & Reconciliation

Create, issue, and reconcile invoices at scale. Prism manages the full invoice lifecycle — from generation and smart-routing to status updates and ledger matching.

Read the docs

🔍

Numens API

Transaction Intelligence

Submit raw transactions and let Numens determine the correct tax treatment. The engine inspects each transaction's context — counterparty type, amount, and nature — and returns the applicable tax type: VAT, WHT, or CIT.

Read the docs

⚡

Quickstart

Up and running in minutes

Make your first authenticated API call, submit a test VAT filing, and receive a webhook event — all in one guided flow.

Get started

API Changelog

v1.0.1b

New Webhook Events

Added support for subscription.cancelled and invoice.paid webhook events.

2 days ago

v1.0.1a

Batch Filing Improvements

Increased batch filing limit from 50 to 100 records per request. Improved error messages for malformed TIN values.

5 days ago

v1.0.0

Initial Release

Flux (VAT/WHT), Prism (Invoicing), and Numens (Transaction Intelligence) now available.

1 week ago