POST PF/ConsultaBeneficiosDoGovernoConsolidada

A consulta informa se a pessoa possui benefícios oferecidos pelo governo, totalizando valores e datas de recebimento. Informação captada, atribuída e trabalhada a partir de fontes públicas. 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 Consolidada da PF Beneficios do Governo na API Base Estática do ZipOnline.

TransUnion.Consultas.DTO.Parametros.TransUnion.ParametrosEntradaBeneficiosConsolidadoPF

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

Request Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

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

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

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

TransUnion.Consultas.DTO.Retorno.ResultadoPFBeneficiosConsolidada

Name	Type	Additional information
NOME	string	None.
CPF	string	None.
MENOR_IDADE	boolean	None.
PERIODO_CONSOLIDADO	string	None.
ULTIMOS_MESES	TransUnion.Consultas.DTO.Retorno.SumarioPFBeneficiosConsolidada	None.
MESES_ANTERIOR	TransUnion.Consultas.DTO.Retorno.SumarioPFBeneficiosConsolidada	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,
  "PERIODO_CONSOLIDADO": "sample string 4",
  "ULTIMOS_MESES": {
    "PERIODO_CONSOLIDADO": "sample string 1",
    "SUMARIO_BENEFICIOS": [
      {
        "NM_BENEFICIO": "sample string 1",
        "TOTAL_PARCELAS_RECEBIDAS": 2,
        "VL_TOTAL_RECEBIDO": 1.0,
        "NR_MES_REFERENCIA_MAIS_RECENTE": "sample string 3",
        "NR_MES_REFERENCIA_MAIS_ANTIGO": "sample string 4",
        "ERRO": {
          "CODIGO": 1,
          "MENSAGEM": "sample string 3"
        }
      },
      {
        "NM_BENEFICIO": "sample string 1",
        "TOTAL_PARCELAS_RECEBIDAS": 2,
        "VL_TOTAL_RECEBIDO": 1.0,
        "NR_MES_REFERENCIA_MAIS_RECENTE": "sample string 3",
        "NR_MES_REFERENCIA_MAIS_ANTIGO": "sample string 4",
        "ERRO": {
          "CODIGO": 1,
          "MENSAGEM": "sample string 3"
        }
      }
    ],
    "ERRO": {
      "CODIGO": 1,
      "MENSAGEM": "sample string 3"
    }
  },
  "MESES_ANTERIOR": {
    "PERIODO_CONSOLIDADO": "sample string 1",
    "SUMARIO_BENEFICIOS": [
      {
        "NM_BENEFICIO": "sample string 1",
        "TOTAL_PARCELAS_RECEBIDAS": 2,
        "VL_TOTAL_RECEBIDO": 1.0,
        "NR_MES_REFERENCIA_MAIS_RECENTE": "sample string 3",
        "NR_MES_REFERENCIA_MAIS_ANTIGO": "sample string 4",
        "ERRO": {
          "CODIGO": 1,
          "MENSAGEM": "sample string 3"
        }
      },
      {
        "NM_BENEFICIO": "sample string 1",
        "TOTAL_PARCELAS_RECEBIDAS": 2,
        "VL_TOTAL_RECEBIDO": 1.0,
        "NR_MES_REFERENCIA_MAIS_RECENTE": "sample string 3",
        "NR_MES_REFERENCIA_MAIS_ANTIGO": "sample string 4",
        "ERRO": {
          "CODIGO": 1,
          "MENSAGEM": "sample string 3"
        }
      }
    ],
    "ERRO": {
      "CODIGO": 1,
      "MENSAGEM": "sample string 3"
    }
  },
  "ERRO": {
    "CODIGO": 1,
    "MENSAGEM": "sample string 3"
  }
}

application/xml, text/xml

Sample:

<ResultadoPFBeneficiosConsolidada 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>
  <CPF>sample string 2</CPF>
  <MENOR_IDADE>true</MENOR_IDADE>
  <MESES_ANTERIOR>
    <ERRO xmlns="TransUnion.API">
      <CODIGO>1</CODIGO>
      <MENSAGEM>sample string 3</MENSAGEM>
    </ERRO>
    <PERIODO_CONSOLIDADO>sample string 1</PERIODO_CONSOLIDADO>
    <SUMARIO_BENEFICIOS>
      <ItemBeneficioConsolidada>
        <ERRO xmlns="TransUnion.API">
          <CODIGO>1</CODIGO>
          <MENSAGEM>sample string 3</MENSAGEM>
        </ERRO>
        <NM_BENEFICIO>sample string 1</NM_BENEFICIO>
        <NR_MES_REFERENCIA_MAIS_ANTIGO>sample string 4</NR_MES_REFERENCIA_MAIS_ANTIGO>
        <NR_MES_REFERENCIA_MAIS_RECENTE>sample string 3</NR_MES_REFERENCIA_MAIS_RECENTE>
        <TOTAL_PARCELAS_RECEBIDAS>2</TOTAL_PARCELAS_RECEBIDAS>
        <VL_TOTAL_RECEBIDO>1</VL_TOTAL_RECEBIDO>
      </ItemBeneficioConsolidada>
      <ItemBeneficioConsolidada>
        <ERRO xmlns="TransUnion.API">
          <CODIGO>1</CODIGO>
          <MENSAGEM>sample string 3</MENSAGEM>
        </ERRO>
        <NM_BENEFICIO>sample string 1</NM_BENEFICIO>
        <NR_MES_REFERENCIA_MAIS_ANTIGO>sample string 4</NR_MES_REFERENCIA_MAIS_ANTIGO>
        <NR_MES_REFERENCIA_MAIS_RECENTE>sample string 3</NR_MES_REFERENCIA_MAIS_RECENTE>
        <TOTAL_PARCELAS_RECEBIDAS>2</TOTAL_PARCELAS_RECEBIDAS>
        <VL_TOTAL_RECEBIDO>1</VL_TOTAL_RECEBIDO>
      </ItemBeneficioConsolidada>
    </SUMARIO_BENEFICIOS>
  </MESES_ANTERIOR>
  <NOME>sample string 1</NOME>
  <PERIODO_CONSOLIDADO>sample string 4</PERIODO_CONSOLIDADO>
  <ULTIMOS_MESES>
    <ERRO xmlns="TransUnion.API">
      <CODIGO>1</CODIGO>
      <MENSAGEM>sample string 3</MENSAGEM>
    </ERRO>
    <PERIODO_CONSOLIDADO>sample string 1</PERIODO_CONSOLIDADO>
    <SUMARIO_BENEFICIOS>
      <ItemBeneficioConsolidada>
        <ERRO xmlns="TransUnion.API">
          <CODIGO>1</CODIGO>
          <MENSAGEM>sample string 3</MENSAGEM>
        </ERRO>
        <NM_BENEFICIO>sample string 1</NM_BENEFICIO>
        <NR_MES_REFERENCIA_MAIS_ANTIGO>sample string 4</NR_MES_REFERENCIA_MAIS_ANTIGO>
        <NR_MES_REFERENCIA_MAIS_RECENTE>sample string 3</NR_MES_REFERENCIA_MAIS_RECENTE>
        <TOTAL_PARCELAS_RECEBIDAS>2</TOTAL_PARCELAS_RECEBIDAS>
        <VL_TOTAL_RECEBIDO>1</VL_TOTAL_RECEBIDO>
      </ItemBeneficioConsolidada>
      <ItemBeneficioConsolidada>
        <ERRO xmlns="TransUnion.API">
          <CODIGO>1</CODIGO>
          <MENSAGEM>sample string 3</MENSAGEM>
        </ERRO>
        <NM_BENEFICIO>sample string 1</NM_BENEFICIO>
        <NR_MES_REFERENCIA_MAIS_ANTIGO>sample string 4</NR_MES_REFERENCIA_MAIS_ANTIGO>
        <NR_MES_REFERENCIA_MAIS_RECENTE>sample string 3</NR_MES_REFERENCIA_MAIS_RECENTE>
        <TOTAL_PARCELAS_RECEBIDAS>2</TOTAL_PARCELAS_RECEBIDAS>
        <VL_TOTAL_RECEBIDO>1</VL_TOTAL_RECEBIDO>
      </ItemBeneficioConsolidada>
    </SUMARIO_BENEFICIOS>
  </ULTIMOS_MESES>
</ResultadoPFBeneficiosConsolidada>

Sobre Nós

Suporte técnico

Entre em Contato

Política de Privacidade