Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.sherlocker.com.br/llms.txt

Use this file to discover all available pages before exploring further.

Um Endereço representa um local de residência, correspondência ou estabelecimento comercial associado a um CPF ou CNPJ. Endereços quebrados (sem cidade, CEP zerado) são filtrados automaticamente.

​
Tipagem

{
  "logradouro": "R Henrique Passini",
  "numero": "748",
  "complemento": "401",
  "bairro": "Serra",
  "cidade": "Belo Horizonte",
  "uf": "MG",
  "cep": "30220-380"
}
CampoTipoDescrição
logradourostringRua, avenida, etc.
numerostringNúmero do imóvel
complementostringApartamento, bloco, sala
bairrostringBairro
cidadestringCidade
ufstringEstado (2 letras)
cepstringCEP formatado (XXXXX-XXX)

​
Filtros automáticos

A API filtra automaticamente:
  • Endereços com CEP 00000-000 e sem logradouro
  • Endereços sem cidade ou UF
  • Duplicatas (mesmo CEP + logradouro + número + bairro)

​
Rotas

RotaDescrição
GET /enderecos/cpf/{cpf}Endereços de um CPF
GET /enderecos/cnpj/{cnpj}Endereços de todos os estabelecimentos de um CNPJ

​
Conexões

  • Pessoa — endereços pertencem a um CPF
  • Empresa — todos os estabelecimentos do CNPJ (matriz + filiais)
  • Imóvel — endereços podem ser cruzados com imóveis para confirmar propriedade