---
title: "Check whether a name on the platform domain looks free"
method: GET
path: "/onboarding/availability"
tags: ["public"]
---

# Check whether a name on the platform domain looks free

`GET /onboarding/availability`

## Request

- Base URL: `https://api.mailly.site` (the document declares no server; this is the origin it was published from)
- URL: `https://api.mailly.site/onboarding/availability`
- Auth: none required

Advisory check for the web page; it reserves nothing. Agents should call /start directly and handle 409 name_taken.

## Query parameters

- `name` string, required

## Response `200`

Whether the name can currently be reserved

- object
  - `success` boolean, required
  - `name` string, required
  - `address` string, required
  - `available` boolean, required
  - `code` 'invalid' | 'short' | 'reserved' | 'taken'

## Other responses

- `202`: Waiting for human approval
- `400`: Invalid request
- `401`: Authentication required
- `403`: Not allowed
- `409`: Address unavailable or request already handled
- `410`: Request expired
- `429`: Too many requests
- `503`: Temporarily unavailable

---

[API](https://skmtc.dev/mailly/apis/mailly-api.md) · [All operations](https://skmtc.dev/mailly/apis/mailly-api/llms.txt) · [OpenAPI document](https://skmtc.dev/mailly/apis/mailly-api/revisions/1ceb29637301?raw)