Carbon Zero Documentation
Carbon Zero is a multi-tenant ESG reporting & compliance platform — register reporting entities, collect metric submissions against frameworks (GRI / SASB / CSRD-ESRS / TCFD / GHG Protocol), compute Scope 1–3 emissions, score performance, set targets, and publish auditable disclosures, with a full REST API for tenant integrations. Purpose-built for UAE maritime / shipping Scope 3 reporting.
User Manual
For sustainability teams and operators. Walks through every module — reporting entities, frameworks & metrics, periods, submissions, disclosures, ESG scoring, targets, the Scope 3 calculator and vessel fuel feeds, customer care, reports and automation — plus account security (2FA). Ideal for onboarding and training.
Developer Documentation
For tenant developers building integrations. REST API reference, authentication (cookie
sessions, MFA & cz_live_ API keys), the RBAC model, signed webhooks with
verification samples, machine fuel-feed ingestion, and an end-to-end walkthrough.
Interactive API explorer
Browse and try every endpoint, model and field against the live OpenAPI schema.
Swagger UI LIVE
An embedded Swagger UI bound to /api/openapi.json — the same schema served at
the API's own /api/docs (Swagger) and /api/redoc (ReDoc) routes.
Access-restricted in production (HTTP Basic auth).
ReDoc
A three-pane reference rendering of the same OpenAPI schema, served live by the API at
/api/redoc. Best for reading the full model catalogue end to end.
https://<your-workspace-domain>/api/v1. Replace
placeholder ids, tokens, and the host with your own. Dates are YYYY-MM-DD;
timestamps are ISO-8601 UTC; ids are UUID strings; emissions are reported in
tCO2e with a Well-to-Tank (WTT) / Tank-to-Wake (TTW) split.