BitBusca › Desenvolvedores › API de telefone
Mande o telefone com DDD e receba o titular e o endereço registrado. Útil para conferir lead, qualificar contato e evitar golpe com número trocado.
Hoje: Lead com número de outra pessoa, golpista se passando por cliente, atendente perguntando tudo de novo. Com a API: O número entra; titular e endereço voltam. Você qualifica, confere e atende já sabendo com quem fala.
1 crédito por número · escopo consultas:pessoa · planos a partir de R$ 19,90/mês. Chave de teste grátis.
Nem toda linha tem titular ou endereço registrado. Quando não há, a resposta é 404 e não gasta créditos.
curl https://api.bitbusca.net/api/v1/telefone/67900000000 \
-H "Authorization: Bearer $BITBUSCA_API_KEY"
{
"tipo": "TELEFONE",
"consulta": "(67) 90000-0000",
"custo": 1,
"dados": {
"titular": "CARLOS EXEMPLO LIMA",
"endereco": {
"logradouro": "RUA DAS FLORES, 123",
"bairro": "CENTRO",
"cidade": "CAMPO GRANDE",
"uf": "MS",
"cep": "79000-000"
}
}
}
Exemplo fictício, formato resumido. Referência completa: OpenAPI.
titular — Quem está registrado na linha: confere com quem diz ser.endereco — Onde o titular está registrado: entrega, área de atendimento e conferência.cidade · uf · cep — A região do contato, para mandar ao vendedor ou à loja certa.consulta — O número já formatado, pronto para mostrar na tela.Finalidade declarada, registro de cada chamada e trava contra varredura: é o que deixa a integração defensável quando alguém pergunta de onde veio o dado.
GET /v1/telefone/{numero} — Titular do número (DDD + número, só dígitos) (1 crédito)
Crie uma tela de atendimento: ao colar um telefone com DDD, chame GET /v1/telefone/{numero} (só dígitos) e mostre o titular e o endereço num cartão.
Use a API da BitBusca (base https://api.bitbusca.net/api). A especificação OpenAPI está em https://api.bitbusca.net/api/v1/openapi.json.
Autentique com o cabeçalho "Authorization: Bearer <chave>", lendo a chave da variável de ambiente BITBUSCA_API_KEY.
Nunca coloque a chave no código do navegador: faça as chamadas por uma função de servidor (edge function, API route ou backend).
Trate os erros pelo campo "code" da resposta: 402 NO_CREDITS (sem créditos), 429 RATE (respeite o cabeçalho Retry-After), 429 COTA_DIARIA (teto do dia atingido), 404 NOT_FOUND (mostre "nada encontrado", não é cobrado).
Comece com a chave de teste (bk_test_…), que devolve dados fictícios e não gasta créditos.
Sim. A chave de teste (bk_test_…) é grátis, não expira com o sandbox e devolve dados fictícios no mesmo formato da produção — dá para montar a tela inteira sem gastar nada. Quando quiser dado real, ative o sandbox: 7 dias com 50 créditos reais, 10 requisições por minuto, 2 chaves e 1 webhook, uma vez por conta.
Não. Resposta 404 (nada encontrado) e erro do nosso lado (5xx) não gastam créditos: o débito é estornado na hora.
Só dígitos, com DDD: 67900000000. Sem +55.
A consulta precisa de finalidade legítima: conferir um cadastro, prevenir fraude, atender quem já é cliente. Montar lista para revender ou varrer números em sequência é proibido nos termos e pausa a chave.
O limite é o pool mensal de créditos do plano (1 crédito por número) e as requisições por minuto de cada plano. Você ainda pode pôr um teto diário de créditos em cada chave. O que pausa a chave é varredura: documentos em sequência ou volume fora do padrão.