This API reference covers all Rise B2B endpoints. For quick integration examples, see our Integration Guides.
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.Rise SDK
Use our official SDK for easier integration
Authentication Methods
Rise supports two authentication methods to accommodate different use cases:JWT Authentication
Traditional token-based authentication for familiar API workflows
SIWE Authentication
Blockchain-based wallet authentication for enhanced security
API Structure
The Rise B2B API is organized into logical groups:Authentication
- JWT token management
- SIWE message generation and verification
- Token refresh and validation
Companies & Teams
- Company management
- Team operations
- User management
- Role and permission management
Payments
- Payment creation and execution
- Payment status tracking
- Payment history and reporting
- Multi-currency support
Payroll
- Payroll period management
- Team payroll operations
- Payroll reporting and analytics
Invites
- Team invitation management
- Manager invitation with blockchain signing
- Invite status tracking
Webhooks
- Webhook registration and management
- Event delivery and retry
- Webhook testing and monitoring
Base URLs
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: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
- Install the SDK - Set up the Rise SDK
- Choose Authentication - Select your authentication method
- Security Best Practices - Implement security measures
- Integration Guides - Follow step-by-step guides
Security
For comprehensive security guidance, see our dedicated security documentation:Security Overview
Complete security architecture and best practices
Private Keys
Understanding and securing private keys
Secondary Wallets
Using dedicated wallets for API operations
Webhook Security
Securing webhook communications
