Benefícios Sociais Recebidos pela Família

Benefícios e programas sociais recebidos pelos familiares da pessoa. Mostra quantos familiares recebem, o total recebido e, para cada benefício, o valor da parcela e o período. Consulta-se pelo CPF e usa dados do Portal da Transparência.

POST/v1/beneficios-sociais-familiares/consultas

Órgão
Portal da Transparência
Prazo máximo
180 s
PDF
Não entrega

Campos do corpo

  • cpfobrigatório

    CPF, com ou sem máscara

    CPF da pessoa consultada.

  • referenciaopcional

    Texto, até 80

    Seu identificador. Volta na resposta, no webhook e no histórico.

  • filtroopcional

    Objeto

    Devolve só os itens de detalhe.itens que batem: {"campo": valor}.

  • ordenaropcional

    Nome de um campo do item

    - na frente para a ordem decrescente.

  • limiteopcional

    Inteiro de 1 a 1000

    Quantos itens devolver.

Resultados possíveis

dadossem_registros

Decida pelo campo codigo. Consulta que o órgão não respondeu volta como sem_retorno ou em_processamento e não é cobrada.

O que vem em detalhe

detalhe.dados

  • familiaresConsideradosFamiliares considerados
  • familiaresQueJaReceberamFamiliares que já receberam
  • familiaresQueRecebemHojeFamiliares que recebem hoje
  • beneficiosBenefícios
  • beneficiosAtivosBenefícios ativos
  • totalRecebidoTotal recebido
  • parcelasRecebidasParcelas recebidas
  • parcelasReceberParcelas a receber
  • rendaBeneficiosFamiliaUltimoMesRenda de benefícios da família no último mês
  • rendaBeneficiosFamilia3MesesRenda de benefícios da família em 3 meses
  • rendaBeneficiosFamilia6MesesRenda de benefícios da família em 6 meses
  • rendaBeneficiosFamilia12MesesRenda de benefícios da família em 12 meses
  • rendaBeneficiosFamilia3AnosRenda de benefícios da família em 3 anos
  • rendaBeneficiosFamilia5AnosRenda de benefícios da família em 5 anos
  • rendaBeneficiosPorPessoaUltimoMesRenda de benefícios por pessoa no último mês
  • rendaBeneficiosPorPessoa3MesesRenda de benefícios por pessoa em 3 meses
  • rendaBeneficiosPorPessoa6MesesRenda de benefícios por pessoa em 6 meses
  • rendaBeneficiosPorPessoa12MesesRenda de benefícios por pessoa em 12 meses
  • rendaBeneficiosPorPessoa3AnosRenda de benefícios por pessoa em 3 anos
  • rendaBeneficiosPorPessoa5AnosRenda de benefícios por pessoa em 5 anos
  • rendaMediaFamiliaFaixaRenda média da família (faixa)
  • pesoBeneficiosRendaPeso dos benefícios na renda

detalhe.itens, um por registro

  • familiaresQueJaReceberamFamiliares que já receberam
  • familiaresQueRecebemHojeFamiliares que recebem hoje
  • totalRecebidoTotal recebido
  • maiorTotalRecebidoPorUmFamiliarMaior total recebido por um familiar
  • menorTotalRecebidoPorUmFamiliarMenor total recebido por um familiar
  • totalMedioPorFamiliarTotal médio por familiar
  • menosParcelasRecebidasPorUmFamiliarMenos parcelas recebidas por um familiar
  • maisParcelasRecebidasPorUmFamiliarMais parcelas recebidas por um familiar
  • parcelasPorFamiliarMediaParcelas por familiar (média)
  • parcelasRecebidasParcelas recebidas
  • parcelasReceberParcelas a receber
  • parcelasTotalParcelas no total
  • primeiroInicioPrimeiro início
  • ultimoFimÚltimo fim

Cada campo só é enviado quando o órgão preencheu.

Observações

  • Cada benefício vem como um item em detalhe.itens.
  • Para os benefícios só da pessoa, use beneficios-sociais.