> ## Documentation Index
> Fetch the complete documentation index at: https://yieldxyz.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Onboarding

> Set up your project, generate credentials, configure the dashboard, and integrate the API.

Onboarding to yield.xyz moves through four stages: create your account and project, generate API credentials, configure dashboard settings for your use case, and integrate the API or widget.

## 1. Account and project setup

Everything in yield.xyz is scoped to a **project**. A project represents one integration or business line and holds its own enabled yields, fee configuration, and API keys.

<Steps>
  <Step title="Sign in to the dashboard">
    Sign in at [dashboard.yield.xyz](https://dashboard.yield.xyz).
  </Step>

  <Step title="Create a project">
    Create a project for your integration. A fresh project starts with no yields enabled and no API keys.
  </Step>

  <Step title="Enable yields">
    Select the yields to activate for the project. You can filter by network, token, and provider.
  </Step>
</Steps>

<Note>
  `GET /v1/yields` returns only the yields enabled for your project, so a fresh project with nothing enabled returns an empty list. Calling an action on a yield that isn't enabled for your project returns `400 Bad Request` with `"is not enabled for this project"`, not a 404. Enable yields in the dashboard before testing discovery or actions.
</Note>

## 2. API credentials

Create an API key on your project page and send it as the `x-api-key` header on every request. The key is shown once; store it in a secrets manager. See [Projects & API keys](/documentation/get-started/projects-api-keys) for scoping, rotation, and expiry.

## 3. Dashboard configuration

Configure the settings that shape how your project behaves before going to production. Enterprise teams can automate projects, keys, enabled yields, and fees through [Programmatic access](/documentation/advanced-setup/programmatic-access). Each setting is covered in Advanced setup:

| Configuration | What it controls |
| - | - |
| [Dashboard overview](/documentation/advanced-setup/dashboard/index) | Projects, access control, compliance, fees, and infrastructure settings |
| [Payout wallets](/documentation/advanced-setup/dashboard/payout-wallets) | Where your fee revenue is paid out |
| [Discretionary fees](/documentation/advanced-setup/dashboard/discretionary-fees) | Deposit, performance, and management fees applied to your project's actions |
| [Yield blocking](/documentation/advanced-setup/dashboard/yield-blocking) | Restricting which enabled yields end users can access |
| [Custom RPC URIs](/documentation/advanced-setup/dashboard/custom-rpc-uris) | Bringing your own node endpoints per network |
| [Geoblocking](/documentation/advanced-setup/geo-blocking/index) | Restricting yield actions by country or region |
| [Single sign-on](/documentation/advanced-setup/sso) | Signing in to the dashboard through your identity provider |
| [Roles & permissions](/documentation/advanced-setup/roles-permissions) | Scoping teammate access to the dashboard |

## 4. Integration work

With a project, enabled yields, and an API key in place, integrate against the Yield API or widget.

<Columns cols={3}>
  <Card title="Quickstart" icon="rocket" href="/documentation/get-started/quickstart">
    Discover a yield, request an action, sign, and submit in one walkthrough.
  </Card>

  <Card title="AI & Agents" icon="robot" href="/documentation/ai-agents/index">
    Use yield.xyz agent skills and MCP tooling with AI coding tools.
  </Card>

  <Card title="Guides" icon="book" href="/guides/earn/enter-exit-flows">
    Implementation guides for enter, exit, and manage flows.
  </Card>
</Columns>

## Next steps

<Columns cols={2}>
  <Card title="Authentication" icon="lock" href="/api-reference/authentication">
    Header format and error responses for authenticated requests.
  </Card>

  <Card title="Projects & API keys" icon="key" href="/documentation/get-started/projects-api-keys">
    Understand project scoping and key management in depth.
  </Card>
</Columns>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.