Documentação da API

Integre a validação de CEP diretamente no seu sistema.

GET/api/cep/{cep}

Consulta um CEP individual. Retorna endereço completo ou erro se não encontrado.

Exemplo de requisição
GET /api/cep/01310100
Resposta 200 OK
{
  "cep": "01310-100",
  "logradouro": "Avenida Paulista",
  "complemento": "de 1 a 610 - lado par",
  "bairro": "Bela Vista",
  "localidade": "São Paulo",
  "uf": "SP",
  "ibge": "3550308",
  "gia": "1004",
  "ddd": "11",
  "siafi": "7107"
}
POST/api/cep/batch

Valida múltiplos CEPs em uma só chamada. Máximo 200 CEPs por requisição.

Corpo da requisição
{
  "ceps": ["01310-100", "20040-020", "99999-999"]
}
Resposta 200 OK
{
  "total": 3,
  "results": [
    {
      "cep": "01310-100",
      "status": "found",
      "logradouro": "Avenida Paulista",
      "bairro": "Bela Vista",
      "localidade": "São Paulo",
      "uf": "SP",
      "ddd": "11"
    },
    {
      "cep": "20040-020",
      "status": "found",
      "logradouro": "Rua da Assembléia",
      "bairro": "Centro",
      "localidade": "Rio de Janeiro",
      "uf": "RJ",
      "ddd": "21"
    },
    {
      "cep": "99999-999",
      "status": "not_found",
      "error": "CEP não encontrado"
    }
  ]
}
GET/api/health

Healthcheck do serviço.

{ "status": "ok" }
Códigos de Status (batch)
StatusDescrição
foundCEP encontrado com endereço completo
not_foundCEP não existe na base dos Correios
invalidFormato inválido (não tem 8 dígitos)
errorFalha temporária ao consultar a API