Build on VitalReturns
Everything you need to integrate VitalReturns with your billing, your ERP, your existing accounting system, or your tax-agency ops tooling.
Reference, guides, examples
The API is documented top-to-bottom — each endpoint, each shape, each error code.
- Authentication
Bearer-token authentication, API key management, per-key rate limits, scopes and request signing.
Open - REST API reference
Full reference for the Public API v2 — taxpayers, obligations, returns, submissions, payments and invoices.
Open - Webhooks
Signed webhooks on every event — HMAC-SHA256 verification, retries with exponential backoff, replay protection.
Open - Integration guides
End-to-end guides for connecting banks, mobile money providers, EFRIS inbound/outbound, and URA submissions.
Open - CLI & SDKs
Node SDK, Python SDK and the vitalreturns CLI for scripting bulk operations in your pipeline.
Open - Changelog
Every API change, deprecation, and new endpoint, with the exact version it ships in.
Open
File a return in two API calls
Prepare, validate and submit a URA return without ever opening the UI. Perfect for ERP write-backs and scheduled filing pipelines.
POST /api/v2/returns
Authorization: Bearer vr_live_...
Content-Type: application/json
{
"taxpayerId": "tp_01HZ...",
"returnType": "VAT",
"periodStart": "2026-10-01",
"periodEnd": "2026-10-31"
}
POST /api/v2/returns/{id}/submit
Authorization: Bearer vr_live_...
Request API access
Public API access is included on every paid plan — just sign up and provision a key from the workspace settings.