Skip to main content

VOTR Documentation

Welcome to the VOTR developer documentation. VOTR lets you offer shareholder voting to your users — discover voting events, submit shareholder and trade records, and hand shareholders a ballot they can complete, all through one secure API.

Your backend integrates with VOTR server-to-server; your users vote through a hosted ballot you surface in your app. These docs walk you through every step, with an interactive playground for each endpoint so you can try calls as you read.

Why VOTR​

Eliminate manual event management

Instead of building custom integrations for each issuer, your backend connects to VOTR's unified API. Events sync automatically from your data sources — no more spreadsheets, no more manual data entry.

Hours saved per week.

One platform, all companies

Whether you serve 10 companies or 1,000, VOTR scales without separate integrations or custom development. The same secure API handles every voting event, every shareholder, every company.

Standardization across your entire operation.

Shareholder data without the headache

Your backend sends shareholder identifiers and voting eligibility to VOTR. We validate securely, you stay compliant, and no sensitive data is exposed to the frontend — your shareholders get instant access to their ballots through your app.

Secure, compliant, and frontend-safe.

How it works​

VOTR keeps your credentials and shareholder data on the server. Your frontend never holds VOTR secrets — it only ever talks to your backend, which proxies to VOTR.

Frontend

  • React / React Native
  • VoteNowButton SDK (optional)
  • User Interface
  • No Credentials

Your Backend

  • Holds Client ID & Secret
  • Secure Storage
  • Environment URLs

VOTR API

  • OAuth Tokens
  • Voting URLs
  • User Validation

The frontend only ever talks to your backend. Your backend holds the OAuth credentials and proxies to VOTR. The user never sees the client secret.

Two ways you integrate​

Most of the integration is API work on your backend. The SDK is an optional frontend add-on.

  • API (backend) — the core of every integration. Your server authenticates, looks up events, generates a hosted voting URL, and submits shareholder and daily trade data. See API Integration.
  • SDK (frontend, optional) — a React Native VoteNowButton that opens the hosted ballot inside your app. You only need it for in-app voting; otherwise you can open the voting URL any way you like. See SDK.

Get started in four steps​

The typical end-to-end flow, all from your backend:

1

Authenticate

Exchange your client credentials for an access token, server-side.

2

Look up events

List the voting events available for a given record date.

3

Submit shareholders

Post the holder list and voting eligibility for each event.

4

Generate a voting URL

Issue a one-shot ballot URL your shareholders use to cast their vote.

For the full broker workflow — including keeping holder lists current with daily trades — see the Integration Workflow.

Where to find things​

Getting Started

Orientation, prerequisites, and the security model to set up before you build.

API Integration

The backend work: authenticate, look up events, generate voting URLs, and submit shareholder and trade data.

SDK

Optional React Native VoteNowButton for in-app voting — installation and props.

Reference

Test data and troubleshooting for common failure modes.

API Playground

Interactive reference for every endpoint, powered by the OpenAPI spec.

Environments​

VOTR provides separate Development and Production environments. Credentials are issued per environment and are not interchangeable.

EnvironmentBase URL
Developmenthttps://api-dev.govotr.com
Productionhttps://api.govotr.com

Need help?​

A complete reference implementation is available at our sample GitHub repo. Still stuck? Email support@govotr.com.