Obter Análise de Risco

curl --request GET \
  --url https://api.verifica.ia.br/risk-analysis/contracts/{contractId}/analysis \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.verifica.ia.br/risk-analysis/contracts/{contractId}/analysis"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.verifica.ia.br/risk-analysis/contracts/{contractId}/analysis', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.verifica.ia.br/risk-analysis/contracts/{contractId}/analysis",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.verifica.ia.br/risk-analysis/contracts/{contractId}/analysis"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.verifica.ia.br/risk-analysis/contracts/{contractId}/analysis")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.verifica.ia.br/risk-analysis/contracts/{contractId}/analysis")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "_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
}

GET

risk-analysis

contracts

{contractId}

analysis

Obter Análise de Risco

curl --request GET \
  --url https://api.verifica.ia.br/risk-analysis/contracts/{contractId}/analysis \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.verifica.ia.br/risk-analysis/contracts/{contractId}/analysis"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.verifica.ia.br/risk-analysis/contracts/{contractId}/analysis', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.verifica.ia.br/risk-analysis/contracts/{contractId}/analysis",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.verifica.ia.br/risk-analysis/contracts/{contractId}/analysis"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.verifica.ia.br/risk-analysis/contracts/{contractId}/analysis")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.verifica.ia.br/risk-analysis/contracts/{contractId}/analysis")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "_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
}

Authorizations

Authorization

string

header

required

Token JWT obtido através do endpoint /auth/login.

Inclua o token no header: Authorization: Bearer SEU_TOKEN_JWT

Path Parameters

contractId

string<uuid>

required

ID do contrato

Response

Análise encontrada

_id

string

ID único da análise

contractId

string<uuid>

ID do contrato analisado

userId

string<uuid>

ID do usuário proprietário

overallRisk

enum<string>

Nível de risco

Available options:

LOW,

MEDIUM,

HIGH

riskScore

integer

Score geral de risco (0-100)

Required range: 0 <= x <= 100

summary

string

Resumo da análise

sections

object[]

Show child attributes

criticalIssues

object[]

Show child attributes

recommendations

object[]

Show child attributes

status

enum<string>

Status da análise

Available options:

pending,

in_progress,

completed,

failed

analyzedAt

object

Data e hora da análise

Show child attributes

modelVersion

string

Versão do modelo de IA utilizado

learningContext

string

Contexto de aprendizado (opcional)

createdAt

object

Data de criação

Show child attributes

updatedAt

object

Data de atualização

Show child attributes

__v

integer

Versão do documento (MongoDB)

Iniciar Análise de Risco Gerar API Keys

Health

Authentication

Contracts

Risk Analysis

API Keys

Obter Análise de Risco

Authorizations

Path Parameters

Response