Skip to main content
POST
Predict from a username

When to use forceToGenderize

By default Finowl intelligence only predicts when it finds a recognizable name in the username, such as jsmith_92 or maria.dev. Set forceToGenderize to true to also try handles without an obvious name, such as prenses.
forceToGenderize works only with the default AI mode (fallback). Combining it with ai_mode off or always returns 400 invalid_input.

Authorizations

Authorization
string
header
required

Your Finowl API key, for example finowl_3f9a.... Create keys in the dashboard under API Keys.

Body

application/json
username
string
required

The username or handle to analyze.

Required string length: 1 - 1024
Example:

"prenses"

country
string

Optional ISO 3166-1 alpha-2 country hint, such as US or TR. Improves accuracy for names whose gender varies by country.

Pattern: ^[A-Za-z]{2}$
Example:

"US"

forceToGenderize
boolean
default:false

Try to predict even when the input does not look like a name. Cannot be combined with ai_mode off or always.

options
object

Response

The prediction completed. An unknown result is still a successful response.

data
object
required

A gender estimate. result_status and gender are always present. Other fields, such as confidence and country, are included when available, and new fields may be added.