In this quickstart, you’ll learn how to integrate your Web3 wallet or dApp with Onboard Connect to provide easy and reliable onramps and offramps to your users.

In a nutshell

To support on & offramps using Connect, initiate a transaction using a redirect URL embedded with your API key and other trade parameters accessible from the Exchange API.

​
Getting Started

1

Sign up to Connect

Onboard Connect requires account activation to ensure a secure and compliant integration experience. Here’s how to get started:

  • Send an activation request: Fill out the Onboard Connect onboarding form. In your email, please specify your use case and provide details about your product.
  • Get set up quickly: Our team will review your application and guide you through the next steps. Once approved, you’ll receive access to your Business Dashboard.

The Business Dashboard is your central hub for:

  • Generating your unique API key (used in the redirect link).
  • Configuring fees & additional settings for your integration.
  • Tracking your onramp and offramp transactions.
2

Obtain your API Key

Log in to the Business Dashboard to generate & retrieve your API key. This key is a crucial component of the redirect link used to initiate transactions.

3

Build your redirect link

The redirect link provides a simple and convenient on & offramp flow, allowing you to integrate Onboard without making major changes to your application.

Redirect link format

Explanation

  • <YOUR_API_KEY>: Replace this placeholder with your actual API key obtained from the Business Dashboard.
  • product=web3: This specifies the product type (web3 in this case).
  • <TRADE_QUERY_PARAMETERS>: These are a set of required & optional parameters that allow you to control the onramp and offramp experience for your users. You’ll find details about these parameters in the section below.

The redirect link resolves to a trade URL, through which an order can be initiated using the trade parameters specified in the request query.

Mobile app integration

For mobile apps, the redirect link can be used within an embedded browser or webview component.

​
What’s Next?

View the query parameters that allow you to customize your users’ trading experience when using Connect.

OverviewQuery Parameters