API de Consulta de CPF

A Consulta Simples recebe apenas o CPF e retorna nome, gênero e data de nascimento. O tempo típico é ~150 ms (não é um SLA) e o custo é 1 crédito por CPF encontrado. A Consulta em Tempo Real recebe o CPF e a data de nascimento, consulta a Receita Federal no momento da requisição e retorna a situação cadastral, o ano do óbito (deathYear, inteiro ou null) e o comprovante. O tempo típico é cerca de 1 segundo (não é um SLA) e o custo é 1,5 crédito somente na resposta HTTP 200. A Consulta em Lote processa até 10.000 CPFs por envio, com os mesmos dados da Consulta Simples. O tempo do lote depende de quantos CPFs estão no envio, e cada consulta fica na mesma faixa da Consulta Simples. As três usam a mesma chave de API e o mesmo saldo de créditos.

Não. Você pode consultar CPFs diretamente pelo painel, um de cada vez ou enviando um arquivo .csv ou .txt com até 10.000 CPFs. A API é indicada para quem deseja automatizar as consultas no próprio sistema.

A Consulta Simples e a Consulta em Lote respondem a partir da base de dados da CPFHub.io. A Consulta em Tempo Real consulta a Receita Federal no momento da requisição e retorna a situação cadastral, o ano do óbito e o comprovante emitido pela Receita.

Sim, por meio da Consulta em Tempo Real. Ela informa se o CPF está regular, suspenso, pendente de regularização, cancelado, nulo ou se o titular consta como falecido, o ano do óbito no campo deathYear (inteiro ou null) e a data e a hora de emissão do comprovante. deathYear é null quando não há óbito registrado ou quando o valor recebido é inválido. Não traz dia nem mês do óbito. Para consultar, é necessário enviar a data de nascimento do titular. A Consulta Simples não retorna a situação cadastral nem o ano do óbito.

Na Consulta em Tempo Real, sim: o campo deathYear traz o ano do óbito, sempre presente, como inteiro ou null. Não traz dia nem mês. null aparece quando não há óbito registrado ou quando o valor recebido é inválido (não tem 4 dígitos, está fora do intervalo entre 1900 e o ano atual ou é anterior ao ano de nascimento). A Consulta Simples e a Consulta em Lote não devolvem esse campo.

A Consulta Simples tem tempo típico de ~150 ms. A Consulta em Tempo Real tem tempo típico de cerca de 1 segundo, pois consulta a Receita Federal no momento da requisição. São referências típicas, não um SLA. Na Consulta em Lote, o tempo depende de quantos CPFs estão no envio, e cada consulta fica na mesma faixa da Consulta Simples. A disponibilidade tem SLA por plano: 95% no Grátis, 99% no PRO e 99,9% no Corporativo.

Sim. Cada consulta é registrada (CPF, resultado, data e conta) para fins de histórico, cobrança, auditoria e prevenção a fraudes, com prazo de retenção definido na Política de Privacidade. Cabe à sua empresa, como controladora dos dados, definir a base legal e a finalidade legítima de cada consulta.

Sim. Ao criar uma conta gratuita, sem cartão de crédito, você recebe 50 créditos por mês. A chave de API fica disponível no painel imediatamente.

Na Consulta Simples e na Consulta em Lote, o crédito só é consumido quando o CPF é encontrado, ao custo de 1 crédito por CPF. CPFs não encontrados não são cobrados. Na Consulta em Tempo Real, o custo é de 1,5 crédito somente na resposta HTTP 200. Uma data de nascimento divergente responde HTTP 422 e não é cobrada.

O faturamento é mensal. O plano Grátis oferece 50 créditos sem custo. O plano PRO começa em R$ 19 por mês, com 100 créditos, e tem faixas de até 10.000 créditos. O crédito excedente custa de R$ 0,19 a R$ 0,10, conforme a faixa, e é cobrado na fatura do mês seguinte. O plano Corporativo tem preço personalizado.

Não. O único limite é o saldo de créditos do plano: enquanto houver saldo, você pode chamar a API no ritmo de que precisar. No plano Grátis, as consultas são pausadas quando os 50 créditos mensais se esgotam. Nos planos pagos, a API continua respondendo após o limite, e o excedente é cobrado na fatura do mês seguinte.