Skip to main content
GET
/
v1
/
holder
/
{holderId}
/
organization
/
{organizationId}
/
consumeunique
/
{userPlanConsumeUniqueId}
/
analytics
/
{userPlanConsumeAnalyticsId}
/
detail?size=
{size}
&typeRisk=
{typeRisk}
cURL
curl --request GET \
  --url 'https://search.tratum.com.br/v1/holder/{holderId}/organization/{organizationId}/consumeunique/{userPlanConsumeUniqueId}/analytics/{userPlanConsumeAnalyticsId}/detail?size={size}&typeRisk={typeRisk}' \
  --header 'Authorization: Bearer <token>'
{
  "sucess": true,
  "reason": "<string>",
  "register": {
    "vltotalProcess": "<string>",
    "vltotalProcess_RISK_WORKER": "<string>",
    "totalProcess": 123,
    "vltotalProcess_ISDEFENDANT_WITH_RISK": "<string>",
    "vltotalProcess_ISAUTHOR": "<string>",
    "vltotalProcess_ISAUTHOR_WITH_RISK": "<string>",
    "vltotalProcess_RISK_WORKER_SECUNDARY": "<string>",
    "vltotalProcess_ISDEFENDANT": "<string>",
    "totalProcess_RISK_WORKER": 123,
    "totalProcess_ISAUTHOR_WITH_RISK": 123,
    "docs": [
      {
        "process": "<string>",
        "user_plan_consume_analytics_id": 123,
        "partner_process_analytics_id": "<string>",
        "distribution_date": "2023-11-07T05:31:56Z",
        "year_distribution_date": "<string>",
        "month_distribution_date": "<string>",
        "process_is_author": true,
        "process_is_defendant": true,
        "process_is_relevant_disputes": true,
        "priority": 123,
        "status_custom": "<string>",
        "status_partner": "<string>",
        "court": "<string>",
        "type_court": "<string>",
        "judging_organ": "<string>",
        "instance": "<string>",
        "value_claim": 123,
        "type_risk": [
          "<string>"
        ],
        "content": {
          "classe": "<string>",
          "instance": "<string>",
          "reus": [
            {
              "documento": "<string>",
              "nome": "<string>"
            }
          ],
          "valorDaCausa": "<string>",
          "autores": [
            {
              "documento": "<string>",
              "nome": "<string>"
            }
          ],
          "court": "<string>",
          "tribunalPassordId": 123,
          "assunto": "<string>",
          "uf": "<string>",
          "ref": "<string>",
          "dataDistribuicao": "2023-12-25",
          "typeCourt": "<string>",
          "autoProc": 123,
          "orgaoJulgador": "<string>",
          "status": "<string>"
        },
        "archived": true
      }
    ],
    "totalProcess_RISK_WORKER_SECUNDARY": 123,
    "totalProcess_ISAUTHOR": 123,
    "totalProcess_ISDEFENDANT": 123,
    "totalProcess_ISDEFENDANT_WITH_RISK": 123
  }
}

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.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
holderId
integer<int64>
required

ID do parceiro

​
organizationId
integer<int64>
required

ID da organização

​
userPlanConsumeUniqueId
integer<int64>
required

Identificador único do consumo

​
userPlanConsumeAnalyticsId
integer<int64>
required

Identificador único da análise

Query Parameters

​
size
integer<int64>

Quantidade de itens na resposta

​
typeRisk
integer<int64>
required

Classificação de risco: RISK_WORKER | RISK_EXECUTION | RISK_CRIMINAL | LITIGATION

Response

200 - application/json

Resposta com detalhes de uma análise por classificação de risco

​
sucess
boolean

Indica se a operação foi bem-sucedida

​
reason
string

Motivo da resposta (caso haja algum erro ou mensagem)

​
register
object