xBlack
← blog

Consulta de CPF por API: do zero à primeira resposta

Como autenticar, consultar um CPF e ler a resposta da API do xBlack — com o custo em créditos de cada chamada e um vídeo do fluxo completo.

· api · cpf · integração

Autenticação

Toda chamada leva a chave de API no cabeçalho Authorization, no formato Bearer. A chave é criada no painel e pode ser revogada a qualquer momento. Sem ela, a API responde 401 e não cobra nada.

A consulta básica

Uma requisição GET para /v1/cpf/{cpf}, com os 11 dígitos sem pontuação, devolve os dados básicos e custa 1 crédito. O saldo restante vem na própria resposta, então não há segunda chamada para conferir.

curl -H "Authorization: Bearer xbk_live_••••" \
  https://api.xblackapi.com/v1/cpf/12345678909

O dossiê completo

Para mais campos, use /v1/cpf/{cpf}/completo. Custa 4 créditos. Cada resposta traz um protocolo, o custo cobrado e o saldo que sobrou — o que facilita conciliar o consumo.

CPF fora do formato é recusado com 400 antes da cobrança: você só paga por consulta que chegou à base.

curl -H "Authorization: Bearer xbk_live_••••" \
  https://api.xblackapi.com/v1/cpf/12345678909/completo

Uso responsável

Dados pessoais exigem finalidade legítima, conforme a LGPD. Os Termos de Uso e a Política de Privacidade do xBlack descrevem o que é permitido; leia antes de integrar.