Skip to main content

Integration Workflow

This is the full picture: how a broker integrates with VOTR to enable shareholder voting, from event discovery through vote submission.

Flow​

Start

Get events by record date

Call the Events API and filter against your holdings (CUSIP, ISIN, ticker).

Any events relevant?

YesContinue to step 2
NoEnd — nothing to do

Submit shareholders

Post the holder list for each relevant event. Up to 50 per call. Submit on the evening of the record date.

Get event details

Poll until votingLinksActive flips to true.

Voting active?

YesContinue to step 4
NoRetry — back to step 3

Shareholder taps "Vote Now"

Your client surfaces the button. Don't pre-fetch the URL on page load — wait for the click.

Request the voting URL

VOTR returns a URL pointing at a hosted ballot UI. Request a fresh one on every tap.

Shareholder votes via SDK

Pass the URL into VoteNowButton. VOTR records the vote and fires onSuccess.

Vote recorded

Workflow steps​

  1. Get events by record date

    Call the Events API with recordDate=YYYY-MM-DD. Filter the response against your holdings (CUSIP, ISIN, ticker). Use pastRecordDate to also pick up events that were created after their record date.

  2. Submit shareholders

    For every relevant event, post the holder list to the Shareholders API. Up to 50 records per call. Submit on the evening of the record date so all holders are captured before the reporting deadline.

  3. Get event details

    Call Event Details for the specific event. If votingLinksActive is false, the event isn't open yet — poll periodically until it flips.

  4. Shareholder taps "Vote Now"

    Your client surfaces the button. Don't pre-fetch the URL on page load — wait for the click.

  5. Request the voting URL

    Call Voting (GET /events/{eventId}/ballot?accountNo=&brokerId=). VOTR returns a URL pointing at a hosted ballot UI. Request a fresh one on every tap.

  6. Shareholder votes

    Pass the URL into VoteNowButton. The SDK opens VOTR's ballot in a WebView. VOTR records the vote and fires onSuccess back to your app.

Voluntary Corporate Actions with election capture​

When VOTR captures shareholder elections for a Voluntary Corporate Actions event, holders can buy and sell during the offer period, so VOTR needs their positions kept up to date until the election cutoff.

  1. Get a token

    Exchange your client credentials for an access token → Authentication.

  2. Look up events

    Find events with eventType = Voluntary Corporate Actions → Events.

  3. Submit shareholders

    Post the initial holder list with settled positions → Shareholders.

  4. Send updates

    Until the election cutoff, post new holders (BUY) and position changes (BUY / SELL) → Shareholder Updates.

  • Events and Shareholders APIs are unchanged. The initial POST /shareholders delivery is the starting position for each account.
  • Send changes with POST /shareholders/updates until the election cutoff: BUY for new holders and increases, SELL for decreases (totalShares: 0 when an account sold everything).
  • After the election cutoff, updates are rejected with 403.