> ## 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.

# Processos

> Processos judiciais, paginados por cursor.

Processos judiciais em que o documento é parte. Retorna uma página de processos com tribunal, classes, assuntos e partes, mais `total` e `proximo_cursor`. Para a próxima página, repita a chamada com `processos.cursor` igual ao `proximo_cursor`; `processos.limite` vai de 1 a 100. Os movimentos de um processo saem em `GET /dados/processos/{numero}`. A chave precisa do escopo `dados:processos`.


## OpenAPI

````yaml dados/ref/processos.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 Processos
      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:
                - processos
              documento: '52998224725'
              processos:
                limite: 25
            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:
                      processos:
                        encontrado: true
                        itens:
                          - assuntos:
                              - codigo: '7691'
                                nome: Obrigacoes
                            ativo: null
                            classes:
                              - codigo: '7'
                                nome: Procedimento Comum Civel
                            data_ajuizamento: '2024-03-10'
                            data_distribuicao: '2024-03-11'
                            moeda: BRL
                            numero: 0000000-00.2024.8.26.0000
                            papel: reu
                            papel_detalhe: null
                            partes:
                              - consultada: true
                                documento: null
                                nome: Fulano de Tal
                                papel: reu
                              - consultada: false
                                documento: null
                                nome: Beltrano de Tal
                                papel: autor
                            polaridade: null
                            principal: null
                            status: ativo
                            tipo: civel
                            titulo: null
                            tribunal:
                              cidade: Cidade
                              nome: Tribunal Exemplo
                              uf: SP
                            ultima_movimentacao: '2025-11-02'
                            valor: '10000.00'
                        proximo_cursor: null
                        total: 1
                    documento: '52998224725'
                    encontrado: true
                    tipo: cpf
                sem_dados:
                  summary: Sem dados
                  value:
                    consultado_em: '2026-01-15T12:00:00Z'
                    datasets:
                      processos:
                        encontrado: false
                        itens: []
                        proximo_cursor: null
                        total: 0
                    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:
            - processos
          description: Sempre ["processos"] nesta página.
          items:
            enum:
              - processos
            type: string
          maxItems: 1
          minItems: 1
          title: Datasets
          type: array
        documento:
          description: CPF ou CNPJ, com ou sem pontuacao.
          title: Documento
          type: string
        processos:
          anyOf:
            - $ref: '#/components/schemas/ParametrosProcessos'
            - type: 'null'
          description: Paginacao dos processos. Sem offset.
      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:
            processos:
              $ref: '#/components/schemas/DatasetProcessos'
          required:
            - processos
          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
    ParametrosProcessos:
      additionalProperties: false
      properties:
        cursor:
          anyOf:
            - maxLength: 512
              type: string
            - type: 'null'
          description: >-
            Cursor opaco e assinado da pagina anterior: use exatamente o
            proximo_cursor recebido.
          title: Cursor
        limite:
          default: 25
          description: Itens por pagina.
          maximum: 100
          minimum: 1
          title: Limite
          type: integer
      title: ParametrosProcessos
      type: object
    DatasetProcessos:
      properties:
        encontrado:
          title: Encontrado
          type: boolean
        itens:
          description: Uma pagina de processos.
          items:
            $ref: '#/components/schemas/ItemProcesso'
          title: Itens
          type: array
        proximo_cursor:
          anyOf:
            - type: string
            - type: 'null'
          description: Cursor da proxima pagina; null quando acabou.
          title: Proximo Cursor
        total:
          description: Total de processos do documento.
          minimum: 0
          title: Total
          type: integer
      required:
        - encontrado
        - itens
        - total
      title: DatasetProcessos
      type: object
    ErroDetalhe:
      properties:
        codigo:
          title: Codigo
          type: string
        mensagem:
          title: Mensagem
          type: string
      required:
        - codigo
        - mensagem
      title: ErroDetalhe
      type: object
    ItemProcesso:
      properties:
        assuntos:
          items:
            $ref: '#/components/schemas/AssuntoProcesso'
          title: Assuntos
          type: array
        ativo:
          anyOf:
            - type: boolean
            - type: 'null'
          description: Se o vinculo esta ativo.
          title: Ativo
        classes:
          items:
            $ref: '#/components/schemas/ClasseProcesso'
          title: Classes
          type: array
        data_ajuizamento:
          anyOf:
            - format: date
              type: string
            - type: 'null'
          title: Data Ajuizamento
        data_distribuicao:
          anyOf:
            - format: date
              type: string
            - type: 'null'
          title: Data Distribuicao
        moeda:
          anyOf:
            - type: string
            - type: 'null'
          title: Moeda
        numero:
          anyOf:
            - type: string
            - type: 'null'
          description: Numero CNJ.
          title: Numero
        papel:
          anyOf:
            - type: string
            - type: 'null'
          description: Papel do documento consultado no processo.
          title: Papel
        papel_detalhe:
          anyOf:
            - type: string
            - type: 'null'
          title: Papel Detalhe
        partes:
          items:
            $ref: '#/components/schemas/ParteConsulta'
          title: Partes
          type: array
        polaridade:
          anyOf:
            - type: string
            - type: 'null'
          title: Polaridade
        principal:
          anyOf:
            - type: boolean
            - type: 'null'
          description: Se o vinculo e o principal.
          title: Principal
        status:
          anyOf:
            - type: string
            - type: 'null'
          title: Status
        tipo:
          anyOf:
            - type: string
            - type: 'null'
          title: Tipo
        titulo:
          anyOf:
            - type: string
            - type: 'null'
          title: Titulo
        tribunal:
          $ref: '#/components/schemas/TribunalProcesso'
        ultima_movimentacao:
          anyOf:
            - format: date
              type: string
            - type: 'null'
          title: Ultima Movimentacao
        valor:
          anyOf:
            - type: string
            - type: 'null'
          description: Valor da causa como texto decimal.
          title: Valor
      required:
        - numero
        - tipo
        - titulo
        - status
        - data_ajuizamento
        - data_distribuicao
        - ultima_movimentacao
        - valor
        - moeda
        - tribunal
        - classes
        - assuntos
        - papel
        - papel_detalhe
        - principal
        - ativo
        - polaridade
        - partes
      title: ItemProcesso
      type: object
    AssuntoProcesso:
      properties:
        codigo:
          title: Codigo
          type: string
        nome:
          anyOf:
            - type: string
            - type: 'null'
          description: Nome do assunto na TPU do CNJ, quando conhecido.
          title: Nome
      required:
        - codigo
        - nome
      title: AssuntoProcesso
      type: object
    ClasseProcesso:
      properties:
        codigo:
          title: Codigo
          type: string
        nome:
          anyOf:
            - type: string
            - type: 'null'
          description: Nome da classe na TPU do CNJ, quando conhecido.
          title: Nome
      required:
        - codigo
        - nome
      title: ClasseProcesso
      type: object
    ParteConsulta:
      properties:
        consultada:
          description: True se a parte e o documento consultado.
          title: Consultada
          type: boolean
        documento:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            Documento da parte. Nulo quando nao esta disponivel (hoje o dataset
            de processos nao guarda o documento das partes); quando disponivel,
            vem completo para o documento consultado e mascarado para as demais
            partes.
          title: Documento
        nome:
          anyOf:
            - type: string
            - type: 'null'
          title: Nome
        papel:
          anyOf:
            - type: string
            - type: 'null'
          title: Papel
      required:
        - nome
        - documento
        - papel
        - consultada
      title: ParteConsulta
      type: object
    TribunalProcesso:
      properties:
        cidade:
          anyOf:
            - type: string
            - type: 'null'
          title: Cidade
        nome:
          anyOf:
            - type: string
            - type: 'null'
          title: Nome
        uf:
          anyOf:
            - type: string
            - type: 'null'
          title: Uf
      required:
        - nome
        - cidade
        - uf
      title: TribunalProcesso
      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.