OpenCap API Documentation V1

[urbantech]

API Versions

• v1: /api/* - General API endpoints
• v2: /api/v2/* - Advanced corporate endpoints (Production only)

Base URLs

Production: https://api.opencap.com
Development: http://localhost:3000

API Routes Overview

Authentication

Base path: /auth

• Login
• Registration
• Token management

General API Routes

User Management

Base path: /api/users

• User CRUD operations
• Profile management
• User preferences

Share Class Management

Base path: /api/shareClasses

• Share class creation and management
• Ownership tracking
• Dilution calculations

Stakeholder Management

Base path: /api/stakeholders

• Stakeholder registration
• Relationship management
• Contact information

Document Management

Base path: /api/documents

• Document upload/download
• Version control
• Metadata management

Base path: /api/documentEmbeddings

• Document analysis
• Text extraction
• Search indexing

Base path: /api/documentAccesses

• Access control
• Permission management
• Audit logging

Investment Management

Base path: /api/fundraisingRounds

• Round creation
• Investment tracking
• Term sheet management

Base path: /api/investments

• Investment tracking
• Portfolio management
• Return calculations

Base path: /api/investors

• Investor profiles
• Investment history
• Due diligence

Equity Management

Base path: /api/equityPlans

• Plan creation
• Vesting schedules
• Option pools

Employee Management

Base path: /api/employees

• Employee records
• Equity grants
• Vesting tracking

Activity Tracking

Base path: /api/activities

• System events
• User actions
• Audit trail

Administration

Base path: /api/admins

• System administration
• User management
• Settings configuration

Company Management

Base path: /api/companies

• Company profiles
• Corporate structure
• Business details

Tax Calculations

Base path: /api/taxCalculations

• Tax liability
• Tax planning
• Regulatory compliance

V2 Routes (Production Only)

Corporation Management

Base path: /api/v2

• Advanced corporate structure
• Legal entity management
• Corporate governance

Compensation Management

Base path: /api/v2/compensation

• Salary management
• Bonus calculations
• Benefits tracking

Issuer Management

Base path: /api/v2/issuers

• Security issuance
• Regulatory compliance
• Offering management

Common Patterns

Request Headers

Authorization: Bearer <token>
Content-Type: application/json
Accept: application/json

Response Format

{
  "success": boolean,
  "data": object | array,
  "message": "string",
  "timestamp": "ISO8601 date",
  "pagination?: {
    "currentPage": number,
    "totalPages": number,
    "totalItems": number,
    "itemsPerPage": number
  }
}

Error Format

{
  "success": false,
  "error": {
    "code": "string",
    "message": "string",
    "details": object
  },
  "timestamp": "ISO8601 date"
}

Pagination Query Parameters

?page=1&limit=10&sortBy=createdAt&sortOrder=desc

Environment-Specific Behavior

Production

• All routes available
• Full security measures
• Rate limiting enforced
• SSL required

Development

• All routes available
• Reduced security
• No rate limiting
• SSL optional

Test

• Limited route set
• V2 routes disabled
• Mocked external services
• In-memory database