API & integrations
YoBridge is API-first. Everything the web and mobile apps do — filing returns, registering employees, ordering FDMS devices, reading registers — is available to your ERP, payroll, accounting or POS system through one secure REST API.
NSSA and ZIMRA TaRMS have no public filing API for third-party software. Building and maintaining your own filing integration — for every client you serve — is slow, fragile and expensive.
YoBridge gives you one API instead. Your system sends a request; YoBridge files it as a durable, tracked transaction and tells you the result.
Create an API key in the YoBridge Developer area, optionally restricted to specific companies, capabilities and IP addresses. Call the REST API with the key as a bearer token and an Idempotency-Key header, and YoBridge accepts the work immediately with a 202 response and a transaction you can poll.
Subscribe a webhook endpoint to receive signed events — completed, failed, awaiting OTP, low wallet balance, connections needing attention, compliance issues and FDMS order updates — so your system reacts without polling. YoERP already uses this API for NSSA P4, PAYE, VAT reconciliation and FDMS orders.
Versioned JSON API with consistent envelopes, pagination and error codes.
A complete OpenAPI document for generating clients and testing.
Live and test keys restricted by company, capability, scope and IP, shown once and rotatable.
Safe retries: the same Idempotency-Key and request always returns the original result.
Long-running portal work returns 202 immediately with a status you can track.
HMAC-SHA256 signatures, timestamps, event IDs, retries, history and manual replay.
When a portal needs an OTP, submit it through the API or let the user answer in the app.
Download receipts, statements and certificates through signed URLs.
Push finalised payroll earnings directly into the PAYE and NSSA engines.
01
In the Developer area, create a test or live key with the scopes you need.
02
POST to a company capability with an Idempotency-Key.
03
Poll the transaction or wait for a webhook event.
04
Read structured results and download receipts and documents.
Start a capability run for a company with your API key, then receive the outcome by webhook. Every capability — from nssa.p4.upload to zimra.tarms.vat.submit — follows the same pattern.
curl -X POST \
https://api.yobridge.co.zw/api/v1/companies/{company_id}/capabilities/nssa.employee.list/transactions \
-H "Authorization: Bearer yb_live_<prefix>_<secret>" \
-H "Idempotency-Key: 2026-10-employee-sync" \
-H "Content-Type: application/json" \
-d '{ "payload": {} }'
# 202 Accepted
{
"data": { "id": "0192…", "status": "queued", … },
"meta": { "request_id": "…", "correlation_id": "…" }
}POST https://your-system.example/webhooks/yobridge
X-YoBridge-Signature: <HMAC-SHA256 of timestamp + body>
X-YoBridge-Timestamp: 1791100800
{
"event_id": "0192…",
"delivery_id": "0192…",
"event_type": "transaction.completed",
"schema_version": 1,
"occurred_at": "2026-10-05T09:00:00Z",
"data": { "transaction_id": "0192…", "to_status": "completed" }
}API access is included in every plan, with request limits from 60 requests per minute on Starter to 2,000 on Enterprise. Capability runs are billed the same way as in the app — from your plan or pay-as-you-go wallet.
Sign up, open the Developer area in the YoBridge web app and create an API key. Test keys (yb_test_) let you build safely; live keys (yb_live_) run real portal work.
Yes. The YoBridge API is fully described in OpenAPI. Contact us or open the Developer area to get the latest specification.
Send an Idempotency-Key with every transaction request. Repeating the same key with the same request returns the original transaction; reusing a key with a different request returns HTTP 409.
Each delivery is signed with HMAC-SHA256 using your endpoint’s secret and includes a timestamp, event ID and delivery ID so you can verify authenticity and reject replays. Failed deliveries are retried with backoff and can be replayed manually.
Yes. Software vendors and practices can manage many companies under one client account, and keys can be restricted to specific companies.
Yes. Limits depend on your plan, from 60 requests per minute on Starter up to 2,000 on Enterprise. Contact us if you need more.
P4 returns, employee registration, statements and compliance certificates.
Monthly PAYE earnings, readiness checks and TaRMS submission.
VAT return capture, supplier reconciliation and TaRMS submission.
Branches, fiscal devices, fiscal days and FDMS device orders.
Sign up on the web or download the app. Choose a fixed monthly plan, top up your wallet and pay as you go only for the portal filings you run — or talk to us about a demo for your practice.
Get the YoBridge app