Overview
The Vocdoni API lets you add secure, anonymous and end-to-end verifiable voting to your own product. This section explains how the pieces fit together and where to go next.
Alpha
The Vocdoni API is in alpha. Endpoints, fields and responses may still change between versions. Build against it for evaluation and early integration, and check the OpenAPI specification for the current contract.
¶Who this is for
These docs are written for integrators: developers who add voting to their own software. The SaaS API is shaped for a multi-tenant model - you provision one managed organization per customer and run everything inside it with your integrator key, so your customers never need a Vocdoni account. Every example is shown in bash + curl, with .NET (C#) and Python variants.
¶How the API fits together
Most integrations follow the same path. Each step maps to a small group of endpoints documented here.
- Organization - the tenant that owns members, censuses, elections and API keys. Everything is scoped to an organization address; as an integrator you create one managed org per customer.
- Members and groups - the people in an organization, and named subsets of them. Import them once, then reuse them across many elections.
- Census - the eligible-voter list for a given election, plus how voters authenticate. Publishing a census produces a cryptographic root.
- Process - a voting process (an election) with its questions, vote type and timing, run against a published census.
- Results - live or final tallies that anyone can verify against the protocol.
Heavy work runs asynchronously
Bulk member imports, census publishing, process publishing and status changes can take time, so they return a job id you poll until completion. See Jobs for the pattern.
¶Two ways to integrate
Most teams use the REST API documented here, which handles organizations, members, censuses, processes and results for you. Casting a ballot is voter-facing cryptography that runs client-side in the voter's browser via the TypeScript SDK. See SDKs and tools for when to use each.