Baixar Collection

Monitoramento De Novos Processos - Escavador API - Documentação

Grupo

Monitoramento de novos processos

Criar monitoramento

POST /api/v2/monitoramentos/novos-processos
Requer autenticaçãoGrátis

O termo enviado será monitorado nas capas e nos envolvidos dos processos. Todos os processos que contiverem o termo serão enviados.

Visão geral

  • Este endpoint exige autenticação.
  • Método HTTP: POST.

Callbacks relacionados

Evento Descrição
novo_processo Ocorre quando um monitoramento de novos processos encontra algum processo novo.

Body Parameters

?
termo string Obrigatório

Termo a ser monitorado. Pode ser o nome de um envolvido, um CPF/CNPJ ou algum termo genérico que apareça na capa do processo.

variacoes array<string> Opcional

Lista de variações do termo a ser monitorado. Caso o processo dê match com alguma variação, será alertado. É permitido o registro de até duas variações.

termos_auxiliares array<object> Opcional

Lista de termos e condições para o alerta do monitoramento. As condições que podem ser utilizadas são as seguintes:
CONTEM: apenas irá alertar se o processo conter todos os nomes informados.
NAO_CONTEM: apenas irá alertar se não tiver nenhum dos termos informados.
CONTEM_ALGUMA: apenas irá alertar, se tiver pelo menos 1 dos termos informados.

tribunais array<string> Opcional

Lista de siglas dos tribunais específicos que o monitoramento deve ser feito, caso não seja informado, o monitoramento será feito em todos os tribunais.

Exemplos de respostas válidas

Esse é um exemplo de resposta bem-sucedida.

HTTP 200 ? 
{
    "id": 111,
    "termo": "Fulano",
    "criado_em": "2023-11-23T18:12:12+00:00",
    "variacoes": [],
    "termos_auxiliares": [],
    "tribunais_especificos": []
}

Esse é um exemplo de monitoramento com variacoes.

HTTP 200 ? 
{
    "id": 112,
    "termo": "Fulano de tal",
    "tipo": "TERMO",
    "criado_em": "2023-11-23 18:15:13",
    "variacoes": [
        " de tal",
        " de tal e tal"
    ]
}

Esse é um exemplo de monitoramento com termos auxiliares.

HTTP 200 ? 
{
    "id": 112,
    "termo": "Fulano de tal",
    "tipo": "TERMO",
    "criado_em": "2023-11-23 18:15:13",
    "termos_auxiliares": {
        "CONTEM": [
            "Fulano"
        ],
        "NAO_CONTEM": [
            "Fulano de tal"
        ],
        "CONTEM_ALGUMA": [
            "Fulano",
            "Fulano de tal"
        ]
    }
}

Esse é um exemplo de monitoramento com termos auxiliares e variacoes.

HTTP 200 ? 
{
    "id": 112,
    "termo": "Fulano de tal",
    "tipo": "TERMO",
    "criado_em": "2023-11-23 18:15:13",
    "variacoes": [
        " de tal",
        " de tal e tal"
    ],
    "termos_auxiliares": {
        "CONTEM": [
            "Fulano"
        ],
        "NAO_CONTEM": [
            "Fulano de tal"
        ],
        "CONTEM_ALGUMA": [
            "Fulano",
            "Fulano de tal"
        ]
    }
}
HTTP 401 ? 
{
    "error": "Unauthenticated"
}
HTTP 402 ? 
{
    "error": "Você não possui saldo em crédito da API."
}

Listar monitoramentos

GET /api/v2/monitoramentos/novos-processos
Requer autenticaçãoGrátis

Retorna todos os monitoramentos de novos processos do usuário

Visão geral

  • Este endpoint exige autenticação.
  • Método HTTP: GET.

Exemplos de respostas válidas

Esse é um exemplo de resposta bem-sucedida.

HTTP 200 ? 
{
    "items": [
        {
            "id": 103,
            "termo": "EMPRESA SA",
            "criado_em": "2023-11-22T22:13:43+00:00",
            "variacoes": [],
            "termos_auxiliares": [],
            "tribunais_especificos": []
        },
        {
            "id": 111,
            "termo": "Fulano",
            "criado_em": "2023-11-23T18:12:12+00:00",
            "variacoes": [],
            "termos_auxiliares": [],
            "tribunais_especificos": []
        },
        {
            "id": 112,
            "termo": "Fulano de tal",
            "criado_em": "2023-11-23T18:15:13+00:00",
            "variacoes": [
                "Fulano d. tal",
                "Fulano de t."
            ],
            "termos_auxiliares": {
                "CONTEM": [
                    "Fulana"
                ],
                "NAO_CONTEM": [
                    "Outra pessoa"
                ]
            },
            "tribunais_especificos": []
        }
    ],
    "links": {
        "next": null,
        "prev": null,
        "first": "http://api.escavador.com/api/v2/monitoramentos/novos-processos?page=1",
        "last": "http://api.escavador.com/api/v2/monitoramentos/novos-processos?page=1"
    },
    "paginator": {
        "current_page": 1,
        "per_page": 20,
        "total": 3,
        "total_pages": 1
    }
}
HTTP 401 ? 
{
    "error": "Unauthenticated"
}
HTTP 402 ? 
{
    "error": "Você não possui saldo em crédito da API."
}

Buscar monitoramento

GET /api/v2/monitoramentos/novos-processos/{id}
Requer autenticaçãoGrátis

Retorna um monitoramento de novos processos a partir do id

Visão geral

  • Este endpoint exige autenticação.
  • Método HTTP: GET.

URL Parameters

?
id integer Obrigatório

Id do monitoramento.

Exemplos de respostas válidas

Esse é um exemplo de resposta bem-sucedida.

HTTP 200 ? 
{
    "id": 111,
    "termo": "Fulano",
    "criado_em": "2023-11-23T18:12:12+00:00",
    "variacoes": [],
    "termos_auxiliares": [],
    "tribunais_especificos": []
}

Esse é um exemplo de monitoramento com variacoes.

HTTP 200 ? 
{
    "id": 112,
    "termo": "Fulano de tal",
    "tipo": "TERMO",
    "criado_em": "2023-11-23 18:15:13",
    "variacoes": [
        " de tal",
        " de tal e tal"
    ]
}

Esse é um exemplo de monitoramento com termos auxiliares.

HTTP 200 ? 
{
    "id": 112,
    "termo": "Fulano de tal",
    "tipo": "TERMO",
    "criado_em": "2023-11-23 18:15:13",
    "termos_auxiliares": {
        "CONTEM": [
            "Fulano"
        ],
        "NAO_CONTEM": [
            "Fulano de tal"
        ],
        "CONTEM_ALGUMA": [
            "Fulano",
            "Fulano de tal"
        ]
    }
}

Esse é um exemplo de monitoramento com termos auxiliares e variacoes.

HTTP 200 ? 
{
    "id": 112,
    "termo": "Fulano de tal",
    "tipo": "TERMO",
    "criado_em": "2023-11-23 18:15:13",
    "variacoes": [
        " de tal",
        " de tal e tal"
    ],
    "termos_auxiliares": {
        "CONTEM": [
            "Fulano"
        ],
        "NAO_CONTEM": [
            "Fulano de tal"
        ],
        "CONTEM_ALGUMA": [
            "Fulano",
            "Fulano de tal"
        ]
    }
}
HTTP 401 ? 
{
    "error": "Unauthenticated"
}
HTTP 402 ? 
{
    "error": "Você não possui saldo em crédito da API."
}
HTTP 404 ? 
{
    "error": "NotFound"
}

Remover monitoramento

DELETE /api/v2/monitoramentos/novos-processos/{id}
Requer autenticaçãoGrátis

Remove um monitoramento de novos processos a partir do id

Visão geral

  • Este endpoint exige autenticação.
  • Método HTTP: DELETE.

URL Parameters

?
id integer Obrigatório

Id do monitoramento.

Exemplos de respostas válidas

HTTP 204 ? 
[]
HTTP 401 ? 
{
    "error": "Unauthenticated"
}
HTTP 402 ? 
{
    "error": "Você não possui saldo em crédito da API."
}
HTTP 404 ? 
{
    "error": "NotFound"
}

Listar processos encontrados

GET /api/v2/monitoramentos/novos-processos/{id}/resultados
Requer autenticaçãoGrátis

Retorna os resultados do monitoramento de novos procesos, a partir do seu ID.

Visão geral

  • Este endpoint exige autenticação.
  • Método HTTP: GET.

URL Parameters

?
id integer Obrigatório

Id do monitoramento.

Exemplos de respostas válidas

Esse é um exemplo de resposta bem-sucedida.

HTTP 200 ? 
{
    "items": [
        {
            "numero_cnj": "3833283-72.2025.4.02.8208",
            "data_inicio": "2025-03-05",
            "tribunal": "TRT-11",
            "match": "<b>João da Silva</b> requerente 92969887215 sind dos emp em estab bancarios no...",
            "estado_origem": {
                "nome": "Amazonas",
                "sigla": "AM"
            }
        },
        {
            "numero_cnj": "6903212-72.2025.2.00.3259",
            "data_inicio": "2024-12-09",
            "tribunal": "TRT-10",
            "match": "expedido(a) intimacao a(o) <b>João da Silva</b>",
            "estado_origem": {
                "nome": "Amazonas",
                "sigla": "AM"
            }
        }
    ],
    "links": {
        "next": null
    },
    "paginator": {
        "per_page": 20
    }
}
HTTP 401 ? 
{
    "error": "Unauthenticated"
}
HTTP 402 ? 
{
    "error": "Você não possui saldo em crédito da API."
}
HTTP 404 ? 
{
    "error": "NotFound"
}

Editar um monitoramento

PATCH /api/v2/monitoramentos/novos-processos/{id}
Requer autenticaçãoGrátis

Edita um monitoramento de novos processos.

A atualização dos campos variacoes, termos_auxiliares e tribunais segue uma lógica de substituição completa: ao enviar um campo, sua lista de valores substitui inteiramente a anterior. Campos não enviados na requisição permanecem inalterados.

Visão geral

  • Este endpoint exige autenticação.
  • Método HTTP: PATCH.

URL Parameters

?
id integer Obrigatório

Id do monitoramento.

Body Parameters

?
variacoes array<string> Opcional

Lista de variações do termo a ser monitorado. É permitido o registro de até duas variações.

- Para remover todas as variações, envie um array vazio [].

termos_auxiliares object[] Opcional

Lista de termos e condições para o alerta do monitoramento. As condições que podem ser utilizadas são as seguintes:
CONTEM: apenas irá alertar se o processo conter todos os nomes informados.
NAO_CONTEM: apenas irá alertar se não tiver nenhum dos termos informados.
CONTEM_ALGUMA: apenas irá alertar, se tiver pelo menos 1 dos termos informados.

- Para substituir a lista existente, envie um novo array. A lista antiga será completamente descartada.
Exemplo: Se existiam as regras [{"condicao": "CONTEM", "termo": "João"}] e você envia [{"condicao": "NAO_CONTEM", "termo": "Maria"}], a regra CONTEM original será removida e apenas a nova regra NAO_CONTEM permanecerá.
- Para remover todos os termos auxiliares, envie um array vazio [].

tribunais array<string> Opcional

Lista de siglas dos tribunais específicos onde o monitoramento deve ser feito.

- Para remover todos os tribunais específicos (voltando a monitorar em todos os tribunais), envie um array vazio [].

Exemplos de respostas válidas

Esse é um exemplo de resposta bem-sucedida.

HTTP 200 ? 
{
    "id": 111,
    "termo": "Fulano",
    "criado_em": "2023-11-23T18:12:12+00:00",
    "variacoes": [],
    "termos_auxiliares": [],
    "tribunais_especificos": []
}

Esse é um exemplo de monitoramento com variacoes.

HTTP 200 ? 
{
    "id": 112,
    "termo": "Fulano de tal",
    "tipo": "TERMO",
    "criado_em": "2023-11-23 18:15:13",
    "variacoes": [
        " de tal",
        " de tal e tal"
    ]
}

Esse é um exemplo de monitoramento com termos auxiliares.

HTTP 200 ? 
{
    "id": 112,
    "termo": "Fulano de tal",
    "tipo": "TERMO",
    "criado_em": "2023-11-23 18:15:13",
    "termos_auxiliares": {
        "CONTEM": [
            "Fulano"
        ],
        "NAO_CONTEM": [
            "Fulano de tal"
        ],
        "CONTEM_ALGUMA": [
            "Fulano",
            "Fulano de tal"
        ]
    }
}

Esse é um exemplo de monitoramento com termos auxiliares e variacoes.

HTTP 200 ? 
{
    "id": 112,
    "termo": "Fulano de tal",
    "tipo": "TERMO",
    "criado_em": "2023-11-23 18:15:13",
    "variacoes": [
        " de tal",
        " de tal e tal"
    ],
    "termos_auxiliares": {
        "CONTEM": [
            "Fulano"
        ],
        "NAO_CONTEM": [
            "Fulano de tal"
        ],
        "CONTEM_ALGUMA": [
            "Fulano",
            "Fulano de tal"
        ]
    }
}