Skip to main content

Yield API Overview

The Yield API provides comprehensive banking and financial services for businesses, including account management, portfolio operations, transfers, and compliance features. This overview organizes all available API documentation by category.

🔐 Authentication​

OAuth Token Generation​

Create and manage OAuth tokens for API authentication.

🏢 Business Management​

Create Business​

Create new business entities in the Yield platform.

Update Business​

Update existing business information and settings.

Get Business​

Retrieve detailed information about a specific business.

List Businesses​

Get a list of all businesses associated with your account.

💰 Portfolio Management​

Create Portfolio​

Create investment portfolios for businesses.

Get Portfolio​

Retrieve portfolio details and current holdings.

Get Portfolio History​

Access historical portfolio performance data.

💸 Transfer Management​

Create Transfer​

Initiate new fund transfers between accounts.

Update Transfer​

Modify existing transfer details and status.

Get Transfer​

Retrieve information about a specific transfer.

Get Transfers​

List all transfers with filtering options.

🏦 Bank Account Management​

Create Bank Account​

Add new bank accounts to business profiles.

Update Bank Account​

Modify bank account information and settings.

Get Bank Account​

Retrieve details for a specific bank account.

Get Bank Accounts​

List all bank accounts associated with a business.

Get Wire Instructions​

Obtain wire transfer instructions for accounts.

📄 Document Management​

Get Document​

Retrieve specific document details and content.

Get Documents​

List all documents associated with a business.

🔄 Onboarding & Compliance​

Submit Onboarding​

Submit business onboarding applications.

Get Onboarding​

Check onboarding status and requirements.

🎭 Simulation APIs​

Simulation APIs​

Test and simulate various business processes and state changes.

📋 API Categories Summary​

CategoryAPIs AvailablePurpose
Authentication1Secure API access and token management
Business Management4Complete business lifecycle management
Portfolio Management3Investment portfolio operations
Transfer Management4Fund transfer processing and tracking
Bank Account Management5Bank account integration and management
Document Management2Document storage and retrieval
Onboarding & Compliance2Business onboarding and compliance
Simulation1Testing and development utilities

🚀 Getting Started​

  1. Authentication: Start by creating an OAuth token
  2. Business Setup: Create a business entity
  3. Account Integration: Add bank accounts for transfers
  4. Portfolio Creation: Set up investment portfolios
  5. Transfer Operations: Begin creating transfers

📚 Additional Resources​

  • API Reference: Interactive Swagger documentation available in each API guide
  • Error Handling: Common error codes and troubleshooting in individual guides
  • Rate Limits: Check specific API documentation for rate limiting information
  • Webhooks: Real-time event notifications (contact support for setup)

For technical support or questions about specific APIs, please refer to the individual documentation pages or contact our developer support team.