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

# Detalhes da classificação de risco

> API de detalhes de uma determinada  de risco



## OpenAPI

````yaml GET /v1/holder/{holderId}/organization/{organizationId}/consumeunique/{userPlanConsumeUniqueId}/analytics/{userPlanConsumeAnalyticsId}/detail?size={size}&typeRisk={typeRisk}
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}/consumeunique/{userPlanConsumeUniqueId}/analytics/{userPlanConsumeAnalyticsId}/detail?size={size}&typeRisk={typeRisk}:
    get:
      description: API de detalhes de uma determinada  de risco
      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
        - name: userPlanConsumeUniqueId
          in: path
          description: Identificador único do consumo
          required: true
          schema:
            type: integer
            format: int64
        - name: userPlanConsumeAnalyticsId
          in: path
          description: Identificador único da análise
          required: true
          schema:
            type: integer
            format: int64
        - name: size
          in: query
          description: Quantidade de itens na resposta
          required: false
          schema:
            type: integer
            format: int64
        - name: typeRisk
          in: query
          description: >-
            Classificação de risco: RISK_WORKER | RISK_EXECUTION | RISK_CRIMINAL
            | LITIGATION
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: Resposta com detalhes de uma análise por classificação de risco
          content:
            application/json:
              schema:
                type: object
                properties:
                  sucess:
                    type: boolean
                    description: Indica se a operação foi bem-sucedida
                  reason:
                    type: string
                    description: Motivo da resposta (caso haja algum erro ou mensagem)
                  register:
                    type: object
                    properties:
                      vltotalProcess:
                        type: string
                        description: Valor total dos processos
                      vltotalProcess_RISK_WORKER:
                        type: string
                        description: Valor total dos processos com risco para o trabalhador
                      totalProcess:
                        type: integer
                        description: Quantidade total de processos
                      vltotalProcess_ISDEFENDANT_WITH_RISK:
                        type: string
                        description: Valor total dos processos com réu e risco
                      vltotalProcess_ISAUTHOR:
                        type: string
                        description: Valor total dos processos com autor
                      vltotalProcess_ISAUTHOR_WITH_RISK:
                        type: string
                        description: Valor total dos processos com autor e risco
                      vltotalProcess_RISK_WORKER_SECUNDARY:
                        type: string
                        description: >-
                          Valor total dos processos com risco secundário para o
                          trabalhador
                      vltotalProcess_ISDEFENDANT:
                        type: string
                        description: Valor total dos processos com réu
                      totalProcess_RISK_WORKER:
                        type: integer
                        description: Quantidade de processos com risco para o trabalhador
                      totalProcess_ISAUTHOR_WITH_RISK:
                        type: integer
                        description: Quantidade de processos com autor e risco
                      docs:
                        type: array
                        items:
                          type: object
                          properties:
                            process:
                              type: string
                              description: Número do processo
                            user_plan_consume_analytics_id:
                              type: integer
                              description: ID do plano de consumo do usuário
                            partner_process_analytics_id:
                              type: string
                              description: ID de análise do processo do parceiro
                            distribution_date:
                              type: string
                              format: date-time
                              description: Data de distribuição do processo
                            year_distribution_date:
                              type: string
                              description: Ano da distribuição
                            month_distribution_date:
                              type: string
                              description: Mês e ano da distribuição
                            process_is_author:
                              type: boolean
                              description: Indica se o processo é de autor
                            process_is_defendant:
                              type: boolean
                              description: Indica se o processo é de réu
                            process_is_relevant_disputes:
                              type: boolean
                              description: >-
                                Indica se o processo está relacionado a disputas
                                relevantes
                            priority:
                              type: integer
                              description: Prioridade do processo
                            status_custom:
                              type: string
                              description: Status personalizado do processo
                            status_partner:
                              type: string
                              description: Status do parceiro
                            court:
                              type: string
                              description: Tribunal responsável pelo julgamento
                            type_court:
                              type: string
                              description: Tipo de tribunal
                            judging_organ:
                              type: string
                              description: Órgão julgador do processo
                            instance:
                              type: string
                              description: Instância do processo
                            value_claim:
                              type: number
                              format: float
                              description: Valor da causa
                            type_risk:
                              type: array
                              items:
                                type: string
                                description: Tipo de risco relacionado ao processo
                            content:
                              type: object
                              properties:
                                classe:
                                  type: string
                                  description: Classe do processo
                                instance:
                                  type: string
                                  description: Instância do processo
                                reus:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      documento:
                                        type: string
                                        description: Documento do réu
                                      nome:
                                        type: string
                                        description: Nome do réu
                                valorDaCausa:
                                  type: string
                                  description: Valor da causa
                                autores:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      documento:
                                        type: string
                                        description: Documento do autor
                                      nome:
                                        type: string
                                        description: Nome do autor
                                court:
                                  type: string
                                  description: Tribunal responsável
                                tribunalPassordId:
                                  type: integer
                                  description: ID do tribunal
                                assunto:
                                  type: string
                                  description: Assunto relacionado ao processo
                                uf:
                                  type: string
                                  description: Unidade federativa
                                ref:
                                  type: string
                                  description: Referência do processo
                                dataDistribuicao:
                                  type: string
                                  format: date
                                  description: Data de distribuição do processo
                                typeCourt:
                                  type: string
                                  description: Tipo de tribunal
                                autoProc:
                                  type: integer
                                  description: Autuação do processo
                                orgaoJulgador:
                                  type: string
                                  description: Órgão julgador do processo
                                status:
                                  type: string
                                  description: Status do processo
                            archived:
                              type: boolean
                              description: Indica se o processo foi arquivado
                      totalProcess_RISK_WORKER_SECUNDARY:
                        type: integer
                        description: >-
                          Quantidade de processos com risco secundário para o
                          trabalhador
                      totalProcess_ISAUTHOR:
                        type: integer
                        description: Quantidade de processos de autor
                      totalProcess_ISDEFENDANT:
                        type: integer
                        description: Quantidade de processos de réu
                      totalProcess_ISDEFENDANT_WITH_RISK:
                        type: integer
                        description: Quantidade de processos de réu com risco
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````