Início rápido com Rails

Aprenda como integrar a API CPFHub em uma aplicação Rails.

Exemplo básico

Aqui está um exemplo simples de como fazer uma requisição para consultar um CPF:

1require 'net/http'2require 'json'34class CpfController < ApplicationController5  def show6    cpf = params[:cpf]7    uri = URI("https://api.cpfhub.io/cpf/#{cpf}")8    request = Net::HTTP::Get.new(uri)9    request['x-api-key'] = ENV['CPFHUB_API_KEY']10    request['Accept'] = 'application/json'1112    response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|13      http.request(request)14    end1516    render json: JSON.parse(response.body)17  end18end

Substitua YOUR_API_KEY pela sua chave de API. Para obter uma chave, entre em contato através do WhatsApp.

Resposta

A API retornará um objeto JSON com os dados do CPF consultado:

1{2  "success": true,3  "data": {4    "cpf": "00000000000",5    "name": "Fulano de Tal",6    "nameUpper": "FULANO DE TAL",7    "gender": "M",8    "birthDate": "15/06/1990",9    "day": 15,10    "month": 6,11    "year": 199012  }13}

Próximos passos

Referência Completa da API

Explore todos os endpoints, parâmetros e exemplos de resposta.

Perguntas Frequentes

Encontre respostas para as perguntas mais comuns sobre a API.

Última atualização: 25/01/2026