Username Profanity API

About the Username Profanity API

A username moderation API for sign-up forms. Username Profanity Checker analyses the username as a whole, split on underscores, separators and camelCase, and collapsed when it is letter-spaced, so decorated and leetspeak profanity is caught without flagging real names. Paid plans return the matched words and their categories, whether it impersonates a reserved name such as admin or support, any email, URL or phone number it contains, the username with the offending part masked, and isAllowed, one verdict that combines all of them.

What people use it for

Account Registration Screen

When visitors submit a signup form, frontend forms check the handle and prompt the user for an alternative if flagged.

Multiplayer Gamertag Moderation

Game servers inspect player handles during character creation to reject offensive gamertags before letting players join public lobbies.

Community Profile Updates

To stop disruptive members from renaming accounts to slurs, community moderators automatically block profane handle changes across social feeds.

Event Badge Printing

Event organizers screen attendee display names before printing badges or rendering leaderboards to prevent objectionable text on public screens.

Ways to call it

One endpoint, many ways in — REST with JSON, XML, YAML and CSV, plus GraphQL and an MCP interface for AI agents.

JSON

Default REST response

XML

Markup format

YAML

Human-readable

CSV

Tabular export

Beta

GraphQL

Query language

New

MCP

For AI agents

Request parameters — GET /v1/usernameprofanity

Sent in the query string. Premium parameters are accepted on every plan but only take effect on plans that include them. Anything not listed here is dropped rather than passed through.

Required

1
2

curl "https://api.apiverve.com/v1/usernameprofanity?username=b00bs" \
  -H "x-api-key: YOUR_API_KEY"

Authentication

Send your key in the x-api-key header. That is the only auth step — no token exchange, and no per-endpoint scope to configure.

Response — GET /v1/usernameprofanity

Every APIVerve endpoint returns the same three top-level keys, so one response handler covers your whole integration: status, error and data. Only data changes shape.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

{
  "status": "ok",
  "error": null,
  "data": {
    "username": "b00bs",
    "isProfane": true,
    "matchedWords": [
      "boob"
    ],
    "categories": [
      "sexual"
    ],
    "isReserved": false,
    "reservedTerm": null,
    "contactInfo": [],
    "censored": "b***s",
    "isAllowed": false
  }
}

Response fields

Paths are relative to data. Premium fields are absent rather than zeroed on plans that do not include them, so check for presence instead of comparing to 0.

Response headers

Every response carries your balance, so your own code always knows where it stands without polling anything. All four are exposed to browsers through CORS.

Errors

Read the HTTP status first, then error for the specific reason. The body names the parameter that has to change.

What a call costs — 2 credits per call

Credits are shared across every APIVerve API — one balance, one key, one bill. Failed requests never count against it, so a rejected input costs nothing.

Calls are what the credits buy at this API's rate — spend them here, on any of the other APIs, or across both. Nothing is reserved per endpoint.

Zero-code embed — one snippet, no backend

Drop an interactive Username Profanity form onto any page. The widget calls the API for you, so no key ever appears in your markup and there is nothing to deploy.

Changelog — Username Profanity API

Every change to this endpoint, newest first. Breaking changes ship as a new version and the previous one keeps serving — response fields are added, never removed or retyped in place, so an integration written against v1 keeps working.

Currently v1