Skip to main content

Check Name

The /user/leader/name endpoint allows you to check the availability of a leader name. This is useful for ensuring that a desired leader name is not already taken before attempting to register or update a leader profile.

Method​

GET /user/leader/name

Query Parameters​

  • name — the desired leader name to check for availability.

Response​

{
  "status": 200,
  "data": {
    "available": true
  }
}

Example Request​

GET /user/leader/name?name=desiredLeaderName
Host: api.example.com

Example Response​

{
  "status": 200,
  "data": {
    "available": true
  }
}

Description​

The response indicates whether the specified leader name is available for use. If available is true, the name can be registered; if false, the name is already taken and cannot be used.

This endpoint is particularly useful for users who want to create or update their leader profile without the risk of name conflicts. It helps maintain a unique identity for leaders within the platform.

Ensure to check the availability of a leader name before attempting to register or update your profile to avoid conflicts with existing names.