Laravel
Use o HTTP Client integrado do Laravel para consultar CPF com uma chamada limpa e fluente.
Integrando com Cursor, Lovable, v0 ou outra IA?
Copie o prompt de integração e cole direto no seu assistente de IA - ele saberá exatamente como usar a API.
Pré-requisitos
- Laravel 9+
- Uma API Key em app.cpfhub.io
- Variável
CPFHUB_API_KEYno.env
Configuração
Adicione ao .env:
bash
CPFHUB_API_KEY=cpfh_sua_api_key_aquiExemplo
PHP
use Illuminate\Support\Facades\Http;
$cpf = '12345678909';
$apiKey = env('CPFHUB_API_KEY');
$response = Http::withHeaders(['x-api-key' => $apiKey])
->get("https://api.cpfhub.io/cpf/{$cpf}");
$response->throw(); // lança exceção se 4xx / 5xx
$data = $response->json('data');
echo $data['name']; // "Fulano de Tal"
echo $data['birthDate']; // "15/06/1990"
echo $data['gender']; // "M"Em um Controller
PHP
<?php
namespace App\Http\Controllers;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Http;
use Illuminate\Http\JsonResponse;
class CpfController extends Controller
{
public function show(Request $request, string $cpf): JsonResponse
{
$response = Http::withHeaders(['x-api-key' => env('CPFHUB_API_KEY')])
->get("https://api.cpfhub.io/cpf/{$cpf}");
if ($response->failed()) {
return response()->json(
['error' => $response->json('error')],
$response->status()
);
}
return response()->json(['data' => $response->json('data')]);
}
}Registre a rota em routes/api.php:
PHP
Route::get('/cpf/{cpf}', [CpfController::class, 'show']);Campos retornados
| Campo | Tipo | Exemplo |
|---|---|---|
cpf | string | "12345678909" |
name | string | "Fulano de Tal" |
nameUpper | string | "FULANO DE TAL" |
gender | "M" | "F" | "M" |
birthDate | string | "15/06/1990" |
day | number | 15 |
month | number | 6 |
year | number | 1990 |
Tratamento de erros
| HTTP | error.code | Descrição |
|---|---|---|
| 404 | CPF_NOT_FOUND | CPF não consta na base |
| 422 | INVALID_CPF_DIGITS | Dígitos verificadores inválidos |
| 429 | RATE_LIMIT_EXCEEDED | Muitas requisições |
| 401 | UNAUTHORIZED | API Key inválida ou ausente |
Links
Atualizado em 17 de maio de 2026