Sobre

A consulta de CPF na Receita Federal, por meio da API oficial SERPRO (Serviço Federal de Processamento de Dados), é um recurso essencial para instituições financeiras, fintechs e instituições que precisam validar a situação cadastral de um CPF antes de permitir o cadastro ou edição de usuários.

Essa validação ajuda a garantir:

• Conformidade regulatória;

• Redução de fraudes;

• Maior segurança nos processos de cadastro.

Neste tutorial, você vai aprender como configurar a integração com a API de consulta CPF do SERPRO, utilizando credenciais oficiais, de forma simples e segura dentro da plataforma.

Como funciona

Na prática, a integração permite que a plataforma consulte diretamente a base da Receita Federal, via SERPRO, para verificar a situação do CPF informado.

O fluxo consiste em:

• O usuário tenta se cadastrar ou editar seus dados;

• A plataforma realiza uma consulta automática na Receita Federal;

• O retorno indica se o CPF está:

  • Regular;

  • Suspenso;

  • Cancelado;

  • Nulo;

  • Com pendência de regularização;

• Com base nesse retorno, o sistema permite ou bloqueia a ação.

Essa consulta ocorre em tempo real, usando as credenciais oficiais fornecidas pelo SERPRO.

Como a validação é aplicada na plataforma?

Com a integração ativa, a consulta de CPF passa a ocorrer automaticamente nos seguintes cenários:

• Cadastro de novo usuário;

• Edição de dados cadastrais (CPF) pelo administrador.

Caso o CPF esteja em situação irregular (Suspenso, Cancelado, Com Pendência, Nulo), o sistema irá:

• Bloquear o cadastro ou a edição de dados;

• Exibir mensagem de orientação ao usuário;

• Solicitar correção e nova tentativa.

O que você precisa antes de começar?

Antes de configurar a integração, certifique-se de que você possui:

• Perfil de Administrador na plataforma;

• Uma conta ativa no portal do SERPRO;

• As credenciais da API:

  • Consumer Key;

  • Consumer Secret.

Essas credenciais são geradas diretamente na plataforma do SERPRO após a contratação do serviço de Consulta CPF.

💡Dica: se você não é administrador do seu sistema interno, consulte a equipe responsável de sua organização para solicitar as credenciais necessárias.

❗Informação importante: 

A API do SERPRO é um serviço oficial e tarifado. O Toolzz LXP não se responsabiliza por custos adicionais provenientes da ativação da integração. Consulte seu contrato para entender limites de uso, custos e SLA. Para informações básicas sobre tarifas, consulte a aba de Preços no site oficial da Loja SERPRO.

Passo a passo

1º passo: no menu lateral da plataforma, clique em "Configurações" e depois "Integrações".

2º passo: nesta tela de integrações, você verá todas as integrações disponíveis para ativação. Role a página até encontrar a opção "SERPRO – Consulta CPF" e clique no botão "Configurar Credenciais".

3º passo: no formulário que abrirá, preencha os campos obrigatórios solicitados:

• Consumer Key: chave pública fornecida pelo SERPRO;

• Consumer Secret: chave secreta vinculada à sua aplicação.

💡Dica:

Essas informações são obtidas diretamente no portal do SERPRO, dentro da área de gestão de APIs da sua conta. Consulte o FAQ SERPRO para saber Como obter minhas Chaves de Acesso.

Após preencher as informações, clique em "Salvar".

A sua integração já está ativa! Você pode, a qualquer momento, desativar a integração ou editar suas credenciais refazendo os passos anteriores.

❗ Informação importante:

Nunca compartilhe o Consumer Secret publicamente, em repositórios de código ou com troca de informações sem segurança. Ele deve ser tratado como informação sensível.

Pronto! Agora você já sabe como configurar e utilizar a Integração SERPRO para consultas de CPF, garantindo mais segurança, conformidade e confiabilidade nos cadastros da sua plataforma.