> ## Documentation Index
> Fetch the complete documentation index at: https://docs.riseworks.io/llms.txt
> Use this file to discover all available pages before exploring further.

# API Reference

> Complete API reference for Rise B2B platform with blockchain and traditional authentication

<Note>
  This API reference covers all Rise B2B endpoints. For quick integration examples, see our [Integration Guides](/guides).
</Note>

## Overview

The Rise B2B API provides a comprehensive platform for managing global payroll, payments, and team operations. Our API supports both traditional JWT authentication and blockchain-native Sign-In with Ethereum (SIWE) authentication.

<Card title="Rise SDK" icon="code" href="https://github.com/riseworks/rise-sdk">
  Use our official SDK for easier integration
</Card>

## Authentication Methods

Rise supports two authentication methods to accommodate different use cases:

<CardGroup cols={2}>
  <Card title="JWT Authentication" icon="key" href="/authentication/jwt-authentication">
    Traditional token-based authentication for familiar API workflows
  </Card>

  <Card title="SIWE Authentication" icon="wallet" href="/authentication/siwe-authentication">
    Blockchain-based wallet authentication for enhanced security
  </Card>
</CardGroup>

## API Structure

The Rise B2B API is organized into logical groups:

<CardGroup cols={2}>
  <Card title="Authentication" icon="key">
    * JWT token management
    * SIWE message generation and verification
    * Token refresh and validation
  </Card>

  <Card title="Companies & Teams" icon="building">
    * Company management
    * Team operations
    * User management
    * Role and permission management
  </Card>

  <Card title="Payments" icon="credit-card">
    * Payment creation and execution
    * Payment status tracking
    * Payment history and reporting
    * Multi-currency support
  </Card>

  <Card title="Payroll" icon="users">
    * Payroll period management
    * Team payroll operations
    * Payroll reporting and analytics
  </Card>

  <Card title="Invites" icon="envelope">
    * Team invitation management
    * Manager invitation with blockchain signing
    * Invite status tracking
  </Card>

  <Card title="Webhooks" icon="bell">
    * Webhook registration and management
    * Event delivery and retry
    * Webhook testing and monitoring
  </Card>
</CardGroup>

## Base URLs

| Environment    | Base URL                           | Description         |
| -------------- | ---------------------------------- | ------------------- |
| **Staging**    | `https://api-staging.riseworks.io` | Testing environment |
| **Production** | `https://api.riseworks.io`         | Live environment    |

## Rate Limits

* **Standard**: 100 requests per minute per API key
* **Burst**: Up to 200 requests per minute for short periods
* **Webhooks**: 1000 webhook deliveries per hour per endpoint

## Error Handling

The API uses standard HTTP status codes and returns detailed error messages:

```json theme={null}
{
  "error": {
    "code": "validation_error",
    "message": "Invalid request parameters",
    "details": {
      "field": "amount",
      "issue": "Must be a positive number"
    }
  }
}
```

## SDK Support

Our official SDK provides:

* **TypeScript Support**: Full type definitions and autocomplete
* **Authentication**: Automatic JWT and SIWE handling
* **Webhook Validation**: Built-in signature verification
* **Error Handling**: Comprehensive error management
* **Examples**: Ready-to-use code examples

## Getting Started

1. **[Install the SDK](/sdk/installation)** - Set up the Rise SDK
2. **[Choose Authentication](/authentication)** - Select your authentication method
3. **[Security Best Practices](/security)** - Implement security measures
4. **[Integration Guides](/guides)** - Follow step-by-step guides

## Security

For comprehensive security guidance, see our dedicated security documentation:

<CardGroup cols={2}>
  <Card title="Security Overview" icon="shield" href="/security/overview">
    Complete security architecture and best practices
  </Card>

  <Card title="Private Keys" icon="key" href="/security/private-keys">
    Understanding and securing private keys
  </Card>

  <Card title="Secondary Wallets" icon="wallet" href="/security/secondary-wallets">
    Using dedicated wallets for API operations
  </Card>

  <Card title="Webhook Security" icon="bell" href="/security/webhook-validation">
    Securing webhook communications
  </Card>
</CardGroup>