POST PF/ConsultaBeneficiosDoGoverno

A consulta exibe histórico de cada benefício do governo que a pessoa física possui, sendo opcional informar o ano dos benefícios. Auxilio Emergencial e Bolsa Familia possuem dados sem atualização recorrente.

Request Information

URI Parameters

None.

Body Parameters

Objeto contendo os parâmetros de entrada para a Consulta PF Beneficios do Governo na API Base Estática do ZipOnline.

TransUnion.Consultas.DTO.Parametros.TransUnion.ParametrosEntradaBeneficiosGovernoPF

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

Request Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

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

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Pessoa Física e seus benefícios do governo. Auxilio Emergencial e Bolsa Familia possuem dados sem atualização recorrente

TransUnion.Consultas.DTO.Retorno.ResultadoPFBeneficiosGoverno

Name	Type	Additional information
NOME	string	None.
CPF	string	None.
MENOR_IDADE	boolean	None.
AUXILIO_BRASIL	TransUnion.Consultas.DTO.Retorno.BeneficiosGoverno.AuxilioBrasil	None.
AUXILIO_EMERGENCIAL	TransUnion.Consultas.DTO.Retorno.BeneficiosGoverno.AuxilioEmergencial	None.
BOLSA_FAMILIA	TransUnion.Consultas.DTO.Retorno.BeneficiosGoverno.BolsaFamilia	None.
BPC	TransUnion.Consultas.DTO.Retorno.BeneficiosGoverno.BPC	None.
GARANTIA_SAFRA	TransUnion.Consultas.DTO.Retorno.BeneficiosGoverno.GarantiaSafra	None.
SEGURO_DEFESO	TransUnion.Consultas.DTO.Retorno.BeneficiosGoverno.SeguroDefeso	None.
NOVO_BOLSA_FAMILIA	TransUnion.Consultas.DTO.Retorno.BeneficiosGoverno.NovoBolsaFamilia	None.
ERRO	TransUnion.Common.DTO.Erro	None.

Response Formats

application/json, text/json

Sample:

{
  "NOME": "sample string 1",
  "CPF": "sample string 2",
  "MENOR_IDADE": true,
  "AUXILIO_BRASIL": {
    "DADOS_HISTORICOS": true,
    "LISTAGEM": [
      {
        "NR_MES_REFERENCIA": "sample string 1",
        "NR_NIS": "sample string 2",
        "NM_MUNICIPIO": "sample string 3",
        "SG_UF": "sample string 4",
        "VL_PARCELA": 1.0,
        "DT_SAQUE": "sample string 5"
      },
      {
        "NR_MES_REFERENCIA": "sample string 1",
        "NR_NIS": "sample string 2",
        "NM_MUNICIPIO": "sample string 3",
        "SG_UF": "sample string 4",
        "VL_PARCELA": 1.0,
        "DT_SAQUE": "sample string 5"
      }
    ],
    "ERRO": {
      "CODIGO": 1,
      "MENSAGEM": "sample string 3"
    }
  },
  "AUXILIO_EMERGENCIAL": {
    "DADOS_HISTORICOS": true,
    "LISTAGEM": [
      {
        "NR_MES_REFERENCIA": "sample string 1",
        "NR_NIS": "sample string 2",
        "NM_MUNICIPIO": "sample string 3",
        "SG_UF": "sample string 4",
        "NR_NIS_REPRESENTANTE_LEGAL": "sample string 5",
        "NR_CPF_REPRESENTANTE_LEGAL": "sample string 6",
        "DS_ENQUADRAMENTO": "sample string 7",
        "DS_PARCELA": "sample string 8",
        "VL_PARCELA": 1.0
      },
      {
        "NR_MES_REFERENCIA": "sample string 1",
        "NR_NIS": "sample string 2",
        "NM_MUNICIPIO": "sample string 3",
        "SG_UF": "sample string 4",
        "NR_NIS_REPRESENTANTE_LEGAL": "sample string 5",
        "NR_CPF_REPRESENTANTE_LEGAL": "sample string 6",
        "DS_ENQUADRAMENTO": "sample string 7",
        "DS_PARCELA": "sample string 8",
        "VL_PARCELA": 1.0
      }
    ],
    "ERRO": {
      "CODIGO": 1,
      "MENSAGEM": "sample string 3"
    }
  },
  "BOLSA_FAMILIA": {
    "DADOS_HISTORICOS": true,
    "LISTAGEM": [
      {
        "NR_MES_REFERENCIA": "sample string 1",
        "NR_NIS": "sample string 2",
        "NM_MUNICIPIO": "sample string 3",
        "SG_UF": "sample string 4",
        "VL_PARCELA": 1.0,
        "DT_SAQUE": "sample string 5"
      },
      {
        "NR_MES_REFERENCIA": "sample string 1",
        "NR_NIS": "sample string 2",
        "NM_MUNICIPIO": "sample string 3",
        "SG_UF": "sample string 4",
        "VL_PARCELA": 1.0,
        "DT_SAQUE": "sample string 5"
      }
    ],
    "ERRO": {
      "CODIGO": 1,
      "MENSAGEM": "sample string 3"
    }
  },
  "BPC": {
    "DADOS_HISTORICOS": true,
    "LISTAGEM": [
      {
        "NR_MES_REFERENCIA": "sample string 1",
        "NR_NIS": "sample string 2",
        "NM_MUNICIPIO": "sample string 3",
        "SG_UF": "sample string 4",
        "NR_NIS_REPRESENTANTE_LEGAL": "sample string 5",
        "NR_CPF_REPRESENTANTE_LEGAL": "sample string 6",
        "DS_CONCEDIDO_JUDICIALMENTE": "sample string 7",
        "NR_BENEFICIO": "sample string 8",
        "VL_PARCELA": 1.0
      },
      {
        "NR_MES_REFERENCIA": "sample string 1",
        "NR_NIS": "sample string 2",
        "NM_MUNICIPIO": "sample string 3",
        "SG_UF": "sample string 4",
        "NR_NIS_REPRESENTANTE_LEGAL": "sample string 5",
        "NR_CPF_REPRESENTANTE_LEGAL": "sample string 6",
        "DS_CONCEDIDO_JUDICIALMENTE": "sample string 7",
        "NR_BENEFICIO": "sample string 8",
        "VL_PARCELA": 1.0
      }
    ],
    "ERRO": {
      "CODIGO": 1,
      "MENSAGEM": "sample string 3"
    }
  },
  "GARANTIA_SAFRA": {
    "DADOS_HISTORICOS": true,
    "LISTAGEM": [
      {
        "NR_MES_REFERENCIA": "sample string 1",
        "NR_NIS": "sample string 2",
        "NM_MUNICIPIO": "sample string 3",
        "SG_UF": "sample string 4",
        "VL_PARCELA": 1.0
      },
      {
        "NR_MES_REFERENCIA": "sample string 1",
        "NR_NIS": "sample string 2",
        "NM_MUNICIPIO": "sample string 3",
        "SG_UF": "sample string 4",
        "VL_PARCELA": 1.0
      }
    ],
    "ERRO": {
      "CODIGO": 1,
      "MENSAGEM": "sample string 3"
    }
  },
  "SEGURO_DEFESO": {
    "DADOS_HISTORICOS": true,
    "LISTAGEM": [
      {
        "NR_MES_REFERENCIA": "sample string 1",
        "NR_NIS": "sample string 2",
        "NM_MUNICIPIO": "sample string 3",
        "SG_UF": "sample string 4",
        "CD_RGP": "sample string 5",
        "VL_PARCELA": 1.0
      },
      {
        "NR_MES_REFERENCIA": "sample string 1",
        "NR_NIS": "sample string 2",
        "NM_MUNICIPIO": "sample string 3",
        "SG_UF": "sample string 4",
        "CD_RGP": "sample string 5",
        "VL_PARCELA": 1.0
      }
    ],
    "ERRO": {
      "CODIGO": 1,
      "MENSAGEM": "sample string 3"
    }
  },
  "NOVO_BOLSA_FAMILIA": {
    "DADOS_HISTORICOS": true,
    "LISTAGEM": [
      {
        "NR_MES_REFERENCIA": "sample string 1",
        "NR_NIS": "sample string 2",
        "NM_MUNICIPIO": "sample string 3",
        "SG_UF": "sample string 4",
        "VL_PARCELA": 1.0
      },
      {
        "NR_MES_REFERENCIA": "sample string 1",
        "NR_NIS": "sample string 2",
        "NM_MUNICIPIO": "sample string 3",
        "SG_UF": "sample string 4",
        "VL_PARCELA": 1.0
      }
    ],
    "ERRO": {
      "CODIGO": 1,
      "MENSAGEM": "sample string 3"
    }
  },
  "ERRO": {
    "CODIGO": 1,
    "MENSAGEM": "sample string 3"
  }
}

application/xml, text/xml

Sample:

<ResultadoPFBeneficiosGoverno 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>
  <AUXILIO_BRASIL>
    <ERRO xmlns="TransUnion.API">
      <CODIGO>1</CODIGO>
      <MENSAGEM>sample string 3</MENSAGEM>
    </ERRO>
    <DADOS_HISTORICOS>true</DADOS_HISTORICOS>
    <LISTAGEM>
      <ResultadoItemAuxilioBrasil>
        <DT_SAQUE>sample string 5</DT_SAQUE>
        <NM_MUNICIPIO>sample string 3</NM_MUNICIPIO>
        <NR_MES_REFERENCIA>sample string 1</NR_MES_REFERENCIA>
        <NR_NIS>sample string 2</NR_NIS>
        <SG_UF>sample string 4</SG_UF>
        <VL_PARCELA>1</VL_PARCELA>
      </ResultadoItemAuxilioBrasil>
      <ResultadoItemAuxilioBrasil>
        <DT_SAQUE>sample string 5</DT_SAQUE>
        <NM_MUNICIPIO>sample string 3</NM_MUNICIPIO>
        <NR_MES_REFERENCIA>sample string 1</NR_MES_REFERENCIA>
        <NR_NIS>sample string 2</NR_NIS>
        <SG_UF>sample string 4</SG_UF>
        <VL_PARCELA>1</VL_PARCELA>
      </ResultadoItemAuxilioBrasil>
    </LISTAGEM>
  </AUXILIO_BRASIL>
  <AUXILIO_EMERGENCIAL>
    <ERRO xmlns="TransUnion.API">
      <CODIGO>1</CODIGO>
      <MENSAGEM>sample string 3</MENSAGEM>
    </ERRO>
    <DADOS_HISTORICOS>true</DADOS_HISTORICOS>
    <LISTAGEM>
      <ResultadoItemAuxilioEmergencial>
        <DS_ENQUADRAMENTO>sample string 7</DS_ENQUADRAMENTO>
        <DS_PARCELA>sample string 8</DS_PARCELA>
        <NM_MUNICIPIO>sample string 3</NM_MUNICIPIO>
        <NR_CPF_REPRESENTANTE_LEGAL>sample string 6</NR_CPF_REPRESENTANTE_LEGAL>
        <NR_MES_REFERENCIA>sample string 1</NR_MES_REFERENCIA>
        <NR_NIS>sample string 2</NR_NIS>
        <NR_NIS_REPRESENTANTE_LEGAL>sample string 5</NR_NIS_REPRESENTANTE_LEGAL>
        <SG_UF>sample string 4</SG_UF>
        <VL_PARCELA>1</VL_PARCELA>
      </ResultadoItemAuxilioEmergencial>
      <ResultadoItemAuxilioEmergencial>
        <DS_ENQUADRAMENTO>sample string 7</DS_ENQUADRAMENTO>
        <DS_PARCELA>sample string 8</DS_PARCELA>
        <NM_MUNICIPIO>sample string 3</NM_MUNICIPIO>
        <NR_CPF_REPRESENTANTE_LEGAL>sample string 6</NR_CPF_REPRESENTANTE_LEGAL>
        <NR_MES_REFERENCIA>sample string 1</NR_MES_REFERENCIA>
        <NR_NIS>sample string 2</NR_NIS>
        <NR_NIS_REPRESENTANTE_LEGAL>sample string 5</NR_NIS_REPRESENTANTE_LEGAL>
        <SG_UF>sample string 4</SG_UF>
        <VL_PARCELA>1</VL_PARCELA>
      </ResultadoItemAuxilioEmergencial>
    </LISTAGEM>
  </AUXILIO_EMERGENCIAL>
  <BOLSA_FAMILIA>
    <ERRO xmlns="TransUnion.API">
      <CODIGO>1</CODIGO>
      <MENSAGEM>sample string 3</MENSAGEM>
    </ERRO>
    <DADOS_HISTORICOS>true</DADOS_HISTORICOS>
    <LISTAGEM>
      <ResultadoItemBolsaFamilia>
        <DT_SAQUE>sample string 5</DT_SAQUE>
        <NM_MUNICIPIO>sample string 3</NM_MUNICIPIO>
        <NR_MES_REFERENCIA>sample string 1</NR_MES_REFERENCIA>
        <NR_NIS>sample string 2</NR_NIS>
        <SG_UF>sample string 4</SG_UF>
        <VL_PARCELA>1</VL_PARCELA>
      </ResultadoItemBolsaFamilia>
      <ResultadoItemBolsaFamilia>
        <DT_SAQUE>sample string 5</DT_SAQUE>
        <NM_MUNICIPIO>sample string 3</NM_MUNICIPIO>
        <NR_MES_REFERENCIA>sample string 1</NR_MES_REFERENCIA>
        <NR_NIS>sample string 2</NR_NIS>
        <SG_UF>sample string 4</SG_UF>
        <VL_PARCELA>1</VL_PARCELA>
      </ResultadoItemBolsaFamilia>
    </LISTAGEM>
  </BOLSA_FAMILIA>
  <BPC>
    <ERRO xmlns="TransUnion.API">
      <CODIGO>1</CODIGO>
      <MENSAGEM>sample string 3</MENSAGEM>
    </ERRO>
    <DADOS_HISTORICOS>true</DADOS_HISTORICOS>
    <LISTAGEM>
      <ResultadoItemBPC>
        <DS_CONCEDIDO_JUDICIALMENTE>sample string 7</DS_CONCEDIDO_JUDICIALMENTE>
        <NM_MUNICIPIO>sample string 3</NM_MUNICIPIO>
        <NR_BENEFICIO>sample string 8</NR_BENEFICIO>
        <NR_CPF_REPRESENTANTE_LEGAL>sample string 6</NR_CPF_REPRESENTANTE_LEGAL>
        <NR_MES_REFERENCIA>sample string 1</NR_MES_REFERENCIA>
        <NR_NIS>sample string 2</NR_NIS>
        <NR_NIS_REPRESENTANTE_LEGAL>sample string 5</NR_NIS_REPRESENTANTE_LEGAL>
        <SG_UF>sample string 4</SG_UF>
        <VL_PARCELA>1</VL_PARCELA>
      </ResultadoItemBPC>
      <ResultadoItemBPC>
        <DS_CONCEDIDO_JUDICIALMENTE>sample string 7</DS_CONCEDIDO_JUDICIALMENTE>
        <NM_MUNICIPIO>sample string 3</NM_MUNICIPIO>
        <NR_BENEFICIO>sample string 8</NR_BENEFICIO>
        <NR_CPF_REPRESENTANTE_LEGAL>sample string 6</NR_CPF_REPRESENTANTE_LEGAL>
        <NR_MES_REFERENCIA>sample string 1</NR_MES_REFERENCIA>
        <NR_NIS>sample string 2</NR_NIS>
        <NR_NIS_REPRESENTANTE_LEGAL>sample string 5</NR_NIS_REPRESENTANTE_LEGAL>
        <SG_UF>sample string 4</SG_UF>
        <VL_PARCELA>1</VL_PARCELA>
      </ResultadoItemBPC>
    </LISTAGEM>
  </BPC>
  <CPF>sample string 2</CPF>
  <GARANTIA_SAFRA>
    <ERRO xmlns="TransUnion.API">
      <CODIGO>1</CODIGO>
      <MENSAGEM>sample string 3</MENSAGEM>
    </ERRO>
    <DADOS_HISTORICOS>true</DADOS_HISTORICOS>
    <LISTAGEM>
      <ResultadoItemGarantiaSafra>
        <NM_MUNICIPIO>sample string 3</NM_MUNICIPIO>
        <NR_MES_REFERENCIA>sample string 1</NR_MES_REFERENCIA>
        <NR_NIS>sample string 2</NR_NIS>
        <SG_UF>sample string 4</SG_UF>
        <VL_PARCELA>1</VL_PARCELA>
      </ResultadoItemGarantiaSafra>
      <ResultadoItemGarantiaSafra>
        <NM_MUNICIPIO>sample string 3</NM_MUNICIPIO>
        <NR_MES_REFERENCIA>sample string 1</NR_MES_REFERENCIA>
        <NR_NIS>sample string 2</NR_NIS>
        <SG_UF>sample string 4</SG_UF>
        <VL_PARCELA>1</VL_PARCELA>
      </ResultadoItemGarantiaSafra>
    </LISTAGEM>
  </GARANTIA_SAFRA>
  <MENOR_IDADE>true</MENOR_IDADE>
  <NOME>sample string 1</NOME>
  <NOVO_BOLSA_FAMILIA>
    <ERRO xmlns="TransUnion.API">
      <CODIGO>1</CODIGO>
      <MENSAGEM>sample string 3</MENSAGEM>
    </ERRO>
    <DADOS_HISTORICOS>true</DADOS_HISTORICOS>
    <LISTAGEM>
      <ResultadoItemNovoBolsaFamilia>
        <NM_MUNICIPIO>sample string 3</NM_MUNICIPIO>
        <NR_MES_REFERENCIA>sample string 1</NR_MES_REFERENCIA>
        <NR_NIS>sample string 2</NR_NIS>
        <SG_UF>sample string 4</SG_UF>
        <VL_PARCELA>1</VL_PARCELA>
      </ResultadoItemNovoBolsaFamilia>
      <ResultadoItemNovoBolsaFamilia>
        <NM_MUNICIPIO>sample string 3</NM_MUNICIPIO>
        <NR_MES_REFERENCIA>sample string 1</NR_MES_REFERENCIA>
        <NR_NIS>sample string 2</NR_NIS>
        <SG_UF>sample string 4</SG_UF>
        <VL_PARCELA>1</VL_PARCELA>
      </ResultadoItemNovoBolsaFamilia>
    </LISTAGEM>
  </NOVO_BOLSA_FAMILIA>
  <SEGURO_DEFESO>
    <ERRO xmlns="TransUnion.API">
      <CODIGO>1</CODIGO>
      <MENSAGEM>sample string 3</MENSAGEM>
    </ERRO>
    <DADOS_HISTORICOS>true</DADOS_HISTORICOS>
    <LISTAGEM>
      <ResultadoItemSeguroDefeso>
        <CD_RGP>sample string 5</CD_RGP>
        <NM_MUNICIPIO>sample string 3</NM_MUNICIPIO>
        <NR_MES_REFERENCIA>sample string 1</NR_MES_REFERENCIA>
        <NR_NIS>sample string 2</NR_NIS>
        <SG_UF>sample string 4</SG_UF>
        <VL_PARCELA>1</VL_PARCELA>
      </ResultadoItemSeguroDefeso>
      <ResultadoItemSeguroDefeso>
        <CD_RGP>sample string 5</CD_RGP>
        <NM_MUNICIPIO>sample string 3</NM_MUNICIPIO>
        <NR_MES_REFERENCIA>sample string 1</NR_MES_REFERENCIA>
        <NR_NIS>sample string 2</NR_NIS>
        <SG_UF>sample string 4</SG_UF>
        <VL_PARCELA>1</VL_PARCELA>
      </ResultadoItemSeguroDefeso>
    </LISTAGEM>
  </SEGURO_DEFESO>
</ResultadoPFBeneficiosGoverno>

Sobre Nós

Suporte técnico

Entre em Contato

Política de Privacidade