BitBusca › Desenvolvedores › API de CPF
Mande o CPF, receba o cadastro em JSON: nome completo, nascimento, nome da mãe e situação cadastral. Para preencher cadastro, conferir quem está do outro lado e reduzir fraude no onboarding.
Hoje: Cliente digitando o nome errado, conta aberta com o CPF de outra pessoa, analista conferindo cadastro à mão. Com a API: O CPF entra; nome, nascimento, mãe e situação voltam em JSON, e o seu sistema decide sozinho se libera.
1 crédito por CPF · escopo consultas:pessoa · planos a partir de R$ 19,90/mês. Chave de teste grátis.
O retorno depende do que está registrado para aquele CPF: nem todo cadastro tem nome do pai, telefone ou endereço recente. Algumas consultas de pessoa estão temporariamente fora do catálogo e outras entram em breve — GET /v1/consultas mostra o que está no ar agora.
curl https://api.bitbusca.net/api/v1/cpf/00000000191 \
-H "Authorization: Bearer $BITBUSCA_API_KEY"
{
"tipo": "CPF",
"consulta": "000.000.001-91",
"custo": 1,
"dados": {
"nome": "MARIA EXEMPLO DE SOUZA",
"nascimento": "1988-03-14",
"sexo": "F",
"mae": "JOANA EXEMPLO DE SOUZA",
"situacao": "REGULAR"
}
}
Exemplo fictício, formato resumido. Referência completa: OpenAPI.
nome — O nome como está no cadastro: preenche o formulário e confere com o que a pessoa digitou.nascimento — Confirma a identidade e a maioridade, para contrato, crédito ou venda restrita.mae — O dado que separa homônimos e serve de pergunta de segurança no atendimento.situacao — Regular ou não: decide se o cadastro segue direto ou vai para análise.sexo — Completa a ficha sem precisar perguntar.custo — Quantos créditos a chamada gastou, para o seu controle de uso.Os tetos e o registro de cada chamada não estão aqui para atrapalhar: são o que o jurídico e o compliance (seu ou do seu cliente) querem ver antes de aprovar a integração.
GET /v1/cpf/{cpf} — Cadastro da pessoa pelo CPF (só números) (1 crédito)GET /v1/consultas — Catálogo de consultas no ar, com rota, custo e escopo (grátis)GET /v1/me — Plano, saldo de créditos e uso do dia (grátis)
Crie um formulário de cadastro em que, ao digitar um CPF válido, o nome completo e a data de nascimento sejam preenchidos automaticamente com GET /v1/cpf/{cpf} (só números). Valide os dígitos do CPF antes de chamar a API.
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.
Não. Mande só os 11 números; a resposta devolve o CPF formatado no campo "consulta".
Pode guardar o que o seu sistema precisa para a finalidade declarada (o cadastro do seu cliente, por exemplo). O que não pode é montar uma base derivada para revender ou redistribuir — isso está nos termos da API e suspende a chave.
É, quando há base legal para a finalidade: execução de contrato, proteção ao crédito, prevenção a fraude ou cumprimento de obrigação legal, entre outras (art. 7º da LGPD). A API registra cada chamada por chave e os termos proíbem revenda; a responsabilidade pela finalidade é de quem consulta.
O limite é o pool mensal de créditos do plano (1 crédito por CPF) 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.