> ## 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 uma análise

> Api para resumir o total por classificacao de risco do CPF ou CNPJ



## OpenAPI

````yaml POST /v2/analytics/{userPlanConsumeAnalyticsId}
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:
  /v2/analytics/{userPlanConsumeAnalyticsId}:
    post:
      description: API para resumir o total por classificação de risco do CPF ou CNPJ.
      parameters:
        - name: userPlanConsumeAnalyticsId
          in: path
          description: ID da análise
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        description: Corpo da requisição
        content:
          application/json:
            schema:
              type: object
              properties:
                holderId:
                  description: ID do parceiro
                  type: integer
                organizationId:
                  description: ID da organização
                  type: integer
                userPlanConsumeUniqueId:
                  description: ID da consulta - Gerado no endpoint /v2/analytics
                  type: integer
        required: true
      responses:
        '200':
          description: Resumo do relatório de análise premium com protesto
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  reason:
                    type: string
                    example: ''
                  register:
                    type: object
                    properties:
                      summary:
                        type: object
                        properties:
                          ALL:
                            type: object
                            properties:
                              vltotalProcess:
                                type:
                                  - string
                                  - number
                              totalProcess:
                                type: integer
                          ISDEFENDANT:
                            type: object
                            properties:
                              vltotalProcess:
                                type:
                                  - string
                                  - number
                              totalProcess:
                                type: integer
                          RISK_PROTEST:
                            type: object
                            properties:
                              vltotalProcess:
                                type:
                                  - string
                                  - number
                              totalProcess:
                                type: integer
                          EXECUTION_WITH_RISK:
                            type: object
                            properties:
                              vltotalProcess:
                                type:
                                  - string
                                  - number
                              totalProcess:
                                type: integer
                          IS_ACTIVE_WITHOUT_RISK:
                            type: object
                            properties:
                              vltotalProcess:
                                type:
                                  - string
                                  - number
                              totalProcess:
                                type: integer
                          PERSON_NOT_CLASSIFIED:
                            type: object
                            properties:
                              vltotalProcess:
                                type:
                                  - string
                                  - number
                              totalProcess:
                                type: integer
                          ISAUTHOR:
                            type: object
                            properties:
                              vltotalProcess:
                                type:
                                  - string
                                  - number
                              totalProcess:
                                type: integer
                          IS_INACTIVE_WITHOUT_RISK:
                            type: object
                            properties:
                              vltotalProcess:
                                type:
                                  - string
                                  - number
                              totalProcess:
                                type: integer
                          IS_INACTIVE_WITH_RISK:
                            type: object
                            properties:
                              vltotalProcess:
                                type:
                                  - string
                                  - number
                              totalProcess:
                                type: integer
                          RISK_WORKER:
                            type: object
                            properties:
                              vltotalProcess:
                                type:
                                  - string
                                  - number
                              totalProcess:
                                type: integer
                          ISDEFENDANT_WITH_RISK:
                            type: object
                            properties:
                              vltotalProcess:
                                type:
                                  - string
                                  - number
                              totalProcess:
                                type: integer
                          CRIMINAL_WITH_RISK:
                            type: object
                            properties:
                              vltotalProcess:
                                type:
                                  - string
                                  - number
                              totalProcess:
                                type: integer
                          RISK_DEBTOR:
                            type: object
                            properties:
                              vltotalProcess:
                                type:
                                  - string
                                  - number
                              totalProcess:
                                type: integer
                          PERSON_NOT_CLASSIFIED_WITH_RISK:
                            type: object
                            properties:
                              vltotalProcess:
                                type:
                                  - string
                                  - number
                              totalProcess:
                                type: integer
                          RISK_EXECUTION:
                            type: object
                            properties:
                              vltotalProcess:
                                type:
                                  - string
                                  - number
                              totalProcess:
                                type: integer
                          ISAUTHOR_WITH_RISK:
                            type: object
                            properties:
                              vltotalProcess:
                                type:
                                  - string
                                  - number
                              totalProcess:
                                type: integer
                          IS_ACTIVE_WITH_RISK:
                            type: object
                            properties:
                              vltotalProcess:
                                type:
                                  - string
                                  - number
                              totalProcess:
                                type: integer
                          WORKER_WITH_RISK:
                            type: object
                            properties:
                              vltotalProcess:
                                type:
                                  - string
                                  - number
                              totalProcess:
                                type: integer
                          RISK_CRIMINAL:
                            type: object
                            properties:
                              vltotalProcess:
                                type:
                                  - string
                                  - number
                              totalProcess:
                                type: integer
                          LITIGATION:
                            type: object
                            properties:
                              vltotalProcess:
                                type:
                                  - string
                                  - number
                              totalProcess:
                                type: integer
                      userPlanConsumeProtestSummaryId:
                        type: string
                        format: uuid
                        example: 594c6a7d-2a05-468a-a535-594c6a7d
                      bucketName:
                        type: string
                        example: bucket
                      statusIndex:
                        type: string
                        example: DONE
                      statusProtest:
                        type: string
                        example: INITIAL
                      filenameFull:
                        type: string
                        example: 30072024_180018_FULL_7658.xlsx
                      lastUserPlanConsumeAnalytics:
                        type: integer
                        example: 7642
                      statusReport:
                        type: string
                        example: DONE
                      typePlan:
                        type: string
                        example: SEARCH_ANALYZER_PREMIUM_PROTEST
                      urlTempFull:
                        type: string
                        format: uri
                        example: >-
                          https://s3.aws.com/bucket/xxx/ANALYTICS/xxx/30072024_180018_FULL_7658.xlsx
                      userPlanConsumeUniqueId:
                        type: integer
                        example: 1082
                      createdAt:
                        type: string
                        format: date-time
                        example: 30/07/2024 14:59:18
                      userPlanConsumeAnalyticsId:
                        type: integer
                        example: 7658
                      folder:
                        type: string
                        example: xxx/ANALYTICS/xxx/
                      urlTemp:
                        type: string
                        format: uri
                        example: >-
                          https://s3.aws.com/bucket/xxx/ANALYTICS/xxx/30072024_180018_7658.xlsx
                      importantTerms:
                        type: array
                        items:
                          type: string
                        example:
                          - ''
                      status:
                        type: string
                        example: DONE
        '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

````