API Documentation - Developer Integration Guide

🚀 API Capabilities

• ✅ Investment Management: Create, update, and track investments
• ✅ User & KYC Operations: Manage user accounts and verification
• ✅ Deal Management: CRUD operations for investment opportunities
• ✅ Investment Groups: Create and manage exclusive investor communities
• ✅ Escrow System: Secure fund management and compliance
• ✅ Analytics & Reporting: Access platform metrics and insights

🔐 Security-First Approach

CDAO Platform API uses multiple authentication methods:

⚙️ Standard Authentication Pattern

All protected endpoints follow this pattern:

Key Points:

• Use - NOT
• The auth result contains directly
• Always check if result is NextResponse (auth failure)
• userId is a string - Convert to number if needed

🌐 Endpoint Structure

• Base URL:
• API Version: Included in URL path ()
• Environment: Separate URLs for staging and production
• Rate Limiting: 1000 requests per hour per API key

📋 Standard Format

Request Headers:

Response Format:

👥 User Operations

🔍 Verification API

• GET /api/kyc/status - Get verification status
• POST /api/kyc/initiate - Start KYC process
• POST /api/kyc/documents - Upload verification documents
• PUT /api/kyc/personal-info - Update personal information
• GET /api/kyc/requirements - Get verification requirements

💰 Investment Endpoints

👥 Group Management

Public Group Discovery:

• GET /api/groups - Public group discovery (excludes user's own groups)
• GET /api/groups/my-groups - Groups where user is a member
• GET /api/groups/applications - User's group applications
• GET /api/groups/{id} - Public group details
• POST /api/groups/{id}/apply - Submit group application
• GET /api/groups/{id}/dashboard - Member-only dashboard

Issuer Group Management:

• GET /api/issuer/groups - Issuer's groups (max 1)
• POST /api/issuer/groups - Create new group (blocked if exists)
• PUT /api/issuer/groups/{id} - Update group settings
• GET /api/issuer/groups/{id}/manage - Group management dashboard
• POST /api/issuer/groups/{id}/deals - Add deals to group
• GET /api/issuer/groups/{id}/applications - Review applications

📊 Deal Endpoints

🔐 Member-Exclusive Access

Important: Group deals are member-exclusive

🏦 Escrow Operations

• POST /api/escrow/create - Create escrow contract
• POST /api/escrow/{id}/fund - Fund escrow contract
• POST /api/escrow/{id}/approve - Approve and release funds
• POST /api/escrow/{id}/refund - Initiate refund
• GET /api/escrow/{id}/status - Get escrow status
• GET /api/escrow - List user's escrows

Escrow Status Response:

📈 Insights & Metrics

• GET /api/analytics/dashboard - User dashboard metrics
• GET /api/analytics/investments - Investment performance
• GET /api/analytics/deals - Deal statistics
• GET /api/analytics/groups - Group performance metrics
• GET /api/analytics/platform - Platform-wide statistics

Example Dashboard Response:

🔔 Real-time Events

Supported Event Types:

• investment.created - New investment made
• investment.completed - Investment completed
• kyc.status_changed - KYC verification status update
• escrow.funded - Escrow contract funded
• escrow.released - Escrow funds released
• group.application_received - New group application
• deal.funding_completed - Deal funding target reached

Webhook Configuration:

• POST /api/webhooks - Create webhook endpoint
• GET /api/webhooks - List configured webhooks
• PUT /api/webhooks/{id} - Update webhook
• DELETE /api/webhooks/{id} - Delete webhook

🚨 Error Format

Common HTTP Status Codes:

• 400 - Bad Request (validation errors)
• 401 - Unauthorized (authentication required)
• 403 - Forbidden (insufficient permissions)
• 404 - Not Found (resource doesn't exist)
• 429 - Too Many Requests (rate limiting)
• 500 - Internal Server Error

📦 Available Libraries

🔬 Sandbox Features

• Test API Keys: Separate keys for development
• Mock Data: Realistic test data for development
• Webhook Testing: Test webhook delivery and handling
• Rate Limit Testing: Test rate limiting behavior
• Error Simulation: Simulate various error conditions

📞 Developer Support

Need help with API integration?

• API Support: api@support@cdao.vc
• Developer Relations: developers@support@cdao.vc
• Technical Documentation: http://companydao.org/support/api
• Developer Community: Discord channel for developers
• GitHub Issues: Report bugs and request features

🚀 Ready to Build?

The CDAO Platform API provides everything you need to build powerful investment applications. From user management to complex escrow operations, our comprehensive API suite supports all your integration needs.

Get your API keys and start building today!