Programas disponíveis
| Programa | Descrição |
|---|---|
| Auxílio Brasil | Programa de transferência de renda (substituto do Bolsa Família) |
| Bolsa Família | Programa histórico de transferência de renda |
| Auxílio Emergencial | Pagamentos durante a pandemia (2020-2021) |
| BPC | Benefício de Prestação Continuada (idosos e deficientes) |
Resposta
| Campo | Tipo | Descrição |
|---|---|---|
cpf | string | CPF consultado (apenas dígitos) |
nome | string | Nome do beneficiário (Title Case). String vazia quando não resolvido |
total | integer | Total de benefícios encontrados (soma das quatro listas) |
auxilio_brasil | array | Parcelas do Auxílio Brasil |
auxilio_emergencial | array | Parcelas do Auxílio Emergencial |
bolsa_familia | array | Parcelas do Bolsa Família |
bpc | array | Parcelas do BPC |
Auxílio Brasil / Bolsa Família
Ambos compartilham o mesmo formato.| Campo | Tipo | Descrição |
|---|---|---|
nis_favorecido | string | NIS do favorecido |
mes_competencia | string | Mês de competência (YYYY-MM) |
mes_referencia | string | Mês de referência (YYYY-MM) |
uf | string | UF |
codigo_municipio | string | Código do município |
nome_municipio | string | Nome do município (Title Case) |
valor_parcela | number | null | Valor da parcela em R$ |
Auxílio Emergencial
| Campo | Tipo | Descrição |
|---|---|---|
nis_beneficiario | string | NIS do beneficiário |
nis_responsavel | string | NIS do responsável |
mes_disponibilizacao | string | Mês de disponibilização (YYYY-MM) |
uf | string | UF |
codigo_municipio | string | Código do município |
nome_municipio | string | Nome do município (Title Case) |
enquadramento | string | Enquadramento (EXTRACAD, CADÚNICO) |
parcela | string | Número da parcela (1, 2, 3…) |
observacao | string | null | Observações (null quando não há) |
valor_beneficio | number | null | Valor do benefício em R$ |
BPC (Benefício de Prestação Continuada)
| Campo | Tipo | Descrição |
|---|---|---|
nis_beneficiario | string | NIS do beneficiário |
mes_competencia | string | Mês de competência (YYYY-MM) |
mes_referencia | string | Mês de referência (YYYY-MM) |
uf | string | UF |
codigo_municipio | string | Código do município |
nome_municipio | string | Nome do município (Title Case) |
numero_beneficio | string | Número do benefício |
beneficio_judicial | string | Se foi concedido judicialmente (texto bruto, ex: "Não") |
valor_parcela | number | null | Valor da parcela em R$ |
Renúncias Fiscais (Pessoa Jurídica)
| Campo | Tipo | Descrição |
|---|---|---|
ano_calendario | string | Ano-base da renúncia |
cnpj | string | CNPJ da empresa beneficiária |
razao_social | string | Razão social |
nome_fantasia | string | Nome fantasia |
codigo_cnae | string | null | Código CNAE |
cnae | string | null | Descrição CNAE |
municipio | string | Município |
uf | string | null | UF |
tipo_renuncia | string | Tipo da renúncia |
beneficio_fiscal | string | Nome do benefício fiscal |
fundamento_legal | string | Base legal |
descricao | string | Descrição detalhada |
tributo | string | Tributo afetado (IRPJ, CSLL, PIS, COFINS) |
forma_tributacao | string | null | Regime de tributação |
valor_renuncia_fiscal | string | Valor em R$ |
Endpoints
| Rota | Descrição |
|---|---|
GET /beneficios/cpf/{cpf} | Benefícios sociais por CPF |
GET /beneficios/cnpj/{cnpj} | Renúncias fiscais por CNPJ |