---
title: "Check Name"
method: POST
path: "/api/users/check-name"
tags: ["users"]
---

# Check Name

`POST /api/users/check-name`

## Request

- Base URL: `https://api.usecreed.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.usecreed.com/api/users/check-name`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/usecreed/apis/creed-api/docs/api/users/check-name/post.ts> (a function with typed inputs; its response is checked against the schema)

Moderate a user or companion name before the client saves it.
Only a flagged result disallows the name; moderation errors and timeouts allow it.

## Headers

- `x-user-id` string, nullable

## Request body

- CheckNameRequest
  - `name` string, required

## Response `200`

Successful Response

- CheckNameResponse
  - `allowed` boolean, required

## Other responses

- `422`: Validation Error

## Changes

- **2026-10-27** `a4b0a04034ad`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/usecreed/apis/creed-api/changes/api/users/check-name/post.md)

---

[API](https://skmtc.dev/usecreed/apis/creed-api.md) - [All operations](https://skmtc.dev/usecreed/apis/creed-api/llms.txt) - [OpenAPI document](https://skmtc.dev/usecreed/apis/creed-api/revisions/9a6e25b21a53?raw)