PHPackages                             samueletur/serpro-consulta-cpf-laravel - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. samueletur/serpro-consulta-cpf-laravel

ActiveLibrary[API Development](/categories/api)

samueletur/serpro-consulta-cpf-laravel
======================================

Pacote Laravel para integrar a API Consulta CPF da SERPRO

v1.0.2(1mo ago)05MITPHPPHP ^8.1

Since Jun 10Pushed 1mo agoCompare

[ Source](https://github.com/samueletur/serpro-laravel)[ Packagist](https://packagist.org/packages/samueletur/serpro-consulta-cpf-laravel)[ RSS](/packages/samueletur-serpro-consulta-cpf-laravel/feed)WikiDiscussions main Synced 1w ago

READMEChangelogDependencies (4)Versions (4)Used By (0)

SERPRO Consulta CPF Laravel
===========================

[](#serpro-consulta-cpf-laravel)

Pacote Composer para integrar a API Consulta CPF da SERPRO em projetos Laravel, com autenticação OAuth2 (Bearer Token) e consulta de CPF.

Requisitos
----------

[](#requisitos)

- PHP 8.1+
- Laravel 10, 11, 12 ou 13
- Contrato da API com `consumer_key` e `consumer_secret` na Área do Cliente SERPRO

Instalação
----------

[](#instalação)

### Via GitHub (recomendado para uso interno)

[](#via-github-recomendado-para-uso-interno)

1. Crie um repositório no GitHub e envie este pacote (veja seção [Publicação no GitHub](#publica%C3%A7%C3%A3o-no-github)).
2. No `composer.json` do seu projeto Laravel, adicione o repositório VCS:

```
{
    "repositories": [
        {
            "type": "vcs",
            "url": "https://github.com/samueletur/serpro-laravel"
        }
    ],
    "require": {
        "incode/serpro-consulta-cpf-laravel": "^1.0"
    }
}
```

3. Instale o pacote:

```
composer require incode/serpro-consulta-cpf-laravel
```

Para repositórios privados, configure autenticação do GitHub (token ou SSH) no Composer.

### Via Packagist (opcional, repositório público)

[](#via-packagist-opcional-repositório-público)

Se o pacote estiver publicado no [Packagist](https://packagist.org), basta executar:

```
composer require incode/serpro-consulta-cpf-laravel
```

### Publicar configuração

[](#publicar-configuração)

```
php artisan vendor:publish --tag=serpro-consulta-cpf-config
```

### Variáveis de ambiente

[](#variáveis-de-ambiente)

```
SERPRO_CONSUMER_KEY=seu_consumer_key
SERPRO_CONSUMER_SECRET=seu_consumer_secret
SERPRO_TOKEN_URL=https://gateway.apiserpro.serpro.gov.br/token
SERPRO_CPF_BASE_URL=https://gateway.apiserpro.serpro.gov.br/consulta-cpf-df
SERPRO_CPF_API_PREFIX=/v2
SERPRO_TIMEOUT=15
SERPRO_ACCEPT=application/json
```

Uso
---

[](#uso)

### Via Facade

[](#via-facade)

```
use Serpro\ConsultaCpf\Facades\SerproConsultaCpf;

$dados = SerproConsultaCpf::consultaCpf('12345678909'); // CPF fictício para exemplo
```

### Via injeção de dependência

[](#via-injeção-de-dependência)

```
use Serpro\ConsultaCpf\SerproConsultaCpfClient;

class ConsultaController
{
    public function show(SerproConsultaCpfClient $client)
    {
        $dados = $client->consultaCpf('12345678909'); // CPF fictício para exemplo

        return response()->json($dados);
    }
}
```

Observações importantes
-----------------------

[](#observações-importantes)

- O token OAuth2 é renovado automaticamente quando necessário.
- O pacote normaliza CPF com máscara para apenas dígitos.
- Por padrão, o pacote aponta para a API v2 em produção (`consulta-cpf-df` + `/v2/cpf/{cpf}`). Para trial, use `consulta-cpf-df-trial` com prefixo `/v1`.
- `SERPRO_TOKEN_URL` e `SERPRO_CPF_BASE_URL` devem usar HTTPS e apontar para domínios `*.serpro.gov.br`; URLs inválidas impedem o boot da aplicação.
- Em `consultaCpf()`, os headers `Authorization` e `Accept` são sempre definidos pelo pacote e não podem ser sobrescritos. Não passe input de usuário em `$headers`.

Referência de documentação
--------------------------

[](#referência-de-documentação)

- Introdução da API Consulta CPF:
- Guia rápido (OAuth2 e exemplo de chamada): [https://apicenter.estaleiro.serpro.gov.br/documentacao/consulta-cpf/pt/quick\_start/](https://apicenter.estaleiro.serpro.gov.br/documentacao/consulta-cpf/pt/quick_start/)

###  Health Score

38

—

LowBetter than 83% of packages

Maintenance90

Actively maintained with recent releases

Popularity4

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity44

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~0 days

Total

3

Last Release

45d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/e2828dc7b9621829cfa7cbd5eaff8f291f5fa82324abce37c32e1ce90f5c826e?d=identicon)[samueletur](/maintainers/samueletur)

---

Top Contributors

[![samueletur](https://avatars.githubusercontent.com/u/1007801?v=4)](https://github.com/samueletur "samueletur (4 commits)")

---

Tags

laraveloauth2cpfSERPROconsulta cpf

### Embed Badge

![Health badge](/badges/samueletur-serpro-consulta-cpf-laravel/health.svg)

```
[![Health](https://phpackages.com/badges/samueletur-serpro-consulta-cpf-laravel/health.svg)](https://phpackages.com/packages/samueletur-serpro-consulta-cpf-laravel)
```

###  Alternatives

[simplestats-io/laravel-client

Server-side analytics for Laravel that follows the full funnel from visit to registration to payment, attributed to the channel that drove it. Revenue, MRR, churn and ad-spend profit (ROAS/CAC) per channel. GDPR compliant, ad-blocker proof.

5022.6k](/packages/simplestats-io-laravel-client)[eslazarev/wildberries-sdk

Wildberries OpenAPI clients (generated).

293.1k](/packages/eslazarev-wildberries-sdk)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)