1

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.

  • 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:

    • contains (opcional): Lista de códigos de assuntos. Restringe a busca a processos que incluam os códigos especificados.
    • not_contains (opcional): Lista de códigos de assuntos. Exclui processos que contenham os códigos especificados.

  • 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.

  • last_step_date_gte (opcional): Restringe a busca a processos cuja data da última movimentação seja maior que à data fornecida.

  • last_step_date_lte (opcional): Restringe a busca a processos cuja data da última movimentação seja menor que à data fornecida.

  • party_names (opcional): Lista de nomes que restringe a busca a processos que os contenham em alguma das partes.

    Obs Ao utilizar esse filtro em conjunto com o filtro de Side, o filtro de Side não será considerado para a restrição dessas partes, já que o filtro de Side é utilizado para filtrar processos onde a parte principal buscada esteja no lado especificado.

  • party_documents (opcional): Lista de documentos que restringe a busca a processos que os contenham em alguma das partes.

    Obs Ao utilizar esse filtro em conjunto com o filtro de Side, o filtro de Side não será considerado para a restrição desses documentos, já que o filtro de Side é utilizado para filtrar processos onde a parte principal buscada esteja no lado especificado.

  • notification_emails (opcional): Array de strings fora do search que podem ser adicionados emails para os quais deseja receber notificação a cada atualização do monitoramento cadastrado.

Exemplo de payload sem filtros:

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'
  }
}"

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

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

Exemplo de payload com alguns filtros opcionais:

curl --location 'https://tracking.prod.judit.io/tracking' \
 --header 'api-key: e8f62c5c-7465-426c-abc5-9735c67f25b1' \
 --header 'Content-Type: application/json' \
 --data '{
     "recurrence": 1,
     "search": {
         "search_type": "cnpj",
         "search_key": "00.000.000/0001-00",
         "search_params": {
             "filter": {
                 "subject_codes": {
                     "keys": ["10433"],
                     "not_equal": false
                 },
                 "classification_codes": {
                     "keys": ["985"],
                     "not_equal": false
                 }
             }
         }
     }
 }'

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": "cnpj",
  "search_key": "00.000.000/0001-00",
  "response_type": "lawsuit",
  "search_params": {
    "filter": {},
    "pagination": {}
  }
},
"hour_range": 21,
"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"
}

Na resposta da criação do monitoramento, é retornado o campo hour_range, que indica o horário em que a consulta aos tribunais serão realizada pela primeira vez. No exemplo acima, a primeira consulta está programada para ocorrer às 21 horas.

2

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": "cnpj",
    "search_key": "00.000.000/0001-00",
    "response_type": "lawsuit",
    "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:

  1. created: Monitoramento criado, porém nunca executado.

  2. updating: Está com uma requisição em processamento.

  3. 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.

  4. paused: Monitoramento pausado, podendo ainda ser reativado.

  5. 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.

3

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"

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.

As propriedades de paginação:

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

4

Consultando histórico de um monitoramento

Para consultar o histórico de respostas geradas por um monitoramento específico, faça uma solicitação GET para a rota /tracking/, substituindo pelo ID do monitoramento desejado.

Você pode filtrar os resultados usando os parâmetros created_at_gte e created_at_lte, onde:

created_at_gte: define a data inicial da consulta. created_at_lte: define a data final da consulta.

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

curl --location 'https://requests.prod.judit.io/responses/tracking/<TRACKING_ID>?order=asc&page=1&page_size=50&created_at_gte=2024-03-05T00%3A00%3A00&created_at_lte=2025-03-11T00%3A00%3A00' \
--header 'api-key: <API-KEY>'

Aqui está o retorno esperado:

{
    "request_status": "completed",
    "page": 1,
    "page_count": 2,
    "all_pages_count": 1,
    "all_count": 2,
    "page_data": [
        {
            "request_id": "644a4759-1ae2-48a4-8b09-76afffc75849393",
            "response_id": "a37ca823-e1d2-4de4-a973-ec9e859d21ed",
            "origin": "tracking",
            "origin_id": "cfb61e6e-f2bd-4375-8c87-373405cac6db",
            "response_type": "lawsuit",
            "response_data": {
                "amount": 13687.36,
                "attachments": [
                    {
                        "attachment_id": "f2f14dca-5b3f-aba2-a9bd95bd367f",
                        "attachment_date": "2025-01-22T15:19:46.000Z",
                        "attachment_name": "id_externo_3",
                        "content": "CÁLCULOS",
                        "extension": "octet-stream",
                        "status": "done",
                        "tags": {
                            "crawl_id": "bf565435-68c6-4b6b-8004-6533cbd0fb8e"
                        },
                        "user_data": null
                    },
                    {
                        "attachment_id": "e26be17f-06ba-9f0c-7fc840e092b1",
                        "attachment_date": "2025-01-22T15:19:46.000Z",
                        "attachment_name": "id_externo_2",
                        "content": "CERTIDÃO DE DÍVIDA ATIVA",
                        "extension": "octet-stream",
                        "status": "done",
                        "tags": {
                            "crawl_id": "bf565435-68c6-4b6b-8004-6533cbd0fb8e"
                        },
                        "user_data": null
                    },
                    {
                        "attachment_id": "54e833a9-58a3-9484-0e6e1cb6c457",
                        "attachment_date": "2025-01-22T15:19:46.000Z",
                        "attachment_name": "id_externo_1",
                        "content": "PETIÇÃO INICIAL",
                        "step_id": "ac8ea79b",
                        "extension": "octet-stream",
                        "status": "done",
                        "tags": {
                            "crawl_id": "bf565435-68c6-4b6b-8004-6533cbd0fb8e"
                        },
                        "user_data": null
                    }
                ],
                "classifications": [
                    {
                        "code": "1116",
                        "name": "EXECUÇÃO FISCAL"
                    }
                ],
                "code": "3000133-12.2025.8.19.0001",
                "county": "TESTE TRIBUNAL",
                "city": "RIO DE JANEIRO",
                "state": "RJ",
                "area": "NÃO INFORMADO",
                "justice_description": "JUSTIÇA ESTADUAL",
                "created_at": "2025-01-23T16:09:20.134Z",
                "updated_at": "2025-01-24T16:10:56.948Z",
                "metadata": {},
                "courts": [
                    {
                        "code": "7798",
                        "name": "TESTE RETORNO TRIUNAL"
                    }
                ],
                "crawler": {
                    "source_name": "JTJ - BR - Document / Lawsuit - Auth",
                    "crawl_id": "8b485368-4315-4247-8314-a6169aa46e0b",
                    "weight": 0,
                    "updated_at": "2025-01-24T16:10:50.024Z"
                },
                "distribution_date": "2025-01-22T15:19:46.000Z",
                "free_justice": false,
                "instance": 1,
                "justice": "8",
                "last_step": {
                    "lawsuit_cnj": "9999999-99.9999.9.99.9999",
                    "lawsuit_instance": 1,
                    "private": false,
                    "step_id": "91dc5544",
                    "step_date": "2025-01-22T18:40:18.000Z",
                    "content": "Conclusos para decisão/despacho",
                    "step_type": "51",
                    "tags": {
                        "crawl_id": "8b485368-4315-4247-8314-a6169aa46e0b"
                    },
                    "steps_count": 1
                },
                "name": "USUÁRIO EXEMPLO 1 X USUÁRIO EXEMPLO 2",
                "parties": [
                    {
                        "side": "Active",
                        "name": "USUÁRIO EXEMPLO 1",
                        "main_document": "99999999999",
                        "person_type": "EXEQUENTE",
                        "entity_type": "company",
                        "documents": [
                            {
                                "document": "99999999999999",
                                "document_type": "CNPJ"
                            }
                        ],
                        "lawyers": [
                            {
                                "name": "USUÁRIO EXEMPLO 3",
                                "main_document": "99999999999",
                                "documents": [
                                    {
                                        "document": "99999999999",
                                        "document_type": "cpf"
                                    }
                                ]
                            }
                        ],
                        "tags": {
                            "crawl_id": "8b485368-4315-4247-8314-a6169aa46e0b"
                        }
                    },
                    {
                        "side": "Passive",
                        "name": "USUÁRIO EXEMPLO 2",
                        "main_document": "99999999999",
                        "person_type": "EXECUTADO",
                        "entity_type": "company",
                        "documents": [
                            {
                                "document": "99999999999999",
                                "document_type": "CNPJ"
                            }
                        ],
                        "tags": {
                            "crawl_id": "8b485368-4315-4247-8314-a6169aa46e0b"
                        },
                        "lawyers": []
                    }
                ],
                "related_lawsuits": [],
                "secrecy_level": 0,
                "status": "Ativo",
                "phase": "Inicial",
                "steps": [],
                "subjects": [
                    {
                        "code": "6017",
                        "name": "DÍVIDA ATIVA (EXECUÇÃO FISCAL)"
                    },
                    {
                        "code": "5953",
                        "name": "IPVA - IMPOSTO SOBRE PROPRIEDADE DE VEÍCULOS AUTOMOTORES"
                    }
                ],
                "tags": {
                    "crawl_id": "8b485368-4315-4247-8314-a6169aa46e0b",
                    "dictionary_updated_at": "2025-01-24T16:10:50.384Z"
                },
                "tribunal": "19",
                "tribunal_acronym": "TJRJ"
            },
            "user_id": "98c1d8e0-94bf-43ab-b298-a7158a9efbc9",
            "created_at": "2025-01-24T16:10:53.278Z",
            "tags": {
                "dashboard_id": null
            }
        },
        {
            "request_id": "32e0cbb6-71ed-4165-81d5-08ef4dcf80c6",
            "response_id": "a6690acb-0856-4e4d-ae69-c8d808ce7d9e",
            "origin": "tracking",
            "origin_id": "cfb61e6e-f2bd-4375-8c87-373405cac6db",
            "response_type": "lawsuit",
            "response_data": {
                "amount": 17456.15,
                "attachments": [],
                "classifications": [
                    {
                        "code": "1116",
                        "name": "EXECUÇÃO FISCAL"
                    }
                ],
                "code": "3000233-64.2025.8.19.0001",
                "county": "CAPITAL 12 VARA FAZ PUBLICA",
                "city": "RIO DE JANEIRO",
                "state": "RJ",
                "area": "NÃO INFORMADO",
                "justice_description": "JUSTIÇA ESTADUAL",
                "created_at": "2025-01-27T16:09:19.112Z",
                "updated_at": "2025-01-27T16:09:19.112Z",
                "metadata": {},
                "courts": [
                    {
                        "code": "79705",
                        "name": " CAPITAL 17 FAZ PUBLICA"
                    }
                ],
                "crawler": {
                    "source_name": "JTJ - BR - Document / Lawsuit - Auth",
                    "crawl_id": "f9efa845-8501-4804-9595-f01c25fd7ba1",
                    "weight": 0,
                    "updated_at": "2025-01-27T16:09:18.570Z"
                },
                "distribution_date": "2025-01-24T17:08:03.000Z",
                "free_justice": false,
                "instance": 1,
                "justice": "8",
                "last_step": {
                    "lawsuit_cnj": "9999999-99.9999.9.99.9999",
                    "lawsuit_instance": 1,
                    "private": false,
                    "step_id": "5d93c333",
                    "step_date": "2025-01-27T10:30:20.000Z",
                    "content": "Expedição de Carta pelo Correio - 1 carta",
                    "step_type": "60",
                    "tags": {
                        "crawl_id": "f9efa845-8501-4804-9595-f01c25fd7ba1"
                    },
                    "steps_count": 1
                },
                "name": "usuário teste 1 X usuário teste 2",
                "parties": [
                    {
                        "side": "Active",
                        "name": "USUÁRIO 1",
                        "main_document": "99999999999999",
                        "person_type": "EXEQUENTE",
                        "entity_type": "company",
                        "documents": [
                            {
                                "document": "99999999999999",
                                "document_type": "CNPJ"
                            }
                        ],
                        "lawyers": [
                            {
                                "name": "USUÁRIO 2",
                                "main_document": "99999999999",
                                "documents": [
                                    {
                                        "document": "99999999999",
                                        "document_type": "cpf"
                                    }
                                ]
                            }
                        ],
                        "tags": {
                            "crawl_id": "f9efa845-8501-4804-9595-f01c25fd7ba1"
                        }
                    },
                    {
                        "side": "Passive",
                        "name": "USUÁRIO 2",
                        "main_document": "99999999999999",
                        "person_type": "EXECUTADO",
                        "entity_type": "company",
                        "documents": [
                            {
                                "document": "99999999999999",
                                "document_type": "CNPJ"
                            }
                        ],
                        "tags": {
                            "crawl_id": "f9efa845-8501-4804-9595-f01c25fd7ba1"
                        },
                        "lawyers": []
                    }
                ],
                "related_lawsuits": [],
                "secrecy_level": 0,
                "status": "Ativo",
                "phase": "Inicial",
                "steps": [],
                "subjects": [
                    {
                        "code": "6017",
                        "name": "DÍVIDA ATIVA (EXECUÇÃO FISCAL)"
                    },
                    {
                        "code": "5953",
                        "name": "IPVA - IMPOSTO SOBRE PROPRIEDADE DE VEÍCULOS AUTOMOTORES"
                    }
                ],
                "tags": {
                    "crawl_id": "f9efa845-8501-4804-9595-f01c25fd7ba1",
                    "dictionary_updated_at": "2025-01-27T16:09:19.635Z"
                },
                "tribunal": "19",
                "tribunal_acronym": "TJRJ"
            },
            "user_id": "98c1d8e0-94bf-43ab-b298-a7158a9efbc9",
            "created_at": "2025-01-27T16:09:18.752Z",
            "tags": {
                "dashboard_id": null
            }
        }
    ]
}
5

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": "lawsuit",
  "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"
}
6

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": "lawsuit",
  "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"
}
7

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": "lawsuit",
  "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"
}