BitBusca › Desenvolvedores › API de busca por nome
Mande o nome completo e receba as pessoas encontradas, com nascimento e nome da mãe para separar homônimos. Para localizar parte, conferir cadastro e completar ficha.
Hoje: Só o nome na mão, e várias pessoas com o mesmo nome. Com a API: A lista volta com nascimento e nome da mãe de cada uma: escolha a certa e siga com o CPF.
1 crédito por busca · escopo consultas:pessoa · planos a partir de R$ 19,90/mês. Chave de teste grátis.
Nome comum traz várias pessoas: use o nascimento e o nome da mãe para escolher a certa antes de seguir. Nome incompleto ou com erro de grafia pode não trazer resultado.
curl https://api.bitbusca.net/api/v1/nome/MARIA%20EXEMPLO%20DE%20SOUZA \
-H "Authorization: Bearer $BITBUSCA_API_KEY"
{
"tipo": "NOME",
"consulta": "MARIA EXEMPLO DE SOUZA",
"custo": 1,
"dados": [
{ "nome": "MARIA EXEMPLO DE SOUZA", "nascimento": "1988-03-14", "mae": "JOANA EXEMPLO" },
{ "nome": "MARIA EXEMPLO DE SOUZA", "nascimento": "1961-07-02", "mae": "ANA EXEMPLO" }
]
}
Exemplo fictício, formato resumido. Referência completa: OpenAPI.
nome — O nome completo como está no cadastro de cada pessoa encontrada.nascimento — O primeiro filtro contra homônimo.mae — O desempate quando o nascimento não basta.cpf — A chave para seguir com a API de CPF e completar a ficha.Busca por nome é ferramenta de localização, não de coleta: por isso tem detector de varredura e registro de cada chamada. É o que faz a integração passar no jurídico.
GET /v1/nome/{nome} — Pessoas com aquele nome completo (URL-encoded) (1 crédito)
Crie uma busca de pessoas: o usuário digita o nome completo, você chama GET /v1/nome/{nome} (URL-encoded) e mostra a lista com nascimento e nome da mãe, para ele escolher a pessoa certa.
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.
Mande o nome completo, com todos os sobrenomes, e use o nascimento e o nome da mãe de cada resultado para escolher a pessoa certa antes de seguir com a API de CPF.
É, com finalidade legítima e base legal (localizar parte de processo, completar cadastro de cliente, due diligence). Varredura de nomes em massa pausa a chave, e os termos proíbem montar base derivada.
O limite é o pool mensal de créditos do plano (1 crédito por busca) 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.