POST PF/BaseNacional

Consulta Base Nacional de Pessoa Física.

Request Information

URI Parameters

None.

Body Parameters

Objeto contendo os parâmetros de entrada para a consulta do base nacional PF, fornecer documento é obrigatório.

TransUnion.Consultas.DTO.Parametros.BaseNacional.ParametrosEntradaPfBaseNacional

Name	Description	Type	Additional information
Token		string	None.
CPF		string	None.

Request Formats

application/json, text/json

Sample:

{
  "Token": "sample string 1",
  "CPF": "sample string 2"
}

application/xml, text/xml

Sample:

<ParametrosEntradaPfBaseNacional xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="AcoesJudiciais.API">
  <CPF>sample string 2</CPF>
  <Token>sample string 1</Token>
</ParametrosEntradaPfBaseNacional>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Dados Principais, Dados Complementares, Situação SRF, Pessoas Vinculadas, Emails, Qsa, Telefones, Endereços, Benefícios do Governo, Título do Eleitor

TransUnion.Consultas.DTO.Retorno.BaseNacional.RetornoBaseNacionalPf

Name	Type	Additional information
DADOS_PRINCIPAIS	TransUnion.Consultas.DTO.Retorno.Bundles.PFDadosPrincipais	None.
DADOS_COMPLEMENTARES	TransUnion.Consultas.DTO.Retorno.Bundles.PFDadosComplementares	None.
SITUACAO_SRF	TransUnion.Consultas.DTO.Retorno.SRFPessoaFisica	None.
PESSOAS_VINCULADAS	Collection of Object	None.
EMAILS	Collection of Object	None.
QSA	Collection of Object	None.
TELEFONES	Collection of Object	None.
ENDERECOS	Collection of Object	None.
BENEFICIOS_GOVERNO	TransUnion.Consultas.DTO.Retorno.PFBeneficiosGovernoFlags	None.
TITULO_ELEITOR	TransUnion.Consultas.DTO.Retorno.PFTituloEleitor	None.
ERRO	TransUnion.Common.DTO.Erro	None.

Response Formats

application/json, text/json

Sample:

{
  "DADOS_PRINCIPAIS": {
    "NR_IDADE": 1,
    "NR_ANO_OBITO": "sample string 1",
    "NM_COMPLETO": "sample string 2",
    "NM_SOCIAL_COMPLETO": "sample string 3",
    "NR_CPF": "sample string 4",
    "DS_SEXO": "sample string 5",
    "DT_NASCIMENTO": "2025-12-19T15:55:52.8399945-03:00",
    "DS_SIGNO": "sample string 6",
    "FG_OBITO": true,
    "DT_RECENCIA": "2025-12-19T15:55:52.8399945-03:00",
    "ERRO": {
      "CODIGO": 1,
      "MENSAGEM": "sample string 3"
    }
  },
  "DADOS_COMPLEMENTARES": {
    "ID_AUX_PROFISSAO": 1,
    "DS_PROFISSAO": "sample string 1",
    "ID_AUX_FAIXAVALOR": 1,
    "DS_FAIXAVALOR": "sample string 2",
    "ID_AUX_CARGO": 1,
    "DS_CARGO": "sample string 3",
    "NR_RG": "sample string 4",
    "DS_ESTADOCIVIL": "sample string 5",
    "DS_NACIONALIDADE": "sample string 6",
    "DS_ESCOLARIDADE": "sample string 7",
    "NR_PIS": "sample string 8",
    "DT_RECENCIA": "2025-12-19T15:55:52.8556197-03:00",
    "SG_ESTADOCIVIL": "sample string 9",
    "UF_RG": "sample string 10",
    "SG_ORGAO_EMISSOR": "sample string 11",
    "VALOR_RENDA": 1.0,
    "ERRO": {
      "CODIGO": 1,
      "MENSAGEM": "sample string 3"
    }
  },
  "SITUACAO_SRF": {
    "DT_CONSULTA": "2025-12-19T15:55:52.8556197-03:00",
    "HR_CONSULTA": "sample string 3",
    "DS_PROTOCOLO": "sample string 5",
    "ID_DIGITOVERIFICADOR": "sample string 6",
    "DS_SRF_PF": "sample string 7",
    "NR_ANO_OBITO": "sample string 8",
    "DS_INSCRICAO": "sample string 9",
    "NR_CPF": 1,
    "NM_COMPLETO": "sample string 10",
    "NM_SOCIAL_COMPLETO": "sample string 11",
    "DT_NASCIMENTO": "2025-12-19T15:55:52.8556197-03:00",
    "ERRO": {
      "CODIGO": 1,
      "MENSAGEM": "sample string 3"
    }
  },
  "BENEFICIOS_GOVERNO": {
    "FG_AUXILIO_BRASIL": true,
    "FG_AUXILIO_EMERGENCIAL": true,
    "FG_BOLSA_FAMILIA": true,
    "FG_BPC": true,
    "FG_GARANTIA_SAFRA": true,
    "FG_SEGURO_DEFESO": true,
    "FG_NOVO_BOLSA_FAMILIA": true,
    "ERRO": {
      "CODIGO": 1,
      "MENSAGEM": "sample string 3"
    }
  },
  "TITULO_ELEITOR": {
    "NR_TITULO": "sample string 1",
    "NR_ZONA": "sample string 2",
    "NR_SECAO": "sample string 3",
    "ERRO": {
      "CODIGO": 1,
      "MENSAGEM": "sample string 3"
    }
  },
  "ERRO": {
    "CODIGO": 1,
    "MENSAGEM": "sample string 3"
  }
}

application/xml, text/xml

Sample:

<RetornoBaseNacionalPf xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="API.ZipOnline">
  <ERRO xmlns="TransUnion.API">
    <CODIGO>1</CODIGO>
    <MENSAGEM>sample string 3</MENSAGEM>
  </ERRO>
  <BENEFICIOS_GOVERNO>
    <ERRO xmlns="TransUnion.API">
      <CODIGO>1</CODIGO>
      <MENSAGEM>sample string 3</MENSAGEM>
    </ERRO>
    <FG_AUXILIO_BRASIL>true</FG_AUXILIO_BRASIL>
    <FG_AUXILIO_EMERGENCIAL>true</FG_AUXILIO_EMERGENCIAL>
    <FG_BOLSA_FAMILIA>true</FG_BOLSA_FAMILIA>
    <FG_BPC>true</FG_BPC>
    <FG_GARANTIA_SAFRA>true</FG_GARANTIA_SAFRA>
    <FG_NOVO_BOLSA_FAMILIA>true</FG_NOVO_BOLSA_FAMILIA>
    <FG_SEGURO_DEFESO>true</FG_SEGURO_DEFESO>
  </BENEFICIOS_GOVERNO>
  <DADOS_COMPLEMENTARES>
    <ERRO xmlns="TransUnion.API">
      <CODIGO>1</CODIGO>
      <MENSAGEM>sample string 3</MENSAGEM>
    </ERRO>
    <DS_CARGO>sample string 3</DS_CARGO>
    <DS_ESCOLARIDADE>sample string 7</DS_ESCOLARIDADE>
    <DS_ESTADOCIVIL>sample string 5</DS_ESTADOCIVIL>
    <DS_FAIXAVALOR>sample string 2</DS_FAIXAVALOR>
    <DS_NACIONALIDADE>sample string 6</DS_NACIONALIDADE>
    <DS_PROFISSAO>sample string 1</DS_PROFISSAO>
    <DT_RECENCIA>2025-12-19T15:55:52.8556197-03:00</DT_RECENCIA>
    <ID_AUX_CARGO>1</ID_AUX_CARGO>
    <ID_AUX_FAIXAVALOR>1</ID_AUX_FAIXAVALOR>
    <ID_AUX_PROFISSAO>1</ID_AUX_PROFISSAO>
    <NR_PIS>sample string 8</NR_PIS>
    <NR_RG>sample string 4</NR_RG>
    <SG_ESTADOCIVIL>sample string 9</SG_ESTADOCIVIL>
    <SG_ORGAO_EMISSOR>sample string 11</SG_ORGAO_EMISSOR>
    <UF_RG>sample string 10</UF_RG>
    <VALOR_RENDA>1</VALOR_RENDA>
  </DADOS_COMPLEMENTARES>
  <DADOS_PRINCIPAIS>
    <ERRO xmlns="TransUnion.API">
      <CODIGO>1</CODIGO>
      <MENSAGEM>sample string 3</MENSAGEM>
    </ERRO>
    <DS_SEXO>sample string 5</DS_SEXO>
    <DS_SIGNO>sample string 6</DS_SIGNO>
    <DT_NASCIMENTO>2025-12-19T15:55:52.8399945-03:00</DT_NASCIMENTO>
    <DT_RECENCIA>2025-12-19T15:55:52.8399945-03:00</DT_RECENCIA>
    <FG_OBITO>true</FG_OBITO>
    <NM_COMPLETO>sample string 2</NM_COMPLETO>
    <NM_SOCIAL_COMPLETO>sample string 3</NM_SOCIAL_COMPLETO>
    <NR_ANO_OBITO>sample string 1</NR_ANO_OBITO>
    <NR_CPF>sample string 4</NR_CPF>
    <NR_IDADE>1</NR_IDADE>
  </DADOS_PRINCIPAIS>
  <SITUACAO_SRF>
    <ERRO xmlns="TransUnion.API">
      <CODIGO>1</CODIGO>
      <MENSAGEM>sample string 3</MENSAGEM>
    </ERRO>
    <DS_INSCRICAO>sample string 9</DS_INSCRICAO>
    <DS_PROTOCOLO>sample string 5</DS_PROTOCOLO>
    <DS_SRF_PF>sample string 7</DS_SRF_PF>
    <DT_CONSULTA>2025-12-19T15:55:52.8556197-03:00</DT_CONSULTA>
    <DT_NASCIMENTO>2025-12-19T15:55:52.8556197-03:00</DT_NASCIMENTO>
    <HR_CONSULTA>sample string 3</HR_CONSULTA>
    <ID_DIGITOVERIFICADOR>sample string 6</ID_DIGITOVERIFICADOR>
    <NM_COMPLETO>sample string 10</NM_COMPLETO>
    <NM_SOCIAL_COMPLETO>sample string 11</NM_SOCIAL_COMPLETO>
    <NR_ANO_OBITO>sample string 8</NR_ANO_OBITO>
    <NR_CPF>1</NR_CPF>
  </SITUACAO_SRF>
  <TITULO_ELEITOR>
    <ERRO xmlns="TransUnion.API">
      <CODIGO>1</CODIGO>
      <MENSAGEM>sample string 3</MENSAGEM>
    </ERRO>
    <NR_SECAO>sample string 3</NR_SECAO>
    <NR_TITULO>sample string 1</NR_TITULO>
    <NR_ZONA>sample string 2</NR_ZONA>
  </TITULO_ELEITOR>
</RetornoBaseNacionalPf>

Sobre Nós

Suporte técnico

Entre em Contato

Política de Privacidade