Skip to main content
POST
Read a display name and return a signal

Authorizations

Authorization
string
header
required

API key as Bearer token

Body

application/json
name
string
required

The display name, as the player typed it.

Required string length: 1 - 64
strictness
enum<string>

How readily a doubtful reading is acted on. A clear concern is acted on at every level. Default balanced.

Available options:
cautious,
balanced,
strict
context
object

Response

200 - application/json

Default Response

signal
enum<string>

A signal about the name, not a verdict on the person.

Available options:
none,
low,
review
categories
enum<string>[]

From a closed list. Empty unless the signal is review.

Available options:
self_harm_promotion,
impersonation_of_staff_or_support,
hate_or_extremist_reference,
sexualised,
seeks_older_contact,
harassment_of_named_person,
contact_detail_or_off_platform_lure,
age_disclosure
parts
object[]

How each part of the name was read.

rationale
string

Why, in plain words a moderator can act on. No slurs are reproduced.

recommendation
enum<string>

Advice to the platform, which decides. Never an emergency action: a name alone cannot carry that.

Available options:
allow,
allow_and_watch,
ask_to_rename,
hold_for_review
recommendation_detail
string

One sentence on what the recommendation means.

confidence
number

0 to 1. 0 when the reading did not complete.

language
string | null
strictness
enum<string>
Available options:
cautious,
balanced,
strict
reading_complete
boolean

False when the reading did not finish. Then signal is none because nothing was analysed, not because nothing was found; retry.

credits_used
number

1 for a reading, 0 when the reading did not complete.