> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cawme.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Configurar Instância

> GET /v1/instances/:instanceId/configure — Obtém o QR code para vincular um número de WhatsApp

`GET /v1/instances/:instanceId/configure`

Retorna um QR code codificado em Base64 que você escaneia com o WhatsApp para vincular um número de telefone a esta instância. Após escanear, o status da instância transita para `CONFIGURED` e eventualmente para `ACTIVE`.

## Requisição

### Cabeçalhos

| Cabeçalho       | Valor            |
| --------------- | ---------------- |
| `Authorization` | `Bearer <token>` |

### Parâmetros de caminho

| Parâmetro    | Tipo     | Descrição                      |
| ------------ | -------- | ------------------------------ |
| `instanceId` | `string` | O ID da instância a configurar |

## Resposta `200`

| Campo          | Tipo     | Descrição                              |
| -------------- | -------- | -------------------------------------- |
| `instanceId`   | `string` | O ID da instância                      |
| `qrCodeBase64` | `string` | Imagem do QR code codificada em Base64 |
| `message`      | `string` | Mensagem de status adicional           |

```json theme={null}
{
  "instanceId": "inst_abc123",
  "qrCodeBase64": "iVBORw0KGgoAAAANSUhEUgAA...",
  "message": "Escaneie com o WhatsApp para vincular seu número"
}
```

## Decodificando o QR code

Converta `qrCodeBase64` em uma imagem e exiba para escaneamento:

<Tabs>
  <Tab title="JavaScript">
    ```javascript theme={null}
    const img = document.createElement("img");
    img.src = `data:image/png;base64,${response.qrCodeBase64}`;
    document.body.appendChild(img);
    ```
  </Tab>

  <Tab title="Python">
    ```python theme={null}
    import base64

    with open("qr.png", "wb") as f:
        f.write(base64.b64decode(response["qrCodeBase64"]))
    ```
  </Tab>
</Tabs>

## Erros

| Código | Descrição                                           |
| ------ | --------------------------------------------------- |
| `401`  | Token ausente ou inválido                           |
| `404`  | Instância não encontrada ou não pertence ao usuário |

## Exemplo

```bash theme={null}
curl https://cawme.com/api/v1/instances/inst_abc123/configure \
  -H "Authorization: Bearer <token>"
```
