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 Telefone representa um número telefônico associado a uma pessoa física. Pode ser fixo ou móvel, com identificação de operadora e estado.

​
Tipagem

{
  "ddi": "55",
  "ddd": "31",
  "numero": "987654321",
  "numero_completo": "5531987654321",
  "estado": "MG",
  "operadora": "Vivo",
  "data": "2024-01-01"
}
CampoTipoDescrição
ddistringCódigo do país (sempre 55 para Brasil)
dddstringCódigo de área (2 dígitos)
numerostringNúmero sem DDD
numero_completostringDDI + DDD + número (formato E.164 sem +)
estadostringUF derivada do DDD (ex: SP, MG, RJ)
operadorastringOperadora detectada: Vivo, Claro, Tim, Oi, Fixo
datastring | nullAno de referência do registro no formato YYYY-01-01, ou null se indisponível

​
Conexões

  • Pessoa — todo telefone pertence a um CPF
  • Empresa — empresas têm telefones comerciais (ddd1/telefone1, ddd2/telefone2)
  • Banco — bancos podem retornar telefones vinculados a contas

​
Endpoints

RotaDescrição
GET /telefones/cpf/{cpf}Telefones de uma pessoa
GET /pessoas/telefone/{telefone}Busca reversa: CPFs por telefone
A busca reversa suporta paginação com limit (padrão 50, max 200) e offset (padrão 0) via query params.