Benefícios e programas gov

Programas de Benefícios e Assistência Social

O serviço de Programas de Benefícios e Assistência Social retorna dados sobre benefícios sociais recebidos por indivíduos, como bolsa-família e auxílio emergencial.

Falar com o comercial Ver o catálogo

Quando usar

Descrição

O serviço de Programas de Benefícios e Assistência Social fornece dados sobre diferentes programas de benefícios entregues pelos governos aos cidadãos, permitindo a identificação de pessoas que recebem ou receberam benefícios como o bolsa-família, seguro-defeso, auxílio emergencial (COVID), entre outros.

Além dos dados resumidos, são apresentadas também informações detalhadas de cada um dos benefícios identificados para o indivíduo, mesmo que não estejam mais válidos, permitindo assim uma visão histórica dos dados.

Requisição

Autenticação por chave de API (cabeçalho Authorization: Bearer), criada no painel com esta consulta no escopo.

POST /api/v1/{tenant}/pessoas/programas-de-beneficios-e-assistencia-social

Campo	Obrigatório	Descrição
`document`	sim	CPF da pessoa, com ou sem máscara.

{
  "document": "000.000.000-00"
}

Campos de retorno

Campos dentro de data. [] indica lista.

Campo	Tipo
`SocialAssistances[].ProgramName`	texto
`SocialAssistances[].ProgramCountry`	texto
`SocialAssistances[].ProgramState`	texto
`SocialAssistances[].AssistanceStartDate`	data
`SocialAssistances[].AssistanceEndDate`	data
`SocialAssistances[].AssistanceAmount`	número
`SocialAssistances[].AssistanceTotalAmount`	número
`SocialAssistances[].TotalInstallments`	número
`SocialAssistances[].AssistanceDetails.County`	texto
`SocialAssistances[].AssistanceDetails.CountySIAFICode`	texto
`SocialAssistances[].AssistanceDetails.BenefitNumber`	texto
`SocialAssistances[].CreationDate`	data
`SocialAssistances[].LastUpdateDate`	data
`TotalAssistances`	número
`TotalActiveAssistances`	número
`TotalIncome`	número
`TotalAmountReceived`	número
`TotalInstallmentsReceived`	número
`IsReceivingAssistance`	booleano

Exemplo de resposta

Estrutura real da resposta, com valores fictícios.

{
  "execution_id": "00000000-0000-0000-0000-000000000000",
  "status": "success",
  "message": "Consulta realizada com sucesso",
  "query_name": "Programas de Benefícios e Assistência Social",
  "query_slug": "programas-de-beneficios-e-assistencia-social",
  "data": {
    "SocialAssistances": [
      {
        "ProgramName": "texto",
        "ProgramCountry": "texto",
        "ProgramState": "texto",
        "AssistanceStartDate": "2026-01-01",
        "AssistanceEndDate": "2026-01-01",
        "AssistanceAmount": 0,
        "AssistanceTotalAmount": 0,
        "TotalInstallments": 0,
        "AssistanceDetails": {
          "County": "texto",
          "CountySIAFICode": "texto",
          "BenefitNumber": "texto"
        },
        "CreationDate": "2026-01-01",
        "LastUpdateDate": "2026-01-01"
      }
    ],
    "TotalAssistances": 0,
    "TotalActiveAssistances": 0,
    "TotalIncome": 0,
    "TotalAmountReceived": 0,
    "TotalInstallmentsReceived": 0,
    "IsReceivingAssistance": false
  },
  "consulted_at": "2026-01-01T12:00:00Z",
  "query_cost": "0.100"
}

Cobrança e respostas

O valor é cobrado por consulta bem-sucedida.
200 — consulta processada (veja status no corpo da resposta)
401 — token ausente, inválido, inativo ou expirado
403 — serviço fora do escopo da chave, IP não autorizado ou limite de consumo excedido
422 — campo obrigatório ausente/inválido ou payload acima do limite do serviço
429 — limite de requisições por minuto da chave excedido
504 — tempo máximo de execução do serviço excedido