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

# Welcome to Dock

> Build Discord to Roblox verification, account linking, alt detection, and server automation with Dock.

Dock helps Discord communities connect members to Roblox accounts, keep server roles accurate, and build safer moderation workflows.

<Info>
  Use the Dock API to look up verified Roblox and Discord account links from your backend. Keep API keys private and send requests from trusted server-side code.
</Info>

## What you can build

<Columns cols={2}>
  <Card title="Account linking" icon="link">
    Look up Discord to Roblox and Roblox to Discord mappings from your own backend.
  </Card>

  <Card title="Verification flows" icon="shield">
    Create verification sessions, redirect users to Dock, and read completion by polling or SSE.
  </Card>

  <Card title="Alt detection" icon="shield">
    Use Premium detection endpoints to review possible alternate accounts and risk signals.
  </Card>

  <Card title="Bot configuration" icon="pencil">
    Configure verification, welcome, permissions, and group binding settings from Discord with `/config`.
  </Card>
</Columns>

## Base URL

```text theme={null}
https://api.docksys.xyz
```

Use relative endpoint paths from the docs with this base URL. For example, `GET /api/v1/public/discord-to-roblox` becomes:

```text theme={null}
https://api.docksys.xyz/api/v1/public/discord-to-roblox
```

## Quick start

<Steps>
  <Step title="Create an API key">
    Sign in to Dock, create an API key for your server, and store the key on your backend.
  </Step>

  <Step title="Authenticate requests">
    Send the key with `Authorization: Bearer YOUR_API_KEY`. Never ship API keys in browser code, public repositories, or client-side apps.
  </Step>

  <Step title="Make your first lookup">
    Use `/api/v1/public/discord-to-roblox` for Discord to Roblox lookups and `/api/v1/public/roblox-to-discord` for Roblox to Discord lookups.
  </Step>

  <Step title="Handle limits and errors">
    Read `X-RateLimit-*` headers and `Retry-After` so your integration can back off cleanly.
  </Step>
</Steps>

## First request

<CodeGroup>
  ```bash cURL theme={null}
  curl --request GET \
    --url "https://api.docksys.xyz/api/v1/public/discord-to-roblox?discordId=123456789012345678&guildId=987654321098765432" \
    --header "Authorization: Bearer YOUR_API_KEY"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    "https://api.docksys.xyz/api/v1/public/discord-to-roblox?discordId=123456789012345678&guildId=987654321098765432",
    {
      headers: {
        Authorization: `Bearer ${process.env.DOCK_API_KEY}`,
      },
    },
  );

  const payload = await response.json();
  ```

  ```python Python theme={null}
  import os
  import requests

  response = requests.get(
      "https://api.docksys.xyz/api/v1/public/discord-to-roblox",
      params={
          "discordId": "123456789012345678",
          "guildId": "987654321098765432",
      },
      headers={"Authorization": f"Bearer {os.environ['DOCK_API_KEY']}"},
  )

  payload = response.json()
  ```
</CodeGroup>

## Recommended next pages

<Columns cols={3}>
  <Card title="Authentication" icon="key" href="/api/authentication">
    Learn how API keys work and how to keep them safe.
  </Card>

  <Card title="API Reference" icon="code">
    Review available API endpoints, parameters, and responses.
  </Card>

  <Card title="Bot config" icon="pencil" href="/bot/config-command">
    Learn how to configure Dock from Discord with `/config`.
  </Card>
</Columns>

<Note>
  By using Dock, you agree to the [Terms of Service](https://docksys.xyz/terms) and acknowledge the [Privacy Policy](https://docksys.xyz/privacy).
</Note>