> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nlbs.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Benefícios sociais

> Benefícios sociais federais recebidos, resumidos por programa.

Benefícios sociais federais recebidos pelo documento, resumidos por programa. Cada item traz o programa, a data do primeiro e do último pagamento, a quantidade de pagamentos, o total pago em reais e o último ano de orçamento; o histórico de pagamentos não vem. Só existe para CPF: com CNPJ responde `422` (`beneficios_exige_cpf`). Envie `"datasets": ["beneficios"]`; a chave precisa do escopo `dados:beneficios`.


## OpenAPI

````yaml dados/ref/beneficios.openapi.yaml POST /dados/consultar
openapi: 3.1.0
info:
  description: API de dados por documento (CPF/CNPJ).
  title: NL Labs API de Dados
  version: 0.1.0
servers:
  - url: https://api.nlbs.ai
security: []
paths:
  /dados/consultar:
    post:
      tags:
        - dados
      summary: Consultar Benefícios sociais
      operationId: consultar_dados_consultar_post
      parameters:
        - description: >-
            Opcional. Mesma chave em 24 h a partir da primeira chamada devolve a
            mesma resposta, sem repetir a leitura.
          in: header
          name: Idempotency-Key
          required: false
          schema:
            anyOf:
              - maxLength: 255
                minLength: 1
                pattern: ^[A-Za-z0-9._\-]+$
                type: string
              - type: 'null'
            description: >-
              Opcional. Mesma chave em 24 h a partir da primeira chamada devolve
              a mesma resposta, sem repetir a leitura.
            title: Idempotency-Key
      requestBody:
        content:
          application/json:
            example:
              datasets:
                - beneficios
              documento: '52998224725'
            schema:
              $ref: '#/components/schemas/ConsultaRequisicao'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                com_dados:
                  summary: Com dados
                  value:
                    consultado_em: '2026-01-15T12:00:00Z'
                    datasets:
                      beneficios:
                        encontrado: true
                        itens:
                          - first_payment_date: '2023-03-18'
                            last_budget_year: 2026
                            last_payment_date: '2026-04-17'
                            payment_count: 38
                            program_code: bolsa_familia
                            program_name: Bolsa Família
                            total_amount: '22800.00'
                    documento: '52998224725'
                    encontrado: true
                    tipo: cpf
                sem_dados:
                  summary: Sem dados
                  value:
                    consultado_em: '2026-01-15T12:00:00Z'
                    datasets:
                      beneficios:
                        encontrado: false
                        itens: []
                    documento: '52998224725'
                    encontrado: false
                    tipo: cpf
              schema:
                $ref: '#/components/schemas/ConsultaResposta'
          description: Um bloco por dataset pedido.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErroResposta'
          description: Chave invalida
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErroResposta'
          description: Escopo insuficiente ou sem acesso
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErroResposta'
          description: Entrada invalida, ubo com CPF ou identidade com CNPJ
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErroResposta'
          description: Cota esgotada
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErroResposta'
          description: Indisponivel
      security:
        - APIKeyHeader: []
components:
  schemas:
    ConsultaRequisicao:
      additionalProperties: false
      properties:
        datasets:
          default:
            - beneficios
          description: Sempre ["beneficios"] nesta página.
          items:
            enum:
              - beneficios
            type: string
          maxItems: 1
          minItems: 1
          title: Datasets
          type: array
        documento:
          description: CPF ou CNPJ, com ou sem pontuacao.
          title: Documento
          type: string
      required:
        - documento
        - datasets
      title: ConsultaRequisicao
      type: object
    ConsultaResposta:
      properties:
        consultado_em:
          description: Instante da consulta, ISO 8601 em UTC (sufixo Z).
          examples:
            - '2026-01-15T12:00:00Z'
          format: date-time
          title: Consultado Em
          type: string
        datasets:
          properties:
            beneficios:
              $ref: '#/components/schemas/DatasetBeneficios'
          required:
            - beneficios
          title: Datasets
          type: object
        documento:
          title: Documento
          type: string
        encontrado:
          title: Encontrado
          type: boolean
        tipo:
          enum:
            - cpf
            - cnpj
          title: Tipo
          type: string
      required:
        - documento
        - tipo
        - encontrado
        - consultado_em
        - datasets
      title: ConsultaResposta
      type: object
    ErroResposta:
      properties:
        erro:
          $ref: '#/components/schemas/ErroDetalhe'
      required:
        - erro
      title: ErroResposta
      type: object
    DatasetBeneficios:
      properties:
        encontrado:
          title: Encontrado
          type: boolean
        itens:
          description: >-
            Um item por programa de beneficio social federal. Vazio quando nao
            ha beneficio.
          items:
            $ref: '#/components/schemas/ItemBeneficio'
          title: Itens
          type: array
      required:
        - encontrado
        - itens
      title: DatasetBeneficios
      type: object
    ErroDetalhe:
      properties:
        codigo:
          title: Codigo
          type: string
        mensagem:
          title: Mensagem
          type: string
      required:
        - codigo
        - mensagem
      title: ErroDetalhe
      type: object
    ItemBeneficio:
      properties:
        first_payment_date:
          anyOf:
            - format: date
              type: string
            - type: 'null'
          description: Primeiro pagamento (AAAA-MM-DD).
          title: First Payment Date
        last_budget_year:
          anyOf:
            - type: integer
            - type: 'null'
          description: Maior ano de orcamento dos pagamentos.
          title: Last Budget Year
        last_payment_date:
          anyOf:
            - format: date
              type: string
            - type: 'null'
          description: Ultimo pagamento (AAAA-MM-DD).
          title: Last Payment Date
        payment_count:
          minimum: 0
          title: Payment Count
          type: integer
        program_code:
          description: 'Codigo do programa (ex.: bolsa_familia, pe_de_meia).'
          title: Program Code
          type: string
        program_name:
          title: Program Name
          type: string
        total_amount:
          description: Soma dos pagamentos em BRL, texto decimal.
          title: Total Amount
          type: string
      required:
        - program_code
        - program_name
        - first_payment_date
        - last_payment_date
        - payment_count
        - total_amount
        - last_budget_year
      title: ItemBeneficio
      type: object
  securitySchemes:
    APIKeyHeader:
      in: header
      name: X-API-Key
      type: apiKey

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.