# Rise B2B API

> Global payroll for the modern workforce. Streamline payments to contractors and full-time employees around the globe with Rise's blockchain-first platform.

## Docs

- [Get SIWE (V1 Legacy)](https://docs.riseworks.io/api-reference-v1/auth/get-siwe-v1-legacy.md): V1-compatible endpoint to get SIWE message. Routes to V2 if user is migrated.
- [Verify SIWE (V1 Legacy)](https://docs.riseworks.io/api-reference-v1/auth/verify-siwe-v1-legacy.md): V1-compatible endpoint to verify SIWE signature. Routes to V2 if user is migrated.
- [List invites (V1 Legacy)](https://docs.riseworks.io/api-reference-v1/invites/list-invites-v1-legacy.md): V1-compatible endpoint to list pending invites for a company/team.
- [Send invites (V1 Legacy)](https://docs.riseworks.io/api-reference-v1/invites/send-invites-v1-legacy.md): V1-compatible endpoint to send contractor/client invites to a company/team.
- [Send warmed invites (V1 Legacy)](https://docs.riseworks.io/api-reference-v1/invites/send-warmed-invites-v1-legacy.md): V1-compatible endpoint to send pre-filled (KYC-primed) invites, in light or full mode.
- [Create batch payment intents (V1 Legacy)](https://docs.riseworks.io/api-reference-v1/payments/create-batch-payment-intents-v1-legacy.md): V1-compatible endpoint to create draft (unscheduled) batch payment intents.
- [Execute batch payment (V1 Legacy)](https://docs.riseworks.io/api-reference-v1/payments/execute-batch-payment-v1-legacy.md): V1-compatible endpoint to broadcast a previously-signed batch of pay-now payments.
- [Execute instant payment (V1 Legacy)](https://docs.riseworks.io/api-reference-v1/payments/execute-instant-payment-v1-legacy.md): V1-compatible endpoint to broadcast a previously-signed single pay-now payment.
- [List payments (V1 Legacy)](https://docs.riseworks.io/api-reference-v1/payments/list-payments-v1-legacy.md): V1-compatible endpoint to list/paginate payments for a company/team.
- [Prepare batch payment (V1 Legacy)](https://docs.riseworks.io/api-reference-v1/payments/prepare-batch-payment-v1-legacy.md): V1-compatible endpoint to prepare a batch of pay-now payments for signing. Returns EIP-712 typed data.
- [Prepare instant payment (V1 Legacy)](https://docs.riseworks.io/api-reference-v1/payments/prepare-instant-payment-v1-legacy.md): V1-compatible endpoint to prepare a single pay-now payment for signing. Returns EIP-712 typed data.
- [Get RiseID balance (V1 Legacy)](https://docs.riseworks.io/api-reference-v1/riseid/get-riseid-balance-v1-legacy.md)
- [Get team talent (V1 Legacy)](https://docs.riseworks.io/api-reference-v1/teams/get-team-talent-v1-legacy.md)
- [List team talent (V1 Legacy)](https://docs.riseworks.io/api-reference-v1/teams/list-team-talent-v1-legacy.md)
- [List teams (V1 Legacy)](https://docs.riseworks.io/api-reference-v1/teams/list-teams-v1-legacy.md): V1-compatible endpoint to list the authenticated user's teams.
- [Terminate team talent (V1 Legacy)](https://docs.riseworks.io/api-reference-v1/teams/terminate-team-talent-v1-legacy.md)
- [Get SIWE](https://docs.riseworks.io/api-reference/b2b-authentication/get-siwe.md): Retrieves a SIWE (Sign-In with Ethereum) message that can be used for authentication. This message is signed by the user to prove their identity.
- [Verify a SIWE message and return a JWT for API authentication](https://docs.riseworks.io/api-reference/b2b-authentication/verify-a-siwe-message-and-return-a-jwt-for-api-authentication.md)
- [Get entity balance](https://docs.riseworks.io/api-reference/b2b-balance/get-entity-balance.md): Retrieves balance and details of an entity using their nanoid (te- for team, co- for company, us- for user).
- [Create a single payment](https://docs.riseworks.io/api-reference/b2b-bill-pay/create-a-single-payment.md)
- [Create an instant payment](https://docs.riseworks.io/api-reference/b2b-bill-pay/create-an-instant-payment.md)
- [Create external recipient for billpay](https://docs.riseworks.io/api-reference/b2b-bill-pay/create-external-recipient-for-billpay.md)
- [Get external recipients for team](https://docs.riseworks.io/api-reference/b2b-bill-pay/get-external-recipients-for-team.md)
- [Create admin invites typed data](https://docs.riseworks.io/api-reference/b2b-invites/create-admin-invites-typed-data.md): Create admin invites for a company or team. This is used to invite users to the company or team.
- [Create invites for employees and contractors](https://docs.riseworks.io/api-reference/b2b-invites/create-invites-for-employees-and-contractors.md): Create invites/warm invites for employees and contractors. This is used to invite users to team.
- [Execute admin invites](https://docs.riseworks.io/api-reference/b2b-invites/execute-admin-invites.md): Execute admin invites for a company or team. This is used to execute admin invites for a company or team.
- [Get Invites](https://docs.riseworks.io/api-reference/b2b-invites/get-invites.md): List all pending invites for a company or team. User must be team_admin for teams or org_admin for companies.
- [Create typed data for payments](https://docs.riseworks.io/api-reference/b2b-payments/create-typed-data-for-payments.md): Create typed data for payments. The typed data can be signed and then executed to create the payments on-chain.
- [Execute Payments](https://docs.riseworks.io/api-reference/b2b-payments/execute-payments.md): Execute payments by signing the typed data and sending the signature along with the request.
- [Query Payments](https://docs.riseworks.io/api-reference/b2b-payments/query-payments.md): Query payments for a team, optionally filtered by recipient and date range.
- [Create a team](https://docs.riseworks.io/api-reference/b2b-teams/create-a-team.md)
- [Delete team member](https://docs.riseworks.io/api-reference/b2b-teams/delete-team-member.md)
- [Get team by nanoid](https://docs.riseworks.io/api-reference/b2b-teams/get-team-by-nanoid.md)
- [Get team member settings](https://docs.riseworks.io/api-reference/b2b-teams/get-team-member-settings.md)
- [Get team member summary](https://docs.riseworks.io/api-reference/b2b-teams/get-team-member-summary.md)
- [Get team settings](https://docs.riseworks.io/api-reference/b2b-teams/get-team-settings.md)
- [Get team users](https://docs.riseworks.io/api-reference/b2b-teams/get-team-users.md): Retrieves a list of users associated with the specified team identified by its nanoid. This endpoint is useful for obtaining user details for a specific team, including their names and email addresses.
- [Update team by nanoid](https://docs.riseworks.io/api-reference/b2b-teams/update-team-by-nanoid.md)
- [Update team member settings](https://docs.riseworks.io/api-reference/b2b-teams/update-team-member-settings.md)
- [Update team settings](https://docs.riseworks.io/api-reference/b2b-teams/update-team-settings.md)
- [Get user organization's](https://docs.riseworks.io/api-reference/b2b-users/get-user-organizations.md): Retrieves a list of organizations associated with the logged-in user.
- [Get user team's](https://docs.riseworks.io/api-reference/b2b-users/get-user-teams.md): Retrieves a list of teams associated with the logged-in user.
- [Update user address details](https://docs.riseworks.io/api-reference/b2b-users/update-user-address-details.md)
- [Update user avatar](https://docs.riseworks.io/api-reference/b2b-users/update-user-avatar.md)
- [Get V1 Webhook](https://docs.riseworks.io/api-reference/b2b-webhooks-v1/get-v1-webhook.md)
- [Delete Webhook](https://docs.riseworks.io/api-reference/b2b-webhooks/delete-webhook.md)
- [Delivery History](https://docs.riseworks.io/api-reference/b2b-webhooks/delivery-history.md)
- [Get Webhook](https://docs.riseworks.io/api-reference/b2b-webhooks/get-webhook.md)
- [Get Webhook Event](https://docs.riseworks.io/api-reference/b2b-webhooks/get-webhook-event.md): Returns the stored event row and payload when this event has at least one delivery for the webhook endpoint.
- [List Webhooks](https://docs.riseworks.io/api-reference/b2b-webhooks/list-webhooks.md)
- [Register Webhook](https://docs.riseworks.io/api-reference/b2b-webhooks/register-webhook.md)
- [Retry Delivery](https://docs.riseworks.io/api-reference/b2b-webhooks/retry-delivery.md)
- [Test Webhook](https://docs.riseworks.io/api-reference/b2b-webhooks/test-webhook.md)
- [Update Webhook (v1/v2 cannot be changed; register a new endpoint to switch version)](https://docs.riseworks.io/api-reference/b2b-webhooks/update-webhook-v1v2-cannot-be-changed;-register-a-new-endpoint-to-switch-version.md)
- [Getting API Access](https://docs.riseworks.io/authentication/api-access.md): The two prerequisites for calling the Rise B2B API: your company enabled for the environment, and your wallet authorized on your RiseID.
- [Authentication](https://docs.riseworks.io/authentication/authentication.md): Learn how to authenticate with Rise using the SDK
- [Understanding Private Keys](https://docs.riseworks.io/authentication/private-keys.md): Learn about private keys, their importance, and how to use them securely with Rise B2B API
- [Secondary Wallets for API Operations](https://docs.riseworks.io/authentication/secondary-wallets.md): Learn how to use dedicated secondary wallets for secure API operations with Rise B2B API
- [Entity Balance](https://docs.riseworks.io/concepts/entity-balance.md): Understanding entity balance management in the Rise ecosystem
- [Entity Nanoid](https://docs.riseworks.io/concepts/entity-nanoid.md): Understanding nanoid identifiers and their usage in the Rise ecosystem
- [Environments](https://docs.riseworks.io/concepts/environments.md): Environment configurations for Rise B2B API staging and production
- [Payments](https://docs.riseworks.io/concepts/payments.md): Understand payment flows and security in Rise B2B API
- [RiseID](https://docs.riseworks.io/concepts/riseid.md): Understanding RiseID as the core identity system in the Rise ecosystem
- [Roles & Permissions](https://docs.riseworks.io/concepts/roles.md): Understanding role-based access control and permissions in Rise B2B API
- [Teams](https://docs.riseworks.io/concepts/teams.md): Learn about team management, roles, and permissions in Rise B2B
- [Wallets & Private Keys](https://docs.riseworks.io/concepts/wallets.md): Understanding digital wallets and private keys for Rise authentication
- [Auth Integration Guide](https://docs.riseworks.io/guides/auth-integration.md): End-to-end authentication flow with Rise SDK
- [Error Handling](https://docs.riseworks.io/guides/error-handling.md): Error codes and troubleshooting for Rise B2B API
- [External Entity Payments (Bill Pay)](https://docs.riseworks.io/guides/external-entity-payments.md): Pay vendors and recipients who are not Rise users with instant external-entity payments
- [Migrating from V1 to B2B API](https://docs.riseworks.io/guides/migrating-from-v1.md): Complete guide to migrate from Rise V1 API to the new B2B API
- [Payment Integration Guide](https://docs.riseworks.io/guides/payment-integration.md): Complete guide to integrating payments with Rise B2B API using the SDK
- [Team Management Guide](https://docs.riseworks.io/guides/team-management.md): Manage teams and users with Rise B2B API using the SDK
- [Web3 Integration](https://docs.riseworks.io/guides/web3-integration.md): Integrate wallets and typed data signing with Rise B2B API using the SDK
- [Rise B2B API Documentation](https://docs.riseworks.io/index.md): Build powerful integrations with Rise's blockchain-based global payroll and team management platform
- [Migrated Clients](https://docs.riseworks.io/migrated-clients.md)
- [Quickstart](https://docs.riseworks.io/quickstart.md): Get started with Rise B2B API in minutes
- [SDK Configuration](https://docs.riseworks.io/sdk/configuration.md): Configure the Rise SDK for your environment and use case
- [SDK Installation](https://docs.riseworks.io/sdk/installation.md): Install and set up the Rise SDK for your project
- [AI Coding Skills](https://docs.riseworks.io/sdk/skills/ai-coding-skills.md): Optional AI assistant skills that help generate correct Rise SDK code. Choose your agent, then add skills with one command.
- [Security Best Practices](https://docs.riseworks.io/security/best-practices.md): Comprehensive security best practices for Rise B2B API integration
- [Security Overview](https://docs.riseworks.io/security/overview.md): Comprehensive security guide for Rise B2B API integration
- [Private Key Security](https://docs.riseworks.io/security/private-keys.md): Understanding and securing private keys for Rise B2B API
- [Secondary Wallet Security](https://docs.riseworks.io/security/secondary-wallets.md): Security principles and best practices for using secondary wallets with Rise B2B API
- [Webhook Validation](https://docs.riseworks.io/security/webhook-validation.md): Secure webhook signature validation for Rise B2B API
- [Authentication](https://docs.riseworks.io/v1-legacy/authentication/authentication.md): SIWE authentication for these endpoints
- [Invites](https://docs.riseworks.io/v1-legacy/invites/invites.md): List and send contractor/client invites
- [Overview](https://docs.riseworks.io/v1-legacy/overview.md): How the original Rise V1 API endpoints keep working after migration to the B2B platform
- [Payments](https://docs.riseworks.io/v1-legacy/payments/payments.md): Instant payments, batch payments, payment intents, and payment history
- [Quickstart](https://docs.riseworks.io/v1-legacy/quickstart.md): Authenticate and send your first payment in under 10 minutes
- [RiseID Balance](https://docs.riseworks.io/v1-legacy/riseid-balance/riseid-balance.md): Query on-chain USD balance for a team, user, or company RiseID
- [Teams & Talent](https://docs.riseworks.io/v1-legacy/teams/teams.md): List teams and manage contractors
- [Troubleshooting](https://docs.riseworks.io/v1-legacy/troubleshooting.md): Diagnose and fix common issues across these endpoints
- [Deposit Events](https://docs.riseworks.io/webhooks/events/deposit.md): Webhook events related to fund deposits and incoming transfers
- [Invite Events](https://docs.riseworks.io/webhooks/events/invite.md): Webhook events for the full invitation lifecycle — accepted, rejected, and expired
- [Payment Events](https://docs.riseworks.io/webhooks/events/payment.md): Webhook events related to payment processing and execution
- [Security Events](https://docs.riseworks.io/webhooks/events/security.md): Webhook events related to security, fraud detection, and compliance monitoring
- [Webhook Overview](https://docs.riseworks.io/webhooks/getting-started/overview.md): What are webhooks and why use them with Rise
- [Webhook Quick Start](https://docs.riseworks.io/webhooks/getting-started/quickstart.md): Set up your first Rise webhook in under 10 minutes
- [Security and Verification](https://docs.riseworks.io/webhooks/getting-started/security.md): How to verify webhook authenticity and secure your endpoints
- [Event Types Overview](https://docs.riseworks.io/webhooks/implementation/event-types.md): Complete reference of all available events and their data structures
- [Webhook Management](https://docs.riseworks.io/webhooks/implementation/management.md): Creating, updating, and managing your webhook endpoints
- [Testing Webhooks](https://docs.riseworks.io/webhooks/implementation/testing.md): How to test your webhook endpoints during development
- [Delivery and Retries](https://docs.riseworks.io/webhooks/operations/delivery.md): Understanding webhook delivery mechanics and retry policies
- [Monitoring Webhooks](https://docs.riseworks.io/webhooks/operations/monitoring.md): Track webhook performance and health in production
- [Troubleshooting Webhooks](https://docs.riseworks.io/webhooks/operations/troubleshooting.md): Diagnose and resolve common webhook issues
- [Migration Guide](https://docs.riseworks.io/webhooks/reference/migration.md): Upgrading from Rise Webhooks v1 to v2

## OpenAPI Specs

- [openapi-v1](https://docs.riseworks.io/openapi/openapi-v1.yaml)
- [openapi](https://docs.riseworks.io/api-reference/openapi.yaml)