Skip to main content
POST
Username analysis feedback

Authorizations

Authorization
string
header
default:ApiKey <your-api-key>
required

API key authentication. Provide your key in the Authorization header with the ApiKey scheme:

Body

application/json

Feedback on a username analysis. Provide at least one of classificationsToAdd, classificationsToRemove, or notes — a request with none of the three is considered invalid.

analyzeRequest
object
required

The analyze request body you originally sent to POST /analyze/v1/username. Send it unchanged so Bodyguard can identify the exact analysis your feedback refers to. It already carries the source the username belongs to.

classificationsToRemove
string[]

Classifications Bodyguard returned that you judge do not apply to this content. See the username taxonomy for the full list.

classificationsToAdd
string[]

Classifications you judge apply to this content but that Bodyguard did not return. See the username taxonomy for the full list.

Example:
notes
string

Notes will help explain why you judge the content differently from the classification received. They help Bodyguard's moderation team understand your feedback and can lead to a quicker edit. Note-only feedback is valid and will be reviewed by our team.

confidence
enum<string>

Confidence scores reflect a feedback source's reliability based on its moderation expertise, helping Bodyguard prioritize feedback. Scores range from LOW to VERY_HIGH: end-user reports may be LOW, while Trust & Safety feedback may be VERY_HIGH. This field is optional — omit it if reliability can't be assessed.

Available options:
LOW,
MEDIUM,
HIGH,
VERY_HIGH

Response

200 - application/json

Feedback recorded.

id
string<uuid>
required

Bodyguard's identifier for this feedback.