Benefícios Sociais Recebidos pela Pessoa
Benefícios e programas sociais que a pessoa recebe ou já recebeu, como Bolsa Família e BPC. Mostra se recebe hoje, o valor atual e o total recebido, e, para cada benefício, valor da parcela, município e período. Consulta-se pelo CPF e usa dados do Portal da Transparência.
POST/v1/beneficios-sociais/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
recebeBeneficioSocialHojeRecebe benefício social hojebeneficiosBenefíciosbeneficiosAtivosBenefícios ativosrendaAtualBeneficiosRenda atual de benefíciostotalRecebidoTotal recebidoparcelasRecebidasParcelas recebidas
detalhe.itens, um por registro
numeroBeneficioNúmero do benefíciopaisProgramaPaís do programaufUFmunicipioMunicípiocodigoSiafiMunicipioCódigo SIAFI do municípioinicioIníciofimFimvalorParcelaValor da parcelatotalRecebidoTotal recebidoparcelasParcelas
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 de toda a família, use
beneficios-sociais-familiares.