Monitoramento de Novas Ações

Criação do monitoramento

Payload da Solicitação

A solicitação POST deve incluir um payload com as seguintes propriedades:

search_type: Este campo define o tipo de entidade que será buscada. Os valores possíveis são: cpf, cnpj, oab, name, lawsuit_cnj ou lawsuit_id. Para buscas processuais, utilizaremos especificamente cpf, cnpj ou oab, que correspondem ao número do processo.

Obs: - O formato da OAB é sempre UF mais 7 digitos do numero da OAB, adicionar zeros a esquerda até atingir 7 dígitos.

Exemplo:

DF0012345

Caso a OAB tenha apenas 4 dígitos, adicionar mais um zero:

DF0001234

search_key: O número do processo (Código CNJ), CPF, CNPJ, OAB ou Name que você deseja buscar;
cache_ttl_in_days (opcional): Número inteiro que define até quantos dias o resultado da busca pode considerar um cache válido;
search_params: Um objeto que contém alguns parâmetros da busca como: - lawsuit_instance (opcional): Este parâmetro permite definir a instância em que deseja buscar o processo; - masked_response Define se a resposta virá minificada. Este parâmetro é aplicável apenas a consultas (simples ou completas) por documento no contexto de busca processual. - masked_response = true: retornará uma consulta completa - masked_response = false: retornará uma consulta simples

*Obs Consulte as condições comerciais desses diferentes tipos de consultas por documento.

Filtros poderão ser adicionados à requisição, permitindo um retorno mais assertivo com base nos valores desejados. Para isso, o parâmetro filter deve ser incluído dentro de search_params, com os seguintes filtros disponíveis:

filter (opcional): Um objeto que contém os filtros para a busca, como:
side (opcional): Permite buscar por tipos de participantes do processo, podendo ser: ‘Passive’, ‘Active’, ‘Interested’, ‘Unknown’;
amount_gte (opcional): Filtra processos com valor da causa maior ou igual ao especificado em amount_gte;
amount_lte (opcional): Filtra processos com valor da causa menor ou igual ao especificado em amount_lte;
tribunals (opcional): Um objeto que contém os filtros de tribunais:
- keys (opcional): Lista de códigos de tribunais disponíveis na lista de tribunais. Este filtro permite restringir a busca a processos que tenham ou não esses códigos específicos;
- not_equal (opcional): Valor booleano que define se o filtro incluirá ou excluirá os valores especificados em keys.
subject_codes (opcional): Um objeto que contém os filtros de assuntos:
- keys (opcional): Lista de códigos de assuntos. Este filtro permite restringir a busca a processos que tenham ou não esses códigos específicos;
- not_equal (opcional): Valor booleano que define se o filtro incluirá ou excluirá os valores especificados em keys.
classification_codes (opcional): Um objeto que contém os filtros de classes processuais:
- keys (opcional): Lista de códigos de classes processuais. Este filtro permite restringir a busca a processos que tenham ou não esses códigos específicos;
- not_equal (opcional): Valor booleano que define se o filtro incluirá ou excluirá os valores especificados em keys.
distribution_date_gte (opcional): Permite especificar uma data mínima de distribuição. Este filtro localiza processos distribuídos após a data informada.
credential (opcional): Objeto para o uso do cofre de credenciais:
customer_key (opcional): Permite passar a chave do usuário cadastrada no cofre de credenciais. Caso não seja informada, a API tentará encontrar uma credencial cadastrada para uma customer_key vazia.

curl --request POST
--url "https://tracking.prod.judit.io/tracking"
--header "api_key: SUA-API-KEY"
--header "Content-Type: application/json"
--data "{
  'recurrence': 1,
  'search': {
   'search_type': 'cpf',
   'search_key': '999.999.999-99'
  }
}"

Todas os monitoramentos de novas ações processuais cadastradas são realizadas on-demand. Recomendamos verificar as condições de custo associadas a este serviço antes de sua utilização.

Retorno:

{
"tracking_id": "15d632c6-a2ab-40c1-bfc5-d8f7bf8d8dd9",
"user_id": "82082593-c664-4d7b-b174-2f0dc4791daf",
"status": "created",
"recurrence": 1,
"search": {
  "search_type": "cpf",
  "search_key": "092.065.297-22",
  "response_type": "lawsuits",
  "search_params": {
    "filter": {},
    "pagination": {}
  }
},
"tracked_items_count": 0,
"tracked_items_steps_count": 0,
"tags": {},
"created_at": "2024-02-21T18:26:38.499Z",
"updated_at": "2024-02-21T18:26:38.499Z"
}

O monitoramento irá ser iniciado a primeira vez, na melhor janela de concorrência de requisição ao tribunal, dentro das próximas 5 horas da data de criação.

Depois ocorrerá de acordo com a frequeência cadastrada no campo recurrence.

Consultar o status do monitoramento

Na URL vai o tracking_id retornado na primeira requisição:

curl --request GET
--url "https://tracking.prod.judit.io/tracking/15d632c6-a2ab-40c1-bfc5-d8f7bf8d8dd9"
--header "api_key: SUA-API-KEY"
--header "Content-Type: application/json"

Retorno:

{
  "tracking_id": "15d632c6-a2ab-40c1-bfc5-d8f7bf8d8dd9",
  "user_id": "82082593-c664-4d7b-b174-2f0dc4791daf",
  "status": "created",
  "recurrence": 1,
  "search": {
    "search_type": "cpf",
    "search_key": "092.065.297-22",
    "response_type": "lawsuits",
    "search_params": {
      "filter": {},
      "pagination": {}
    }
  },
  "tracked_items_count": 0,
  "tracked_items_steps_count": 0,
  "tags": {
    "dashboard_id": null
  },
  "request_id": "05ee9825-b2b4-480b-b29e-f071ca7d9c72",
  "created_at": "2024-02-21T18:26:38.499Z",
  "updated_at": "2024-02-21T18:26:38.499Z"
}

A propriedade status informa a situação atual do monitoramento, podendo ser:

created: Monitoramento criado, porém nunca executado.
updating: Está com uma requisição em processamento.
updated: Monitoramento atualizado já com alguma resposta disponível. O campo updated_at pode informar a data de última atualização do monitoramento e a propriedade request_id o id da última request feita pelo monitoramento.
paused: Monitoramento pausado, podendo ainda ser reativado.
deleted: Monitoramento cancelado e não pode mais ser reativado.

A propriedade request_id só é criada a partir da primeira vez que o monitoramento executou, ou seja, chegou ao status updated.

Consultar o conteúdo da resposta (nova ação encontrada)

Na URL vai o request_id retornado na primeira requisição:

curl --request GET
--url "https://requests.prod.judit.io/responses/?request_id=15d632c6-a2ab-40c1-bfc5-d8f7bf8d8dd9"
--header "api_key: SUA-API-KEY"
--header "Content-Type: application/json"

{
  "page": 1,
  "page_data": [
    {
      "request_id": "05ee9825-b2b4-480b-b29e-f071ca7d9c72",
      "response_id": "e49d2e2c-92ed-4dad-8701-c53a569d675b",
      "response_type": "lawsuit",
      "response_data": {
        "code": "0817064-37.2023.8.19.0209",
        "justice": "8",
        "tribunal": "19",
        "tribunal_acronym": "TJRJ",
        "secrecy_level": 0,
        "tags": {
          "is_fallback_source": true,
          "crawl_id": "bd5ca800-9351-4d6e-a238-4690face8a5e"
        },
        "instance": 1,
        "crawler": {
          "source_name": "JTJ - BR - Document / Lawsuit - Auth",
          "crawl_id": "bd5ca800-9351-4d6e-a238-4690face8a5e",
          "weight": 10,
          "updated_at": "2024-02-21T17:33:24.063Z"
        },
        "classifications": [
          {
            "code": "436",
            "name": "PROCEDIMENTO DO JUIZADO ESPECIAL CÍVEL"
          }
        ],
        "subjects": [
          {
            "code": "7769",
            "name": "ABATIMENTO PROPORCIONAL DO PREÇO"
          },
          {
            "code": "7748",
            "name": "ACIDENTE AÉREO"
          },
          {
            "code": "10435",
            "name": "ACIDENTE DE TRÂNSITO"
          }
        ],
        "courts": [
          {
            "code": "13805",
            "name": "BARRA DA TIJUCA REGIONAL II JUI ESP CIV"
          }
        ],
        "amount": 28790,
        "parties": [
          {
            "name": "DAVID WILLIAM CONCEICAO DE OLIVEIRA",
            "side": "Active",
            "person_type": "Autor",
            "document": "14224726718",
            "document_type": "CPF",
            "lawyers": []
          },
          {
            "name": "GABRIELLA OLIVEIRA DA MATA",
            "side": "Active",
            "person_type": "Autor",
            "document": "16663398733",
            "document_type": "CPF",
            "lawyers": []
          },
          {
            "name": "JULIANA OLIVEIRA CARVALHO",
            "side": "Active",
            "person_type": "Autor",
            "document": "18250433700",
            "document_type": "CPF",
            "lawyers": []
          },
          {
            "name": "LEONARDO MENDES LIMA",
            "side": "Active",
            "person_type": "Autor",
            "document": "14904631781",
            "document_type": "CPF",
            "lawyers": []
          },
          {
            "name": "LEONARDO OLIVEIRA DE LIMA",
            "side": "Active",
            "person_type": "Autor",
            "document": "13726926739",
            "document_type": "CPF",
            "lawyers": []
          },
          {
            "name": "LIVIA BEATRIZ LIMA DA COSTA DA SILVA",
            "side": "Active",
            "person_type": "Autor",
            "document": "13482560790",
            "document_type": "CPF",
            "lawyers": []
          },
          {
            "name": "LUCAS OLIVEIRA DE LIMA",
            "side": "Active",
            "person_type": "Autor",
            "document": "13726925767",
            "document_type": "CPF",
            "lawyers": []
          },
          {
            "name": "MARCO ANTONIO DE OLIVEIRA RODRIGUES",
            "side": "Active",
            "person_type": "Autor",
            "document": "09206529722",
            "document_type": "CPF",
            "lawyers": []
          },
          {
            "name": "MARIA DE FATIMA GABRIELA PIVA",
            "side": "Active",
            "person_type": "Autor",
            "document": "50559689829",
            "document_type": "CPF",
            "lawyers": []
          },
          {
            "name": "SUELEN CLARINDO DOS SANTOS",
            "side": "Active",
            "person_type": "Autor",
            "document": "13565811706",
            "document_type": "CPF",
            "lawyers": []
          },
          {
            "name": "GRUPO HURB VIAGENS E TURISMO S/A",
            "side": "Passive",
            "person_type": "Réu",
            "lawyers": []
          },
          {
            "name": "HOTEL URBANO VIAGENS E TURISMO S.A.",
            "side": "Passive",
            "person_type": "Réu",
            "lawyers": []
          },
          {
            "name": "HURB TECHNOLIGIES S.A.",
            "side": "Passive",
            "person_type": "Réu",
            "lawyers": []
          },
          {
            "name": "HURB TECHNOLOGIES S.A.",
            "side": "Passive",
            "person_type": "Réu",
            "lawyers": []
          }
        ],
        "attachments": [],
        "steps": [],
        "related_lawsuits": [],
        "last_step": {
          "lawsuit_cnj": "0817064-37.2023.8.19.0209",
          "lawsuit_instance": 1,
          "step_id": "nU9IcVb9NLoHrJeUXt+Hay139dqHAVbfxk7f0D77aRQ=",
          "step_date": "2024-02-21T17:33:24.064Z",
          "private": false,
          "steps_count": 1
        },
        "name": "DAVID WILLIAM CONCEICAO DE OLIVEIRA X GRUPO HURB VIAGENS E TURISMO S/A",
        "distribution_date": "2023-06-06T17:35:50.000Z",
        "phase": "Inicial",
        "status": "Ativo"
      },
      "user_id": "82082593-c664-4d7b-b174-2f0dc4791daf",
      "created_at": "2024-02-21T17:33:24.490Z",
      "request_status": "completed",
      "tags": {


"dashboard_id": null
      }
    },
    {
      "request_id": "05ee9825-b2b4-480b-b29e-f071ca7d9c72",
      "response_id": "66da2fca-6f5d-4664-9e46-0d34f80746c2",
      "response_type": "lawsuit",
      "response_data": {
        "code": "0100248-39.2022.5.01.0037",
        "justice": "5",
        "tribunal": "01",
        "tribunal_acronym": "TRT1",
        "secrecy_level": 0,
        "tags": {
          "is_fallback_source": true,
          "crawl_id": "bd5ca800-9351-4d6e-a238-4690face8a5e"
        },
        "instance": 1,
        "crawler": {
          "source_name": "JTJ - BR - Document / Lawsuit - Auth",
          "crawl_id": "bd5ca800-9351-4d6e-a238-4690face8a5e",
          "weight": 10,
          "updated_at": "2024-02-21T17:33:24.063Z"
        },
        "classifications": [
          {
            "code": "985",
            "name": "AÇÃO TRABALHISTA - RITO ORDINÁRIO"
          }
        ],
        "subjects": [
          {
            "code": "13656",
            "name": "DOMÉSTICOS"
          }
        ],
        "courts": [
          {
            "code": "33782",
            "name": "RIO DE JANEIRO - 37ª VARA DO TRABALHO"
          }
        ],
        "amount": 7685.82,
        "parties": [
          {
            "name": "VIVIANE DA SILVA SALOMAO",
            "side": "Active",
            "person_type": "Autor",
            "document": "05705252765",
            "document_type": "CPF",
            "lawyers": [
              {
                "name": "EDUARDO BIOSCA LIMA DE OLIVEIRA",
                "side": "Active",
                "person_type": "Advogado"
              }
            ]
          },
          {
            "name": "MARCO ANTONIO DE OLIVEIRA RODRIGUES",
            "side": "Passive",
            "person_type": "Réu",
            "document": "09206529722",
            "document_type": "CPF",
            "lawyers": [
              {
                "name": "PAULA GUERRA DA CRUZ",
                "side": "Passive",
                "person_type": "Advogado"
              }
            ]
          },
          {
            "person_type": "Advogado",
            "side": "Active",
            "name": "EDUARDO BIOSCA LIMA DE OLIVEIRA"
          },
          {
            "person_type": "Advogado",
            "side": "Passive",
            "name": "PAULA GUERRA DA CRUZ"
          }
        ],
        "attachments": [],
        "steps": [],
        "related_lawsuits": [],
        "last_step": {
          "lawsuit_cnj": "0100248-39.2022.5.01.0037",
          "lawsuit_instance": 1,
          "step_id": "u2r/3iZieAWrkFjxBZC/r4bMlFAvRO1IWvaOD8xdGl8=",
          "step_date": "2024-02-21T17:33:24.063Z",
          "private": false,
          "steps_count": 1
        },
        "name": "VIVIANE DA SILVA SALOMAO X MARCO ANTONIO DE OLIVEIRA RODRIGUES",
        "distribution_date": "2022-03-30T16:41:24.000Z",
        "phase": "Inicial",
        "status": "Ativo"
      },
      "user_id": "82082593-c664-4d7b-b174-2f0dc4791daf",
      "created_at": "2024-02-21T17:33:24.490Z",
      "request_status": "completed",
      "tags": {
        "dashboard_id": null
      }
    },
    {
      "request_id": "05ee9825-b2b4-480b-b29e-f071ca7d9c72",
      "response_id": "5f83741e-97f4-4c3b-84fb-6c49e4cfe494",
      "response_type": "lawsuit",
      "response_data": {
        "code": "0824046-82.2023.8.19.0204",
        "justice": "8",
        "tribunal": "19",
        "tribunal_acronym": "TJRJ",
        "secrecy_level": 0,
        "tags": {
          "is_fallback_source": true,
          "crawl_id": "bd5ca800-9351-4d6e-a238-4690face8a5e"
        },
        "instance": 1,
        "crawler": {
          "source_name": "JTJ - BR - Document / Lawsuit - Auth",
          "crawl_id": "bd5ca800-9351-4d6e-a238-4690face8a5e",
          "weight": 10,
          "updated_at": "2024-02-21T17:33:24.063Z"
        },
        "classifications": [
          {
            "code": "436",
            "name": "PROCEDIMENTO DO JUIZADO ESPECIAL CÍVEL"
          }
        ],
        "subjects": [
          {
            "code": "7780",
            "name": "INDENIZAÇÃO POR DANO MATERIAL"
          },
          {
            "code": "7779",
            "name": "INDENIZAÇÃO POR DANO MORAL"
          }
        ],
        "courts": [
          {
            "code": "7869",
            "name": "BANGU REGIONAL XVII JUI ESP CIV"
          }
        ],
        "amount": 46831,
        "parties": [
          {
            "name": "FERNANDO SILVA DE SOUZA",
            "side": "Active",
            "person_type": "Autor",
            "document": "72472723768",
            "document_type": "CPF",
            "lawyers": []
          },
          {
            "name": "MARCO ANTONIO DE OLIVEIRA RODRIGUES",
            "side": "Active",
            "person_type": "Autor",
            "document": "09206529722",
            "document_type": "CPF",
            "lawyers": []
          },
          {
            "name": "SUELEN CLARINDO DOS SANTOS",


            "side": "Active",
            "person_type": "Autor",
            "document": "13565811706",
            "document_type": "CPF",
            "lawyers": []
          },
          {
            "name": "SUELI DE BARROS CLARINDO",
            "side": "Active",
            "person_type": "Autor",
            "document": "02088098720",
            "document_type": "CPF",
            "lawyers": []
          },
          {
            "name": "GRUPO HURB VIAGENS E TURISMO S/A",
            "side": "Passive",
            "person_type": "Réu",
            "lawyers": []
          },
          {
            "name": "HOTEL URBANO VIAGENS E TURISMO S.A.",
            "side": "Passive",
            "person_type": "Réu",
            "lawyers": []
          },
          {
            "name": "HURB TECHNOLIGIES S.A.",
            "side": "Passive",
            "person_type": "Réu",
            "lawyers": []
          },
          {
            "name": "HURB TECHNOLOGIES S.A.",
            "side": "Passive",
            "person_type": "Réu",
            "lawyers": []
          }
        ],
        "attachments": [],
        "steps": [],
        "related_lawsuits": [],
        "last_step": {
          "lawsuit_cnj": "0824046-82.2023.8.19.0204",
          "lawsuit_instance": 1,
          "step_id": "YpIR5rAfSprFSseqRe9oVUPtkKcgQI0Na8RIv1djKZI=",
          "step_date": "2024-02-21T17:33:24.063Z",
          "private": false,
          "steps_count": 1
        },
        "name": "FERNANDO SILVA DE SOUZA X GRUPO HURB VIAGENS E TURISMO S/A",
        "phase": "Inicial",
        "status": "Ativo"
      },
      "user_id": "82082593-c664-4d7b-b174-2f0dc4791daf",
      "created_at": "2024-02-21T17:33:24.490Z",
      "request_status": "completed",
      "tags": {
        "dashboard_id": null
      }
    }
  ],
  "page_count": 3,
  "all_count": 3,
  "all_pages_count": 1
}

O parâmetro page e page_size são opcionais, porém necessários para percorrer as páginas com os processos, caso venham mais de uma, o que é comum no caso de consulta por documento.

page

integer

Define a página atual da busca.

page_count

integer

Total de processos na página.

all_count

integer

Total de processos encontrados

all_pages_count

integer

Quantidade de páginas de processos

page_data

array

Array com as respostas e dentro da propriedade response_data o conteúdo do processo.

No caso de monitoramento de documento, ele sempre será de novas ações, ou seja, as requisições só gerarão respostas caso um novo processo seja distribuído.

O significado de cada campo pode ser encontrado no glossário:

https://docs.judit.io/essentials/glossary

Pausando um Monitoramento

Para pausar um monitoramento, você pode fazer uma solicitação POST para a rota /tracking/{monitoramento}/pause, substituindo {monitoramento} pelo ID do monitoramento que você deseja pausar.

Aqui está um exemplo de como pausar o monitoramento usando o curl:

curl -X POST "https://tracking.prod.judit.io/tracking/15d632c6-a2ab-40c1-bfc5-d8f7bf8d8dd9/pause" \
-H "api-key: YOUR_API_KEY"

Aqui está um exemplo de retorno do monitoramento pausado:

{
"tracking_id": "15d632c6-a2ab-40c1-bfc5-d8f7bf8d8dd9",
"user_id": "82082593-c664-4d7b-b174-2f0dc4791daf",
"status": "paused",
"recurrence": 1,
"search": {
  "search_type": "cpf",
  "search_key": "999.999.999-99",
  "response_type": "lawsuits",
  "search_params": {
  "filter": {},
  "pagination": {}
  }
},
"tracked_items_count": 0,
"tracked_items_steps_count": 0,
"tags": {},
"created_at": "2024-02-21T18:26:38.499Z",
"updated_at": "2024-02-21T18:26:38.499Z"
}

Reativando um Monitoramento

Para reativar um monitoramento pausado, você pode fazer uma solicitação POST para a rota /tracking/{monitoramento}/resume, substituindo {monitoramento} pelo ID do monitoramento que você deseja reativar.

Aqui está um exemplo de como reativar um monitoramento usando curl:

curl -X POST "https://tracking.prod.judit.io/tracking/15d632c6-a2ab-40c1-bfc5-d8f7bf8d8dd9/resume" \
-H "api-key: YOUR_API_KEY"

Aqui está um exemplo de retorno do monitoramento ativo

{
"tracking_id": "15d632c6-a2ab-40c1-bfc5-d8f7bf8d8dd9",
"user_id": "82082593-c664-4d7b-b174-2f0dc4791daf",
"status": "updated",
"recurrence": 1,
"search": {
  "search_type": "cpf",
  "search_key": "999.999.999-99",
  "response_type": "lawsuits",
  "search_params": {
  "filter": {},
  "pagination": {}
  }
},
"tracked_items_count": 0,
"tracked_items_steps_count": 0,
"tags": {},
"created_at": "2024-02-21T18:26:38.499Z",
"updated_at": "2024-02-21T18:26:38.499Z"
}

Deletando um Monitoramento

Para deletar um monitoramento, você pode fazer uma solicitação DELETE para a rota /tracking/{monitoramento}, substituindo {monitoramento} pelo ID do monitoramento que você deseja deletar.

Aqui está um exemplo de como deletar um monitoramento usando curl:

curl -X DELETE "https://tracking.prod.judit.io/tracking/15d632c6-a2ab-40c1-bfc5-d8f7bf8d8dd9" \
-H "api-key: YOUR_API_KEY"

Aqui está um exemplo do retorno do monitoramento deletado:

{
"tracking_id": "15d632c6-a2ab-40c1-bfc5-d8f7bf8d8dd9",
"user_id": "82082593-c664-4d7b-b174-2f0dc4791daf",
"status": "deleted",
"recurrence": 1,
"search": {
  "search_type": "cpf",
  "search_key": "999.999.999-99",
  "response_type": "lawsuits",
  "search_params": {
  "filter": {},
  "pagination": {}
  }
},
"tracked_items_count": 0,
"tracked_items_steps_count": 0,
"tags": {},
"created_at": "2024-02-21T18:26:38.499Z",
"updated_at": "2024-02-21T18:26:38.499Z"
}

Comece a usar

Essenciais

Payload da Solicitação