# Verificar disponibilidade de username

`POST /user/username/check`

Pasta: **Usuários**

## Autenticação

```http
token: {{token}}
```

## Descrição

# Verificar disponibilidade de username

Verifica se um username está disponível antes de configurá-lo na conta. Use no fluxo de onboarding/edição de perfil para validar em tempo real, com sugestões quando indisponível.

## Endpoint

`POST {{baseUrl}}/user/username/check`

## Autenticação

Envie o token da instância no header `token: {{token}}`.

## Corpo da requisição

| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| `username` | string | Sim* | Verificação única. Informe `username` ou `usernames`. |
| `usernames` | array<string> | Sim* | Verificação em lote; muda o formato da resposta (ver Observações). |
| `include_suggestions` | boolean | Não | Inclui sugestões alternativas quando indisponível. Padrão `true` na verificação única. |

## Exemplo de Requisição

```bash
curl --request POST '{{baseUrl}}/user/username/check' \
  --header 'token: {{token}}' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "username": "foo",
  "include_suggestions": true
}'
```

## Resposta de Sucesso

```json
{
  "success": true,
  "available": false,
  "username": "foo",
  "suggestions": ["foo123"],
  "rejection_reasons": []
}
```

## Erros comuns

- `401 Unauthorized`: o header `token` não foi enviado ou é inválido.
- `400 Bad Request`: o JSON está malformado ou contém um identificador inválido.
- `500 Internal Server Error`: a conexão com o WhatsApp falhou ou a operação foi recusada.

## Observações

* Informe **um** de: `username` (verificação única) ou `usernames` (lote). Com `usernames: ["foo","bar"]`, a resposta muda para `{ success, result }` com o payload bruto de verificação em lote.

## Corpo (exemplo)

```json
{
  "username": "foo"
}
```

## cURL

```bash
curl -X POST "{{baseUrl}}/user/username/check" \
  -H "token: {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "username": "foo"
}'
```

---

[Índice da pasta](./index.md) · [Índice geral](../index.md) · [UI](https://gozap.dev/docs?op=usuarios/verificar-disponibilidade-de-username)