Skip to main content

​
Prerequisites

Before integrating with Sonar, ensure you have:

Echo Application

An approved application to use Sonar. Apply here if you haven’t already.

Technical Setup

You will need to be able to create a website to integrate with Sonar.

Legal Requirements

Understanding of your jurisdiction’s securities laws and compliance requirements for token sales.

​
Step 1 - Access the Founder Dashboard

Once your application is approved, access the Echo Founder Dashboard to:
  1. Configure your sale: Configure basic sale parameters
  2. Configure compliance settings: Set KYC/KYB and accreditation requirements
  3. Get integration credentials: Copy your Sale UUID and OAuth Client UUID from the integration section

​
Step 2 - Configure Your Sale Settings

In the founder dashboard, configure settings for your sale. You can change these later on if you need to.

​
Step 3 - Sale Contract

For standard sale configurations, Sonar deploys and manages the sale contract for you. This includes the SettlementSale contract which supports both fixed-price and auction sales. If you have specific requirements that aren’t covered by the standard contract, you can build a custom contract that validates Sonar purchase permits.
Contract deployment is coordinated as part of your sale setup. Contact support@echo.xyz if you have questions about your contract options.

​
Step 4 - Setup your website

The easiest way to get started is to clone one of our example websites:
Copy or edit the .env.local file to set your sale UUID and OAuth client UUID. This template is configured to use Next.js, React, and Wagmi. It makes use of the @echoxyz/sonar-core and @echoxyz/sonar-react libraries to integrate Sonar. If you want to use a different framework, you can use the @echoxyz/sonar-core library directly. Alternatively, you can create your own website in any framework you like.
  • Wrap your app with the Sonar provider alongside your wallet provider
  • Create a page at your redirect URI to handle OAuth callbacks
  • Add authentication buttons to your app

​
Step 5 - Test the Integration

Make sure your website is configured and running.
  1. Test OAuth flow
    • Click “Sign in with Sonar”
    • Complete authentication on Sonar
    • Verify you’re redirected back successfully
  2. Check entity status
    • Connect a wallet
    • Verify entity data loads correctly
    • Test with different wallet addresses

​
Next Steps

Now that you have basic integration working, choose your implementation path.

​
Choose Your Integration Approach

Frontend-Only

Simpler setup. OAuth tokens stored in browser. Good for most projects.

Frontend with Backend

More secure. Tokens managed server-side. Required if you need to fetch auction data (e.g., clearing price) from the backend API.

​
Using a Custom Contract?

Most projects use the standard SettlementSale contract that Sonar deploys. If you have specific requirements:

Custom Contracts

Build your own contract with Sonar permit validation

​
Learn More

Key Concepts

Understand entities, permits, and the compliance flow

​
Getting Help

If you encounter issues during setup: