v1

latestOpenAPI 3.0.02026-08-049274312.1 KB

API PF Pesquisa

Consulta API PF Pesquisa

post/pfpesquisa

Request body

Example request

{
  "Consulta": {
    "IdConsulta": "328",
    "CpfCnpj": "00000000000",
    "TipoPessoa": "F"
  }
}

Response

Resposta da consulta.

Código 1: Sucesso.
Código 2: Registro não encontrado.
Código 3: Erro na consulta.

Example response

{
  "CONSULTA": {
    "CODIGORESPOSTA": "12345678",
    "DATAHORA": "11/07/2025 12:51:06",
    "LOGON": "99999",
    "IDCONSULTA": "328"
  },
  "RESPOSTA": {
    "CODIGO": [
      "1",
      "1",
      "1",
      "1",
      "1",
      "1",
      "1",
      "1",
      "1",
      "1",
      "1",
      "1"
    ],
    "DADOSCADASTRAIS": {
      "CPFCNPJ": "00000000000",
      "NOMERAZAO": "JOAO DA SILVA",
      "NASCFUND": "01/01/1970",
      "SEXO": "M",
      "NOMEMAE": "MARIA DA SILVA",
      "SIGNO": "CAPRICORNIO",
      "IDADE": "54"
    },
    "MORADORESENDERECO": {
      "REGISTRO_1": {
        "CPF": "00000000000",
        "NOME": "JOAO DA SILVA"
      }
    },
    "ENDERECOS": {
      "REGISTRO_1": {
        "TP_LOGRADOURO": "RUA",
        "LOGRADOURO": "AVENIDA BRASIL",
        "NUMERO": "1000",
        "COMPLEMENTO": "APT 101",
        "BAIRRO": "CENTRO",
        "CIDADE": "SAO PAULO",
        "UF": "SP",
        "CEP": "01001000"
      }
    },
    "TELEFONES": {
      "REGISTRO_1": {
        "TIPO_CONTATO_TELEFONE": "RESIDENCIAL",
        "WHATSAPP": "SIM",
        "DDD": "11",
        "TELEFONE": "999999999"
      }
    },
    "PARTICIPACAOSOCIETARIA": {
      "REGISTRO_1": {
        "CNPJ": "00000000000100",
        "RAZAOSOCIAL": "EMPRESA EXEMPLO LTDA",
        "DOCUMENTO": "00000000000",
        "PERCENTUAL": "50",
        "DATA": "01/01/2000",
        "QUALIFICACAO": "SOCIO ADMINISTRADOR"
      }
    },
    "RENDAIBGE": {
      "VALOR": "DE 5 A 6 SALARIOS MINIMOS"
    },
    "EMAIL": {
      "REGISTRO_1": {
        "EMAIL": "exemplo@email.com"
      }
    },
    "OBS": {
      "OBS": "NAO"
    },
    "BOLSAFAMILIA": "NAO",
    "PFVINCULO": {
      "REGISTRO_1": {
        "CPF": "00000000000",
        "NOME": "MARIA DA SILVA",
        "GRAU_VINCULO": "FILHA"
      }
    },
    "ESPORTISTA": {
      "FLAG_ESPORTISTA": "1",
      "APELIDO": "PELE",
      "MODALIDADE": "FUTEBOL",
      "FUNCAO": "ATACANTE",
      "NOME": "EDSON ARANTES DO NASCIMENTO",
      "EQUIPE": "SANTOS FUTEBOL CLUBE",
      "PAIS": "BRASIL",
      "FLAG_PARENTESCO": "1",
      "GRAU_VINCULO": "AVO"
    },
    "PEPPARENTESCO": {
      "FLAG_PEP": "1",
      "NOME": "NOME PEP",
      "FUNCAO": "MINISTRO",
      "NIVEL": "001",
      "ORGAO": "MINISTERIO DA JUSTICA",
      "DATAINICIO": "01-JAN-23",
      "FLAG_PARENTESCO": "1",
      "GRAU_VINCULO": "IRMAO"
    }
  }
}