# Consulta CEP com ViaCEP

{% hint style="warning" %}
O Floui não assume qualquer responsabilidade ou controle sobre a administração dos dados referenciados pela API fornecida pela ViaCEP, tampouco oferece garantias quanto à estabilidade das requisições. Sugerimos que você se familiarize com os campos e padrões de retorno consultando informações adicionais em <https://viacep.com.br/>.
{% endhint %}

{% tabs %}
{% tab title="Parâmetros" %}

<figure><img src="/files/KtB4QzkIs1iXozgTqSAh" alt=""><figcaption><p>Parâmetros de configuração.</p></figcaption></figure>

| Campo             | Tipo           | Descrição                                                                                              |
| ----------------- | -------------- | ------------------------------------------------------------------------------------------------------ |
| Descrição         | Campo de texto | Descrição visual do conector no editor de fluxos                                                       |
| CEP para pesquisa | Campo de texto | Define o CEP de busca válido no território nacional com 8 dígitos (com ou sem pontuação).              |
| Output Path       | Campo de texto | Refere-se ao caminho do resultado da requisição na saída do conector no contexto de execução do fluxo. |
| {% endtab %}      |                |                                                                                                        |

{% tab title="Payload" %}

## Sucesso

Por padrão, o conector retornará a seguinte estrutura JSON em caso de sucesso, incluindo não apenas os dados do CEP consultado, mas também informações detalhadas da requisição ao ViaCEP, como `request`, `response` e `headers`.

<figure><img src="/files/QoYzoATNTTZG5UaAWHbf" alt=""><figcaption><p>Sucesso na consulta de CEP</p></figcaption></figure>

## Erro

Se o CEP informado não for encontrado, a API retornará uma mensagem de erro indicando a falha na consulta.

<figure><img src="/files/48pyPDMoLOPlc292b8zw" alt=""><figcaption><p>Erro na consulta de CEP</p></figcaption></figure>
{% endtab %}
{% endtabs %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.floui.io/guia/conectores/categorias/servicos-externos/viacep/consulta-cep-com-viacep.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.