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

# Obter Análise de Risco

> Retorna o resultado da análise de risco de um contrato.

O status da análise pode ser:
- **pending**: Análise aguardando processamento
- **in_progress**: Análise em andamento
- **completed**: Análise concluída com sucesso
- **failed**: Análise falhou




## OpenAPI

````yaml api-reference/openapi.yaml get /risk-analysis/contracts/{contractId}/analysis
openapi: 3.1.0
info:
  title: Verifica AI API
  description: >
    API para análise de contratos com inteligência artificial.


    ## Autenticação


    A API Verifica AI oferece autenticação via JWT (JSON Web Token) para acesso
    programático aos endpoints da API.


    ### Como obter o token:


    Faça login através do endpoint `/auth/login` com suas credenciais:


    ```bash

    curl -X POST https://api.verifica.ia.br/auth/login \
      -H "Content-Type: application/json" \
      -d '{
        "email": "usuario@example.com",
        "password": "senha123456"
      }'
    ```


    ### Header de autenticação:


    ```

    Authorization: Bearer SEU_TOKEN_JWT

    ```


    Para mais informações, consulte a [documentação completa de
    autenticação](/essentials/authentication).
  version: 1.0.0
  contact:
    name: Verifica AI Support
    email: support@verifica.ia.br
  license:
    name: Proprietary
servers:
  - url: https://api.verifica.ia.br
    description: Produção
  - url: http://localhost:3333
    description: Desenvolvimento
security: []
tags:
  - name: Health
    description: Endpoints de verificação de saúde da API
  - name: Authentication
    description: Autenticação JWT para acesso programático à API
  - name: Contracts
    description: Gestão de contratos
  - name: Risk Analysis
    description: Análise de risco de contratos
  - name: API Keys
    description: Gestão de API Keys
paths:
  /risk-analysis/contracts/{contractId}/analysis:
    get:
      tags:
        - Risk Analysis
      summary: Obter Análise de Risco
      description: |
        Retorna o resultado da análise de risco de um contrato.

        O status da análise pode ser:
        - **pending**: Análise aguardando processamento
        - **in_progress**: Análise em andamento
        - **completed**: Análise concluída com sucesso
        - **failed**: Análise falhou
      operationId: getContractAnalysis
      parameters:
        - name: contractId
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: ID do contrato
      responses:
        '200':
          description: Análise encontrada
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractAnalysis'
              examples:
                completed:
                  value:
                    _id: analysis-uuid
                    contractId: contract-uuid
                    userId: user-uuid
                    status: completed
                    overallRisk: MEDIUM
                    riskScore: 65
                    summary: >-
                      Este contrato apresenta riscos moderados em algumas
                      cláusulas específicas. Recomenda-se revisão cuidadosa das
                      seções de pagamento e rescisão.
                    sections:
                      - sectionId: payment
                        sectionTitle: Pagamento
                        riskLevel: MEDIUM
                        riskScore: 60
                        issues:
                          - type: FINANCIAL
                            severity: MEDIUM
                            description: Prazo de pagamento não especificado claramente
                        clauses:
                          - clauseId: clause-1
                            clauseTitle: Cláusula de Pagamento
                            riskLevel: MEDIUM
                            riskScore: 60
                            issues:
                              - type: FINANCIAL
                                severity: MEDIUM
                                description: Prazo de pagamento não especificado claramente
                            explanation: >-
                              A cláusula não define claramente o prazo para
                              pagamento
                    criticalIssues:
                      - issue:
                          type: LEGAL
                          severity: HIGH
                          description: Cláusula de rescisão unilateral pode ser abusiva
                        impact: Alto risco de perda financeira em caso de rescisão
                        urgency: IMMEDIATE
                    recommendations:
                      - priority: HIGH
                        category: Legal
                        description: Revisar cláusula de rescisão com advogado
                        actionItems:
                          - Negociar termos de rescisão mais equilibrados
                          - Adicionar cláusula de aviso prévio
                    analyzedAt:
                      $date: '2025-01-12T17:30:00.000Z'
                    modelVersion: 1.0.0
                    createdAt:
                      $date: '2025-01-12T16:58:20.130Z'
                    updatedAt:
                      $date: '2025-01-12T17:30:00.000Z'
                    __v: 0
                in_progress:
                  value:
                    _id: analysis-uuid
                    contractId: contract-uuid
                    userId: user-uuid
                    status: in_progress
                    overallRisk: LOW
                    riskScore: 0
                    summary: ''
                    sections: []
                    criticalIssues: []
                    recommendations: []
                    analyzedAt:
                      $date: '2025-01-12T16:58:20.130Z'
                    modelVersion: 1.0.0
                    createdAt:
                      $date: '2025-01-12T16:58:20.130Z'
                    updatedAt:
                      $date: '2025-01-12T16:58:20.130Z'
                    __v: 0
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          description: Análise não encontrada
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                message: Analysis not found for this contract
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - BearerAuth: []
components:
  schemas:
    ContractAnalysis:
      type: object
      properties:
        _id:
          type: string
          description: ID único da análise
        contractId:
          type: string
          format: uuid
          description: ID do contrato analisado
        userId:
          type: string
          format: uuid
          description: ID do usuário proprietário
        overallRisk:
          $ref: '#/components/schemas/RiskLevel'
        riskScore:
          type: integer
          minimum: 0
          maximum: 100
          description: Score geral de risco (0-100)
        summary:
          type: string
          description: Resumo da análise
        sections:
          type: array
          items:
            $ref: '#/components/schemas/Section'
        criticalIssues:
          type: array
          items:
            $ref: '#/components/schemas/CriticalIssue'
        recommendations:
          type: array
          items:
            $ref: '#/components/schemas/Recommendation'
        status:
          $ref: '#/components/schemas/AnalysisStatus'
        analyzedAt:
          type: object
          properties:
            $date:
              type: string
              format: date-time
          description: Data e hora da análise
        modelVersion:
          type: string
          description: Versão do modelo de IA utilizado
        learningContext:
          type: string
          description: Contexto de aprendizado (opcional)
        createdAt:
          type: object
          properties:
            $date:
              type: string
              format: date-time
          description: Data de criação
        updatedAt:
          type: object
          properties:
            $date:
              type: string
              format: date-time
          description: Data de atualização
        __v:
          type: integer
          description: Versão do documento (MongoDB)
    Error:
      type: object
      properties:
        message:
          type: string
          description: Mensagem de erro
        errors:
          type: array
          items:
            type: object
          description: Lista de erros de validação (opcional)
    RiskLevel:
      type: string
      enum:
        - LOW
        - MEDIUM
        - HIGH
      description: Nível de risco
    Section:
      type: object
      properties:
        sectionId:
          type: string
          description: ID da seção
        sectionTitle:
          type: string
          description: Título da seção
        riskLevel:
          $ref: '#/components/schemas/RiskLevel'
        riskScore:
          type: integer
          minimum: 0
          maximum: 100
          description: Score de risco da seção (0-100)
        issues:
          type: array
          items:
            $ref: '#/components/schemas/Issue'
        clauses:
          type: array
          items:
            $ref: '#/components/schemas/Clause'
    CriticalIssue:
      type: object
      properties:
        issue:
          $ref: '#/components/schemas/Issue'
        impact:
          type: string
          description: Impacto do problema crítico
        urgency:
          $ref: '#/components/schemas/RecommendationPriority'
    Recommendation:
      type: object
      properties:
        priority:
          $ref: '#/components/schemas/RecommendationPriority'
        category:
          $ref: '#/components/schemas/RecommendationCategory'
        description:
          type: string
          description: Descrição da recomendação
        actionItems:
          type: array
          items:
            type: string
          description: Lista de ações recomendadas
    AnalysisStatus:
      type: string
      enum:
        - pending
        - in_progress
        - completed
        - failed
      description: Status da análise
    Issue:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/IssueType'
        severity:
          $ref: '#/components/schemas/IssueSeverity'
        description:
          type: string
          description: Descrição do problema
        clauseReference:
          type: string
          description: Referência à cláusula (opcional)
        recommendation:
          type: string
          description: Recomendação relacionada (opcional)
    Clause:
      type: object
      properties:
        clauseId:
          type: string
          description: ID da cláusula
        clauseTitle:
          type: string
          description: Título da cláusula
        riskLevel:
          $ref: '#/components/schemas/RiskLevel'
        riskScore:
          type: integer
          minimum: 0
          maximum: 100
          description: Score de risco da cláusula (0-100)
        issues:
          type: array
          items:
            $ref: '#/components/schemas/Issue'
        explanation:
          type: string
          description: Explicação sobre o risco da cláusula
    RecommendationPriority:
      type: string
      enum:
        - LOW
        - MEDIUM
        - HIGH
        - IMMEDIATE
      description: Prioridade da recomendação
    RecommendationCategory:
      type: string
      enum:
        - Legal
        - Financeiro
        - Operacional
        - Compliance
      description: Categoria da recomendação
    IssueType:
      type: string
      enum:
        - LEGAL
        - FINANCIAL
        - OPERATIONAL
        - COMPLIANCE
      description: Tipo de problema identificado
    IssueSeverity:
      type: string
      enum:
        - LOW
        - MEDIUM
        - HIGH
      description: Severidade do problema
  responses:
    Unauthorized:
      description: Não autorizado - Token inválido ou ausente
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            missingToken:
              value:
                message: Authorization header is required
            expiredToken:
              value:
                message: Token expired
    InternalServerError:
      description: Erro interno do servidor
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            message: Internal server error
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: |
        Token JWT obtido através do endpoint `/auth/login`.

        Inclua o token no header: `Authorization: Bearer SEU_TOKEN_JWT`

````