Check if Login (Nickname) Is Available

The GET /api/users/ByNickname endpoint checks whether a specific nickname is already registered in the Netevia platform. It returns a boolean indicating availability, making it useful for account creation flows, login recovery, and user management workflows.

This endpoint requires a valid Bearer token and a query parameter containing the nickname to check.

Endpoint

GET /api/users/ByNickname

Authentication

Bearer token required. Obtain via:

POST https://api.banking.netevia.dev/api/auth/v2

Include in header: Authorization: Bearer {token}
Token lifetime: 10 minutes. Refresh via POST /api/auth/refresh.

When to use

Use this endpoint before creating a new user account to verify that the desired nickname is not already in use. It is also useful during account recovery flows to confirm whether a given nickname exists in the system, and for partner-side validation when allowing customers to choose or update their login nickname.

Query Parameters

Response

200 OK

Returns a single boolean value.

true

or

false

Error Codes

Common Mistakes

• Omitting the login query parameter entirely will result in a 400 error; the parameter is required.
• Confusing the boolean response semantics: true means the nickname is taken, not that it is free. Build your validation logic accordingly.
• Using an expired token — tokens are valid for only 10 minutes; ensure you refresh before making the call.
• Sending the nickname in the request body instead of as a query parameter; this endpoint uses a query string, not a JSON body.

Related Endpoints

• POST /api/auth/v2 — Obtain a Bearer token using username, password, and partnerId.
• POST /api/auth/refresh — Refresh an existing Bearer token before it expires.

Example

curl -X GET "https://api.banking.netevia.dev/api/users/ByNickname?login=johndoe" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/json"