# Verificar disponibilidade de @username

`POST /instance/username/check`

Pasta: **Instancia**

## Autenticação

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

## Descrição

# Verificar disponibilidade de @username

Valida se um @username candidato está disponível. A API guarda internamente o `session_id` do WhatsApp por ~30 minutos para o próximo set.

Chame este endpoint antes de `POST /instance/username`.

## Endpoint

```http
POST {{baseUrl}}/instance/username/check
```

## Autenticação

Header da instância:

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

## Corpo da requisição

| Campo | Tipo | Obrigatório | Descrição |
| --- | --- | --- | --- |
| `username` | string | Sim | Username sem `@` (ex.: `minhaempresa`). |

## Exemplo de Requisição

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

## Resposta de Sucesso

```json
{
  "success": true,
  "check": {
    "result": "available",
    "username": "minhaempresa",
    "ok": true
  }
}
```

## Erros comuns

- `401` — header `token` ausente ou inválido
- `400` — `username` ausente
- `500` — sessão offline ou username inválido no WhatsApp

## Corpo (exemplo)

```json
{
  "username": "minhaempresa"
}
```

## cURL

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

---

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