Monitoramento

A JUDIT permite que você monitore processos, CPFs, CNPJs, OAB, mantendo-o atualizado sobre qualquer nova movimentação.

O monitoramento é a automatização das consultas processuais do item anterior.

Diariamente, nossa API busca em todos os tribunais do Brasil processos relacionados ao CPF, CNPJ, OAB ou Código(CNJ) que você está monitorando.

Rota de Monitoramento

Para começar a monitorar um processo, CPF, CNPJ, OAB ou Código(CNJ), você deve realizar uma solicitação POST para a rota /tracking.

Payload da Solicitação

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

recurrence: A recorrência em dias de atualização dos processos.
search: Objeto que vai para a busca.
- search_type: Esse campo define o tipo de entidade que você quer buscar. Pode ser “cpf”, “cnpj”, “oab”, “lawsuit_cnj”, name ou rji para um número de 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;
response_type (opcional): Esse campo define o tipo de retorno dos dados da busca podendo ser “lawsuit”,“parties”, “attachments”, “steps”, “lawsuits” ou warrant;
cache_ttl_in_days (opcional): Número inteiro que define até quantos dias o resultado da busca pode considerar um cache válido;
with_attachments (opcional): Esse campo define se você quer trazer anexos referente ao processo buscado podendo ser true ou false
- Obs: Os anexos só serão retornados caso o search_type for lawsuit_cnj.
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;
  
  *Obs: Caso o parâmetro lawsuit_instance não seja especificado, a busca retornará automaticamente a instância mais recente do processo. Por exemplo, se o processo estiver tramitando tanto na primeira quanto na segunda instância, a busca considerará a segunda instância, por ser a mais atualizada.
- 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.

Para buscas por documento onde o search_type seja “cpf”, “cnpj”, “oab” ou “name”.
filter (opcional): Um objeto que contém alguns filtros da busca como:
- side (opcional): Este parâmetro permite buscar por tipo de participantes do processo podendo ser ‘Passive’, ‘Active’, ‘Interested’, ‘Unknown’;
- amount_gte (opcional): Este parâmetro permite buscar por processos com valor da causa maior que o amount_gte;
- amount_lte (opcional): Este parâmetro permite buscar por processos com valor da causa menor que o amount_lte;
- tribunals (opcional): Um objeto que contém os filtro de tribunais;
  - keys (opcional): Este filtro é uma lista de códigos de tribunais inclusos na lista de tribunais. Você pode fornecer uma lista de códigos de tribunais para restringir a busca a processos que tenham ou não tenham esses códigos específicos;
  - not_equal (opcional): Um valor booleano que define se o filtro será para processos que contenham os valores em keys ou que não contenham os valores em keys
- subject_codes (opcional): Um objeto que contém os filtro de assuntos;
  - keys (opcional): Este filtro é uma lista de códigos assuntos. Você pode fornecer uma lista de códigos de assuntos para restringir a busca a processos que tenham ou não tenham esses códigos específicos;
  - not_equal (opcional): Um valor booleano que define se o filtro será para processos que contenham os valores em keys ou que não contenham os valores em keys
- classification_codes (opcional): Um objeto que contém os filtro de classes processuais;
  - keys (opcional): Este filtro é uma lista de códigos de classes processuais. Você pode fornecer uma lista de códigos de classes para restringir a busca a processos que tenham ou não tenham esses códigos específicos;
  - not_equal (opcional): Um valor booleano que define se o filtro será para processos que contenham os valores em keys ou que não contenham os valores em keys
- distribution_date_gte (opcional): Este filtro permite que você especifique uma data de distribuição mínima. Ele ajuda a filtrar processos com base na data de distribuição, permitindo que você localize processos distribuídos após uma determinada data.
credential (opcional): Objeto para o uso do cofre de credenciais.
- customer_key (opcional): Permite passar a chave do usuário que você cadastrou no cofre de credenciais, não seja informado, a API tentará encontrar uma credencial cadastrada para a customer_key vazia.

Caso o processo tenha um ou mais processos relacionado ou em alguma outra instância, esses processos serão retornados também.

tags(opcional): Um objeto de valor-chave genérico para armazenar parâmetros de agrupamento.
- cadastrar um monitoramento no dash:
  - name: nome do monitoramento
  - dashboard_id: 238904bd-3b05-4160-bef0-16b329a362f0
  Para cadastrar um monitoramento criado via API no dashboard, é necessário a utilização desse propriedade tag.
  
  Exemplo:
```
{
 "recurrence": 2,
 "with_attachments": false,
 "search": {
  "search_type": "lawsuit_cnj",
  "search_key": "0001234-55.2023.8.26.0100"
 },
 "tags": {
  "name": "nome do seu monitoramento",
  "dasboard_id": "238904bd-3b05-4160-bef0-16b329a362f0"
 }
}
```

Aqui está um exemplo de como um payload pode parecer:

{
 "recurrence": 2,
 "with_attachments": false,
 "search": {
  "search_type": "lawsuit_cnj",
  "search_key": "0001234-55.2023.8.26.0100"
 }
}

Aqui está um exemplo de retorno esperado ao criar um monitoramento:

{
 "tracking_id": "15d632c6-a2ab-40c1-bfc5-d8f7bf8d8dd9",
 "user_id": "82082593-c664-4d7b-b174-2f0dc4791daf",
 "status": "created",
 "recurrence": 1,
 "search": {
  "search_type": "lawsuit_cnj",
  "search_key": "0001234-55.2023.8.26.0100",
  "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"
}

Aqui está um exemplo de como usar esses parâmetros de consulta com curl:

curl -X POST "https://tracking.prod.judit.io/tracking" \
-H "api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
  "recurrence": 2,
  "with_attachments": false,
  "search": {
    "search_type": "lawsuit_cnj",
    "search_key": "0001234-55.2023.8.26.0100"
}'

Atualizando um Monitoramento

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

Esta rota campos opcionais para atualização do tracking: recurrence, tags e o objeto de search para a busca com exceção de alguns campos.

Aqui está um exemplo de como fazer isso usando curl:

curl -X PATCH "https://tracking.prod.judit.io/tracking/{monitoramento}" \
-H "api-key: YOUR_API_KEY"
-d '{
  "recurrence": 5,
  "search": {
    "response_type": "lawsuit"
}'

Note que os campos search_type e search_key não são atualizáveis, somente são passados no momento da criação do monitoramento.

Consultando Seus Monitoramentos

Para consultar todos os seus monitoramentos, você pode fazer uma solicitação GET para a rota /tracking. Esta rota aceita alguns parâmetros de consulta opcionais para paginar e filtrar os resultados:

page: Define a página dos resultados que você deseja consultar.

page_size: Define o número máximo de resultados que você deseja receber por página;

search_type: retorna monitoramentos do tipo de referência especificado “cpf”, “cnpj”, “oab”, “lawsuit_cnj”, name ou rji;

search_key: retorna monitoramentos com a buscar relacionadas ao número do CPF, CNPJ, OAB ou processo informado;

status: retorna monitoramentos cujo status podem ser ‘created’, ‘updating’, ‘updated’, ‘paused’ ou ‘deleted’ ou mais de um de status [‘updating’, ‘paused’];

Aqui está um exemplo de como consultar seus monitoramentos usando curl:

curl -X GET "https://tracking.prod.judit.io/tracking?page=1&page_size=10" \
-H "api-key: YOUR_API_KEY"

Exemplo de notificação de webhook para monitoramento

Obs: Toda movimentação será notificada no webhook o processo por completo, incrementando as últimas movimentações.

{
  "_id": {
    "$oid": "65f0efe046ad3bda5b27be2d"
  },
  "callback_id": "be1406d9-d62d-402d-8e0e-8684044645de",
  "event_type": "response_created",
  "reference_type": "tracking",
  "reference_id": "8744cfea-f9d4-4e83-801e-bc05003ebf6b",
  "user_id": "ac98336e-c493-4609-a058-cf7114f7a2ed",
  "webhook_id": "2f82201d-1439-436d-8c6a-2e6b3e36a54f",
  "payload": {
    "request_id": "7d50b66c-3e86-4d0b-95af-5ff7561d18ff",
    "response_id": "12576767-d3ea-4ea2-8805-6f2a73ef3439",
    "response_type": "lawsuit",
    "response_data": {
      "code": "0000134-63.2024.8.05.0004",
      "justice": "8",
      "tribunal": "05",
      "instance": 1,
      "distribution_date": "2024-01-17T15:43:39.000Z",
      "judge": "AUGUSTO YUZO JOUTI",
      "tribunal_acronym": "TJBA",
      "secrecy_level": 0,
      "tags": {
        "crawl_id": "f9b29daf-4cd4-48e9-97cd-0cee91400765"
      },
      "subjects": [
        {
          "code": "7779",
          "name": "INDENIZAÇÃO POR DANO MORAL"
        },
        {
          "code": "6220",
          "name": "RESPONSABILIDADE DO FORNECEDOR"
        },
        {
          "code": "1156",
          "name": "DIREITO DO CONSUMIDOR"
        }
	],
}

Obs Para cadastrar seu webhook deverá seguir esses passos:

1. Acessar o portal app.judit.io

2. Clicar no seu perfil de usuário > Webhook > Editar

Consultando Informações de um Monitoramento

Para consultar todas as informações sobre um monitoramento específico, você pode fazer uma solicitação GET para a rota /tracking/{monitoramento}, substituindo {monitoramento} pelo ID do monitoramento que você deseja consultar.

Aqui está um exemplo de como fazer isso usando curl:

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

Aqui está o retorno esperado:

{
 "tracking_id": "15d632c6-a2ab-40c1-bfc5-d8f7bf8d8dd9",
 "user_id": "82082593-c664-4d7b-b174-2f0dc4791daf",
 "status": "updated",
 "recurrence": 1,
 "search": {
  "search_type": "lawsuit_cnj",
  "search_key": "0001234-55.2023.8.26.0100",
  "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"
}

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 fazer isso usando 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": "lawsuit_cnj",
  "search_key": "0001234-55.2023.8.26.0100",
  "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 fazer isso 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": "lawsuit_cnj",
  "search_key": "0001234-55.2023.8.26.0100",
  "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 fazer isso 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": "lawsuit_cnj",
  "search_key": "0001234-55.2023.8.26.0100",
  "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"
}

E é isso! Com esses recursos, você pode manter-se atualizado sobre qualquer movimentação em processos judiciais de seu interesse. Se você tiver alguma dúvida ou encontrar algum problema, nossa equipe de suporte está à disposição para ajudá-lo. Entre em contato conosco através do nosso portal de suporte.

Não nos responsabilizamos por consulta por documento inválido, cobranças poderão ser efetuadas decorrente de uso indevido.

Comece a usar

Essenciais

Fluxo de Consulta por Documento

Rota de Monitoramento

Payload da Solicitação

Atualizando um Monitoramento

Consultando Seus Monitoramentos

Exemplo de notificação de webhook para monitoramento

Consultando Informações de um Monitoramento

Pausando um Monitoramento

Reativando um Monitoramento

Deletando um Monitoramento

Comece a usar

Essenciais

Fluxo de Consulta por Documento

​Rota de Monitoramento

​Payload da Solicitação

​Atualizando um Monitoramento

​Consultando Seus Monitoramentos

​Exemplo de notificação de webhook para monitoramento

​Consultando Informações de um Monitoramento

​Pausando um Monitoramento

​Reativando um Monitoramento

​Deletando um Monitoramento

Rota de Monitoramento

Payload da Solicitação

Atualizando um Monitoramento

Consultando Seus Monitoramentos

Exemplo de notificação de webhook para monitoramento

Consultando Informações de um Monitoramento

Pausando um Monitoramento

Reativando um Monitoramento

Deletando um Monitoramento