Skip to navigation
API Reference4. Cadastral Pessoa Física4.1 Consulta e Enriquecimento PF

PF PIS - CPF

Esta API retorna o número de inscrição no PIS (Programa de Integração Social) vinculado a uma pessoa física a partir do seu CPF. A consulta identifica o PIS/PASEP associado ao documento informado, permitindo o enriquecimento cadastral e a conciliação de registros trabalhistas e previdenciários.

Indicado para enriquecimento cadastral, validação de vínculos trabalhistas e previdenciários e processos de onboarding que exijam o número do PIS do titular.

TABELA DE CAMPOS DE REQUISIÇÃO

CampoDescriçãoFormatoObrigatório
IdConsultaIdentificador da consulta. Valor fixo: 300.stringSim
CpfCnpjCPF da pessoa a ser consultada.stringSim
TipoPessoaTipo de pessoa consultada. Valor fixo: F.stringSim

TABELA DE CAMPOS DE RETORNO

CampoDescriçãoFormato
CONSULTA.CODIGORESPOSTANúmero do protocolo de retorno gerado pelo servidor da API.string
CONSULTA.DATAHORAData e hora exata em que o processamento foi concluído.DD/MM/YYYY HH:MM:SS
CONSULTA.LOGONCódigo de identificação da credencial de acesso que realizou a chamada.string
CONSULTA.IDCONSULTACódigo identificador retornado para conciliação com o enviado na requisição.string
CampoDescriçãoFormato
RESPOSTA.CODIGOCódigo do resultado da consulta: 1 sucesso · 2 não encontrado · 3 erro.string
RESPOSTA.PISNúmero de inscrição no PIS/PASEP vinculado ao CPF consultado.string

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

Objeto de consulta com o CPF da pessoa a ser pesquisada.
ConsultaobjectRequired

Response

Resposta da consulta:

  • Código 1: Sucesso.
  • Código 2: Dado não encontrado na base de dados.
  • Código 3: Erro na consulta.

Errors

400
Bad Request Error
401
Unauthorized Error