Skip to main content
Welcome to Rise B2B API! This guide will help you integrate with our blockchain-based global payroll platform in minutes.

Fast Setup

Configure authentication and execute your first API call in under 5 minutes

Secure by Default

Built on blockchain with SIWE authentication and EIP-712 signing

Global Reach

Support for 190+ countries and 90+ local currencies

Crypto Ready

Process payments in 100+ cryptocurrencies and stablecoins

Prerequisites

Request API access first, and do it per environment. The B2B API is off by default. Contact Rise support to enable your company for the environment you’ll call, and note that staging and production are enabled separately, so a request for one does not cover the other. Reach support through your dedicated Slack channel, the in-app chat, or hello@riseworks.io. The full checklist, including authorizing your wallet, is in Getting API Access.
Before beginning your integration, ensure you have:
  • A Rise account with a RiseID (get one at app.riseworks.io)
  • Node.js installed (version 16 or higher)
  • Basic knowledge of JavaScript/TypeScript
New to blockchain? No concerns! You can use a private key from your wallet to authenticate with Rise, or use a JWT token. A private key functions as a digital signature that verifies wallet ownership, which connects to your Rise account. Learn more about how wallets work and authentication methods.

Step 1: Configure Your Environment

First, create a new project and install the Rise SDK:
Create a .env file for your configuration:
Need help with authentication? Review our Private Keys Guide for step-by-step instructions on how to retrieve your private key from MetaMask, hardware wallets, or generate a new one. You can also learn about how wallets work and authentication methods.
Security Note: Never commit your .env file to version control. Your private key gives full access to your wallet. Store it securely and use environment variables in production.

Step 2: Initialize the Rise SDK

Create your first integration script:

Step 3: Execute Your Integration

Execute your integration:

Step 4: Advanced SDK Usage

Here are additional examples using the Rise SDK:

Step 5: SDK Configuration

The SDK automatically uses production environment by default, but you can specify staging for testing:

Step 6: Error Handling

The SDK provides comprehensive error handling:

Next Steps

Now that you have basic SDK integration configured, explore these features:

SDK Setup

Install and configure the Rise SDK

Core Concepts

Learn about RiseID, teams, roles, and entity management

API Reference

Complete API documentation with all endpoints

Webhooks

Set up webhook endpoints for real-time notifications

Payment Processing

Learn how to process payments securely

Authentication Guide

Learn about different authentication methods

Team Management

Create teams and manage members with role-based access

Error Handling

Comprehensive error handling and debugging guide
Production Ready? The SDK automatically uses production environment by default. For testing, use environment: 'stg' to connect to staging. Implement comprehensive error handling before going live. The SDK automatically handles authentication and secure signing for you.