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

# Gerar uma análise

> Api V2 para analisar os dados de execucao do CPF ou CNPJ



## OpenAPI

````yaml POST /v2/analytics
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:
    post:
      description: API para analisar dados associados a um documento específico.
      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
                planId:
                  description: ID do plano
                  type: integer
                documentType:
                  description: Tipo de documento CNPJ | CPF
                  type: string
                documentNumber:
                  description: Número do documento
                  type: string
        required: true
      responses:
        '200':
          description: Resultado da análise premium com protesto
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      documentInfo:
                        type: string
                        description: Nome associado ao documento
                      documentNumber:
                        type: string
                        description: 'Número do documento (ex: CPF)'
                      statusIndex:
                        type: string
                        description: 'Status da indexação (ex: INITIAL)'
                      statusProtest:
                        type: string
                        description: 'Status de protesto (ex: INITIAL)'
                      lastUserPlanConsumeAnalytics:
                        type: integer
                        description: ID do último consumo de plano analítico
                      statusReport:
                        type: string
                        description: 'Status do relatório (ex: INITIAL)'
                      typePlan:
                        type: string
                        description: 'Tipo do plano (ex: SEARCH_ANALYZER_PREMIUM_PROTEST)'
                      userPlanConsumeUniqueId:
                        type: integer
                        description: ID único de consumo do plano
                      createdAt:
                        type: string
                        format: date-time
                        description: Data de criação do registro
                      userPlanConsumeAnalyticsId:
                        type: integer
                        description: ID da análise
                      totalProcessesEstimated:
                        type: integer
                        description: Quantidade estimada de processos
                      status:
                        type: string
                        description: 'Status geral da operação (ex: INITIAL)'
                  status:
                    type: string
                    description: 'Status da resposta (ex: success)'
        '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

````