Skip to main content
This page is a preflight check. Run through it before you start integrating so you are not stopped by a missing organization, an API key you do not have yet, or an integration path that does not fit your product. If you already know what Turtle Earn is, skip ahead to Curate opportunities. If you are new, start with the Turtle Earn overview.

​
Prerequisites

An approved organization in the Client Portal

Your organization must be set up and approved as a distribution partner in the Client Portal. Organization setup is required for both integration paths.

A distributor ID

Your distributor ID is the identifier every deposit is attributed to. One organization can have more than one distributor, for example a separate ID for your web and mobile surfaces. Find your distributor ID in the Distribution Dashboard.

An API key (API path only)

If you integrate through the Earn API, you need a publishable API key scoped to your organization. Share links do not require an API key. Create and manage keys as described in API keys.
Use a publishable key (pk_live_) for client-side calls. Keep secret keys server-side only. The canonical auth header is being confirmed.

A supported opportunity for your audience

Decide which opportunities you want to put in front of users. Share links work only with Turtle featured deals; the Earn API covers the full catalog. See Curate opportunities.

​
Decisions to make before you launch

Have answers to these ready before you integrate.
You choose which opportunities from the Turtle catalog to surface, and you can tailor the set to your audience, for example stablecoin vaults only or a single chain. Have a shortlist before you launch.Curate opportunities walks through browsing the catalog and curating your set.
Deposits made through the Earn API require the user to be a registered Turtle member. If you build the API path, plan where membership registration fits in your flow. Share links handle this inside the Turtle app, so you do not build it yourself.See Register a wallet for the membership flow.

​
If you are not approved or your opportunity is not supported

If your organization is not yet approved as a distributor, or the opportunity you want to offer is not in the catalog, reach out to the Turtle team through the Client Portal.

​
Next steps

Curate opportunities

Pick which opportunities to put in front of your users.

Share links

Start with the no-code path and a featured deal.