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
- Não entrega
Campos do corpo
cpfobrigatórioCPF, com ou sem máscara
CPF da pessoa consultada.
referenciaopcionalTexto, até 80
Seu identificador. Volta na resposta, no webhook e no histórico.
filtroopcionalObjeto
Devolve só os itens de
detalhe.itensque batem:{"campo": valor}.ordenaropcionalNome de um campo do item
-na frente para a ordem decrescente.limiteopcionalInteiro 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 consideradosfamiliaresQueJaReceberamFamiliares que já receberamfamiliaresQueRecebemHojeFamiliares que recebem hojebeneficiosBenefíciosbeneficiosAtivosBenefícios ativostotalRecebidoTotal recebidoparcelasRecebidasParcelas recebidasparcelasReceberParcelas a receberrendaBeneficiosFamiliaUltimoMesRenda de benefícios da família no último mêsrendaBeneficiosFamilia3MesesRenda de benefícios da família em 3 mesesrendaBeneficiosFamilia6MesesRenda de benefícios da família em 6 mesesrendaBeneficiosFamilia12MesesRenda de benefícios da família em 12 mesesrendaBeneficiosFamilia3AnosRenda de benefícios da família em 3 anosrendaBeneficiosFamilia5AnosRenda de benefícios da família em 5 anosrendaBeneficiosPorPessoaUltimoMesRenda de benefícios por pessoa no último mêsrendaBeneficiosPorPessoa3MesesRenda de benefícios por pessoa em 3 mesesrendaBeneficiosPorPessoa6MesesRenda de benefícios por pessoa em 6 mesesrendaBeneficiosPorPessoa12MesesRenda de benefícios por pessoa em 12 mesesrendaBeneficiosPorPessoa3AnosRenda de benefícios por pessoa em 3 anosrendaBeneficiosPorPessoa5AnosRenda de benefícios por pessoa em 5 anosrendaMediaFamiliaFaixaRenda média da família (faixa)pesoBeneficiosRendaPeso dos benefícios na renda
detalhe.itens, um por registro
familiaresQueJaReceberamFamiliares que já receberamfamiliaresQueRecebemHojeFamiliares que recebem hojetotalRecebidoTotal recebidomaiorTotalRecebidoPorUmFamiliarMaior total recebido por um familiarmenorTotalRecebidoPorUmFamiliarMenor total recebido por um familiartotalMedioPorFamiliarTotal médio por familiarmenosParcelasRecebidasPorUmFamiliarMenos parcelas recebidas por um familiarmaisParcelasRecebidasPorUmFamiliarMais parcelas recebidas por um familiarparcelasPorFamiliarMediaParcelas por familiar (média)parcelasRecebidasParcelas recebidasparcelasReceberParcelas a receberparcelasTotalParcelas no totalprimeiroInicioPrimeiro inícioultimoFimÚ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.