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:

123456789101112131415161718require 'net/http'
require 'json'

class CpfController < ApplicationController
  def show
    cpf = params[:cpf]
    uri = URI("https://api.cpfhub.io/cpf/#{cpf}")
    request = Net::HTTP::Get.new(uri)
    request['x-api-key'] = ENV['CPFHUB_API_KEY']
    request['Accept'] = 'application/json'

    response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
      http.request(request)
    end

    render json: JSON.parse(response.body)
  end
end

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:

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

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