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

# Consultar Quantidade de Processos

> Api para Consultar os processos de um CPF ou CNPJ



## OpenAPI

````yaml POST /v1/holder/{holderId}/organization/{organizationId}/partner/process
openapi: 3.1.0
info:
  title: Tratum API
  description: >-
    Esta documentação fornece as informações necessárias para integrar-se ao
    nosso ecosistema. Nossas APIs permite que os clientes enviem solicitações
    para analisar, consultar, monitorar dados associados a um documento
    específico.
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://search.tratum.com.br
security:
  - bearerAuth: []
paths:
  /v1/holder/{holderId}/organization/{organizationId}/partner/process:
    post:
      description: Api para consultar a quantidade de processos de um CPF ou CNPJ
      parameters:
        - name: holderId
          in: path
          description: ID do parceiro
          required: true
          schema:
            type: integer
            format: int64
        - name: organizationId
          in: path
          description: ID da organização
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        description: Corpo da requisição
        content:
          application/json:
            schema:
              type: object
              properties:
                documentType:
                  description: 'Tipo do documento, somente duas opções válidas: CPF | CNPJ'
                  type: string
                documentNumber:
                  description: Valor do documento CPF / CNPJ
                  type: string
        required: true
      responses:
        '200':
          description: Resultado do consumo de plano do usuário
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Indica se a operação foi bem-sucedida
                  reason:
                    type: string
                    description: Razão de falha ou código adicional
                  total:
                    type: integer
                    description: Total de registros encontrados
                  result:
                    type: array
                    items:
                      type: object
                      properties:
                        accessPauseMonitor:
                          type: boolean
                          description: Se o monitoramento pode ser pausado
                        documentInfo:
                          type: string
                          description: Nome ou descrição associada ao documento
                        dayPauseMonitor:
                          type: integer
                          description: Dias disponíveis para pausar monitoramento
                        documentType:
                          type: string
                          description: 'Tipo de documento (ex: CNPJ)'
                        documentNumber:
                          type: string
                          description: 'Número do documento (ex: CNPJ)'
                        consume:
                          type: integer
                          description: Quantidade consumida
                        typePlan:
                          type: string
                          description: 'Tipo de plano (ex: SEARCH_PROCESS)'
                        userPlanConsumeUniqueId:
                          type: integer
                          description: Identificador único do consumo
                        createdAt:
                          type: string
                          format: date-time
                          description: Data de criação
                        deletedAt:
                          type:
                            - string
                            - 'null'
                          format: date-time
                          description: Data de exclusão, se aplicável
                        planChangedAt:
                          type:
                            - string
                            - 'null'
                          format: date-time
                          description: Data de alteração de plano, se aplicável
                        dtAvailablePause:
                          type:
                            - string
                            - 'null'
                          format: date-time
                          description: Data disponível para pausar, se aplicável
                        typeSearch:
                          type: string
                          description: Tipo de busca
                        updatedAt:
                          type: string
                          format: date-time
                          description: Data de atualização
        '403':
          description: Não autorizado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorLogin'
components:
  schemas:
    ErrorLogin:
      required: []
      type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````