Integration Workflow
Visual guide to VOTR API integration workflow
🔄 VOTR Integration Workflow
This flowchart shows how brokers integrate with VOTR API to enable shareholder voting.
đź“Š Integration Flow Diagram
flowchart TD
Start([Start]) --> A[1. Broker Gets Events by Record Date]
A --> B[VOTR Returns All Events]
B --> C{Broker Determines:
Are Events Relevant?} C -->|No| End1([End]) C -->|Yes| D[2. Broker Submits
Shareholders Data] D --> E[3. Broker Gets Event Details by ID] E --> F{Event Status Active?
Voting Available?} F -->|No| E F -->|Yes| G[4. Shareholder Clicks
Vote Now Button] G --> H[5. Broker Requests Voting URL] H --> I[VOTR Returns
Voting URL with Ballot
Hosted on VOTR] I --> J[6. Shareholder Completes Vote
on VOTR's Ballot Interface] J --> K[VOTR Manages Voting
and Records Vote] K --> End2([Vote Submitted]) style Start fill:#e1f5e1 style End1 fill:#ffe1e1 style End2 fill:#e1f5e1 style C fill:#fff3e0 style F fill:#fff3e0
Are Events Relevant?} C -->|No| End1([End]) C -->|Yes| D[2. Broker Submits
Shareholders Data] D --> E[3. Broker Gets Event Details by ID] E --> F{Event Status Active?
Voting Available?} F -->|No| E F -->|Yes| G[4. Shareholder Clicks
Vote Now Button] G --> H[5. Broker Requests Voting URL] H --> I[VOTR Returns
Voting URL with Ballot
Hosted on VOTR] I --> J[6. Shareholder Completes Vote
on VOTR's Ballot Interface] J --> K[VOTR Manages Voting
and Records Vote] K --> End2([Vote Submitted]) style Start fill:#e1f5e1 style End1 fill:#ffe1e1 style End2 fill:#e1f5e1 style C fill:#fff3e0 style F fill:#fff3e0
đź“‹ Workflow Steps
Step 1: Broker calls Events API to get all events by record date
Step 2: Broker determines if events are relevant (checks CUSIP, issuer data against their holdings)
Step 3: Broker submits shareholder data for relevant events via Shareholders API
Step 4: Broker gets event details by ID to check if voting is available and event status is active
Step 5: When shareholder clicks “Vote Now”, broker requests voting URL
Step 6: VOTR returns voting URL with ballot hosted on VOTR’s platform - shareholder completes vote on VOTR’s interface, and VOTR manages the entire voting process