Pular para o conteúdo principal
Novo CNPJ (IN 2229/24)A Judit já aceita o novo formato de CNPJ alfanumérico em conformidade com a Instrução Normativa RFB nº 2229/2024.
  • Zero esforço: nenhuma alteração é necessária na sua integração.
  • Ambiente de teste: utilize o documento A1B2C3D4/E5F6-68 para validar o fluxo e receber um processo fictício de resposta.
O Monitoramento por Documento detecta o nascimento de novos processos vinculados a um CPF, CNPJ ou OAB. Diferente do monitoramento por CNJ (que vigia atualizações em um processo conhecido), aqui você descobre processos que ainda não existiam quando você começou a monitorar.
🤖 Endpoint: POST https://tracking.production.judit.io/tracking com search_type em cpf, cnpj ou oab. Sempre que um novo processo for ajuizado e a Judit detectar, você recebe a notificação por webhook.

Quando usar

Vigilância de carteira

Acompanhe um cliente ou contraparte e seja avisado no momento em que houver novo litígio.

Compliance contínuo

Mantenha o KYC vivo: novos processos relevantes contra um fornecedor disparam alerta automático.

Carteira de cobrança

Para grandes carteiras, descubra rapidamente quando o devedor passa a figurar como autor/réu em outras ações.

Inteligência por OAB

Saiba quando um advogado começa a atuar em um novo processo (útil para análise estratégica).

Criando um Monitoramento

Para começar a monitorar um documento, 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:
  • 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.
    • 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:
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 frequência cadastrada no campo recurrence. Exemplo de payload com alguns filtros opcionais:
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.
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.

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 busca relacionada 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 status ['updating', 'paused']; Aqui está um exemplo de como consultar seus monitoramentos usando curl:

Consultando o Status de um Monitoramento

Na URL vai o tracking_id retornado na criação do monitoramento:
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.

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

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:
Aqui está um exemplo de retorno do monitoramento pausado:

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:
Aqui está um exemplo de retorno do monitoramento ativo:

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 excluir.
A exclusão é definitiva: o tracker para de rodar imediatamente, suas execuções futuras são canceladas e o histórico de respostas vinculadas a ele permanece consultável apenas via GET /responses com o origin_id antigo. Se você só quer suspender temporariamente, use Pausar e depois Reativar.
Aqui está um exemplo de como deletar um monitoramento usando curl:
Aqui está um exemplo de retorno do monitoramento deletado:

Consultando a resposta gerada pelo monitoramento via pooling

Exemplo de requisição (GET)

Exemplos de resposta

Recebendo a resposta enviada por webhook para monitoramento

Obs: Cada novo processo distribuído para o documento monitorado será notificado via webhook contendo o processo por completo.
Para cadastrar seu webhook, entre em contato com a equipe de suporte e solicite a criação. Alternativamente, o webhook também pode ser especificado adicionando o parâmetro callback_url no payload da requisição, conforme o exemplo abaixo:

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, passando o tracking_id como parâmetro de consulta. Aqui está um exemplo de como fazer isso usando curl:
Aqui está o retorno esperado:

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 /responses/tracking/{monitoramento}, substituindo {monitoramento} 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:
Aqui está o retorno esperado: