CPFHub.io
Começar grátis

Consultar CPF com Elixir

Consulte CPF com Elixir usando a biblioteca Req.

Usando Cursor, Lovable, v0 ou outra IA? Copie o prompt da Consulta Simples e cole no seu assistente.

Abrir no Cursor

Antes de começar

  1. Crie uma conta grátis em app.cpfhub.io: o plano Grátis tem 50 créditos e não pede cartão.
  2. Copie sua API Key em app.cpfhub.io/api-keys.
  3. Guarde a chave em uma variável de ambiente, nunca no código:
bash
export CPFHUB_API_KEY="sua_api_key"

Exemplo

Elixir
Mix.install([{:req, "~> 0.5"}])

cpf = "12345678909"

response =
  Req.get!("https://api.cpfhub.io/cpf/#{cpf}",
    headers: [{"x-api-key", System.fetch_env!("CPFHUB_API_KEY")}],
    receive_timeout: 10_000
  )

case response do
  %{status: 200, body: %{"data" => data}} ->
    IO.puts("#{data["name"]} #{data["birthDate"]}")

  %{status: 404} ->
    IO.puts("CPF não encontrado (não consome crédito)")

  # error vem como objeto (%{"message" => ...}) ou como texto
  %{status: status, body: %{"error" => %{"message" => mensagem}}} ->
    raise "Erro #{status}: #{mensagem}"

  %{status: status, body: %{"error" => mensagem}} ->
    raise "Erro #{status}: #{mensagem}"
end

Salve como consulta_cpf.exs e rode com elixir consulta_cpf.exs. Em um projeto Mix, troque o Mix.install por {:req, "~> 0.5"} no mix.exs. Por padrão, o Req já repete automaticamente respostas 429 e 5xx, respeitando o Retry-After.

Resposta

CPF encontrado (200, consome 1 crédito):

JSON
{
  "success": true,
  "data": {
    "cpf": "12345678909",
    "name": "Fulano de Tal",
    "nameUpper": "FULANO DE TAL",
    "gender": "M",
    "birthDate": "15/06/1990",
    "day": 15,
    "month": 6,
    "year": 1990
  }
}

CPF não encontrado (404, não consome crédito):

JSON
{
  "success": false,
  "data": null,
  "error": { "message": "CPF não encontrado na base de dados" }
}

O CPF 12345678909 é fictício, usado só nos exemplos. gender pode vir null.

Erros

StatusO que significaO que fazer
404CPF não está na baseTrate como "não encontrado". Não consome crédito.
400 / 422CPF sem 11 dígitos ou com dígito verificador inválidoCorrija a entrada. Não consome crédito.
401API Key ausente ou inválidaConfira a variável CPFHUB_API_KEY.
403Créditos esgotados ou conta inativaVeja o saldo em GET /quota ou recarregue no dashboard.
429Limite de requisições por minutoEspere os segundos do header Retry-After e tente de novo.
5xxFalha temporáriaTente de novo após alguns segundos.

O campo error pode vir como texto ("error": "...") ou como objeto ("error": { "message": "..." }), conforme o status. Os exemplos acima tratam os dois formatos. Lista completa em Códigos de Erro.

Próximos passos