O endpoint /api/BuscaCEP permite consultar endereços a partir de um CEP ou descrição, retornando informações como logradouro, bairro, cidade, UF e demais dados associados.
Correios - Busca CEP
A Consulta Busca CEP permite integrar ao sistema a funcionalidade oficial de consulta de endereços dos Correios, reproduzindo a mesma experiência disponível no site dos Correios na opção Busca CEP.
Por meio dela, é possível obter informações confiáveis e atualizadas a partir de um CEP informado, como logradouro, bairro, cidade, estado (UF) e demais dados cadastrais associados.
Essa API é amplamente utilizada em sistemas de cadastro de clientes, e-commerce, plataformas de logística, emissão de documentos, formulários online e qualquer aplicação que exija validação e padronização de endereços no Brasil.
Casos de Uso
- Onboarding de clientes e fornecedores
- Preenchimento automático de endereços em cadastros
- Validação de CEP em e-commerces
- Integração com sistemas logísticos e de entrega
- Padronização de dados cadastrais.
Aplicações
- Onboarding de Clientes e Fornecedores
Benefícios
- Acesso à base oficial dos Correios
- Dados atualizados e confiáveis de endereços
- Redução de erros em cadastros manuais
- Melhoria na eficiência logística
- Integração simples e rápida.
URL Base
A API está hospedada no seguinte endereço:
https://apiv3.directd.com.br/api/CorreiosBuscaCEPEndpoint
GET https://apiv3.directd.com.br/api/CorreiosBuscaCEP?Endereco={0}&Token=Seu_TokenDescrição: Endpoint para realizar consultas Correios - Busca CEP.
Nota: Esta consulta não gera comprovantes.
Campos Retornados
- Bairro: Bairro do endereço
- CEP: Número CEP do endereço
- Cidade: Cidade do registro em questão
- Complemento: Complemento do endereço do registro em questão
- Endereço Consultado: Informa o endereço consultado.
- Lista de Endereço: Lista os endereços do indivíduo
- Logradouro: Nome da rua, avenida, travessa, alameda ou outros onde está localizado o endereço.
- Nome da Unidade: Informa o nome da unidade.
- Observação do CEP: Informa observações sobre o CEP.
- Quantidade de Endereços: Informa a quantidade de endereços encontrados.
- Tipo do CEP: Informa o tipo do CEP.
- UF: Unidade Federativa (estado) referente ao registro
Parâmetros
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
ENDERECO | string | Sim | |
TOKEN | string | Sim | O parâmetro TOKEN é essencial para efetuar esta consulta. Em caso de dúvidas, por favor, entre em contato com: suporte@directd.com.br |
Exemplo de Resposta
{
"metaDados": {
"consultaNome": "string",
"consultaUid": "string",
"chave": "string",
"usuario": "string",
"mensagem": "string",
"ip": "string",
"resultadoId": 0,
"resultado": "string",
"apiVersao": "v3",
"enviarCallback": false,
"gerarComprovante": false,
"urlComprovante": "string",
"assincrono": true,
"data": "dd/MM/yyyy HH:mm:ss",
"tempoExecucaoMs": 0
},
"retorno": {
"enderecoConsultado": "string",
"quantidadeEnderecos": 0,
"enderecos": [
{
"logradouro": "string",
"complemento": "string",
"bairro": "string",
"cidade": "string",
"uf": "string",
"cep": "string",
"tipoCEP": "string",
"observacaoCEP": "string",
"nomeUnidade": "string"
}
]
}
}Erros Comuns
| Código | Descrição |
|---|---|
400 | Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos. |
401 | Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso. |
403 | Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível. |
404 | Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado. |
408 | Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido. |
500 | Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte. |
503 | Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte. |
Notas Importantes
- Para utilizar a consulta de forma assíncrona, utiliza-se: '&async=habilitar' na URL
- Em caso de dúvidas/suporte, entre em contato pelo e-mail: suporte@directd.com.br ou pelo nosso WhatsApp: (11) 93906-9228