Baixar Collection

Atualizacao De Processos - Escavador API - Documentação

Grupo

Atualização de processos

Solicitar atualização de processos em lote

POST /api/v2/processos/lote/solicitar-atualizacao
Requer autenticaçãoPaga

Solicita a atualização de múltiplos processos nos sistemas dos Tribunais. Permite definir configurações globais (como download de autos ou uso de credenciais) que serão aplicadas a todos os processos do lote. Cada processo do lote será validado individualmente. Se um processo já possuir uma atualização recente ou em andamento, ele será identificado na resposta de erro do lote. A cobrança é realizada individualmente por processo criado.

Visão geral

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

Body Parameters

?
processos array Obrigatório

Lista de objetos contendo os números dos processos.

enviar_callback boolean Opcional

Se enviar_callback=1, um callback será enviado para sua URL configurada para cada processo que concluir a atualização.

documentos_publicos boolean Opcional

Se documentos_publicos=1, serão baixados os documentos públicos para todos os processos do lote.

autos boolean Opcional

Se autos=1, baixa os autos completos dos processos do lote. Requer credenciais (utilizar_certificado=1 ou usuario e senha) e não pode ser usado com documentos_publicos.

utilizar_certificado boolean Opcional

Se utilizar_certificado=1, a autenticação das buscas que exigem login será feita com certificado digital.

certificado_id integer Opcional

Se utilizar_certificado=1, você pode informar o ID do certificado a ser usado no lote. Se não for informado, um certificado válido cadastrado será selecionado aleatoriamente.

usuario string Opcional

Usuário de acesso utilizado em cada busca aos tribunais deste lote (quando aplicável).

senha string Opcional

Senha de acesso utilizada em cada busca aos tribunais deste lote (quando aplicável).

ignorar_atualizados boolean Opcional

Se ignorar_atualizados=1, processos com atualização recente ou em andamento são ignorados sem erro individual; o lote só retorna erro se nenhum processo puder ser processado.

Exemplos de respostas válidas

Esse é um exemplo de resposta de lote criado com sucesso.

HTTP 200 ? 
{
    "id": 56,
    "status_geral": "PENDENTE",
    "criado_em": "2026-02-10T14:22:25+00:00",
    "total": 3,
    "pendente": 3,
    "sucesso": 0,
    "nao_encontrado": 0,
    "erro": 0,
    "processos": {
        "pendente": [
            {
                "numero_cnj": "08025173520198230010"
            },
            {
                "numero_cnj": "30012639320168060072"
            },
            {
                "numero_cnj": "10300069720158260114"
            }
        ],
        "sucesso": [],
        "nao_encontrado": [],
        "erro": []
    }
}

Exemplo de erro quando processos do lote possuem formatos inválidos.

HTTP 422 ? 
{
    "code": "UNPROCESSABLE_ENTITY",
    "message": "Não foi possível processar a solicitação",
    "errors": {
        "processos.0.numero_cnj": [
            "O número do processo não está no formato CNJ."
        ]
    },
    "appends": null
}

Exemplo de erro quando processos do lote possuem atualizações recentes ou em andamento.

HTTP 422 ? 
{
    "code": "UNPROCESSABLE_ENTITY",
    "message": "Não foi possível processar a solicitação",
    "errors": {
        "0802517-35.2019.8.23.0010": {
            "message": "Esse processo já está sendo atualizado.",
            "appends": {
                "ultima_verificacao": {
                    "id": 519,
                    "status": "NA_FILA",
                    "motivo_erro": null,
                    "criado_em": "2026-02-10T16:01:05+00:00",
                    "numero_cnj": "0802517-35.2019.8.23.0010",
                    "concluido_em": null,
                    "opcoes": [],
                    "enviar_callback": "NAO"
                }
            }
        },
        "3001263-93.2016.8.06.0072": {
            "message": "Esse processo já está sendo atualizado.",
            "appends": {
                "ultima_verificacao": {
                    "id": 520,
                    "status": "NA_FILA",
                    "motivo_erro": null,
                    "criado_em": "2026-02-10T16:01:05+00:00",
                    "numero_cnj": "3001263-93.2016.8.06.0072",
                    "concluido_em": null,
                    "opcoes": [],
                    "enviar_callback": "NAO"
                }
            }
        },
        "1030006-97.2015.8.26.0114": {
            "message": "Esse processo já está sendo atualizado.",
            "appends": {
                "ultima_verificacao": {
                    "id": 455,
                    "status": "NA_FILA",
                    "motivo_erro": null,
                    "criado_em": "2026-02-10T14:22:25+00:00",
                    "numero_cnj": "1030006-97.2015.8.26.0114",
                    "concluido_em": null,
                    "opcoes": [],
                    "enviar_callback": "NAO"
                }
            }
        }
    },
    "appends": null
}
HTTP 401 ? 
{
    "error": "Unauthenticated"
}
HTTP 402 ? 
{
    "error": "Você não possui saldo em crédito da API."
}

Status de uma atualização de processos em lote

GET /api/v2/processos/lote/{id}/status
Requer autenticaçãoGrátis

Retorna o progresso atual de um lote de atualizações solicitado.

Os processos dentro do lote podem assumir diferentes estados individualmente, mas o lote é considerado concluído quando todos os seus processos saírem da fila de processamento.

Visão geral

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

Status do Lote

Campo Descrição
PENDENTE O lote foi criado, mas nenhum processo começou a ser atualizado.
PROCESSANDO O lote possui processos em execução ou aguardando sincronização.
FINALIZADO Todos os processos do lote terminaram sua execução (com sucesso ou erro).

URL Parameters

?
id string Obrigatório

O identificador único do lote retornado no momento da criação.

Exemplos de respostas válidas

Exemplo de resposta de um lote.

HTTP 200 ? 
{
    "id": 56,
    "status_geral": "FINALIZADO",
    "criado_em": "2026-02-10T14:22:25+00:00",
    "total": 3,
    "pendente": 0,
    "sucesso": 2,
    "nao_encontrado": 0,
    "erro": 1,
    "processos": {
        "pendente": [],
        "sucesso": [
            {
                "numero_cnj": "08025173520198230010"
            },
            {
                "numero_cnj": "30012639320168060072"
            }
        ],
        "nao_encontrado": [],
        "erro": [
            {
                "numero_cnj": "10300069720158260114",
                "motivo": "LOGIN_INVALIDO"
            }
        ]
    }
}
HTTP 401 ? 
{
    "error": "Unauthenticated"
}
HTTP 404 ? 
{
    "error": "NotFound"
}

Status de uma atualização de processo

GET /api/v2/processos/numero_cnj/{numero}/status-atualizacao
Requer autenticaçãoPaga

Retorna o status de uma solicitação de atualização de um processo. Se nenhuma solicitação foi criada, retorna o status de atualização do processo.

Caso uma solicitação de processo tenha sido criada, esses são os possíveis status da solicitação:

Acesse a página de respostas para detalhes sobre os dados retornados.

Visão geral

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

Status de atualização do Processo

O campo ultima_verificacao.status, que existe quando ultima_verificacao é diferente de null, indica o status geral da atualização do processo, considerando a última solicitação de atualização feita. Os possíveis valores são descritos na tabela abaixo:

Valor Descrição
PENDENTE Aguardando o robô ir buscar as informações no Tribunal.
SUCESSO Atualizou no Tribunal corretamente.
NAO_ENCONTRADO O robô não encontrou o processo no sistema do Tribunal (Processo físico, segredo de justiça, arquivado, etc).
ERRO Teve alguma falha ao tentar atualizar o processo.

URL Parameters

?
numero string Obrigatório

Número único do processo. Obrigatório estar no formato de CNJ.

Exemplos de respostas válidas

Esse é um exemplo de resposta bem-sucedida de um processo sem solicitação de atualização.

HTTP 200 ? 
{
    "numero_cnj": "0000000-00.0000.0.00.0000",
    "data_ultima_verificacao": "2023-03-02T21:31:56+00:00",
    "tempo_desde_ultima_verificacao": "há 2 meses",
    "ultima_verificacao": null
}

Esse é um exemplo de resposta bem-sucedida de um processo com solicitação de atualização.

HTTP 200 ? 
{
    "numero_cnj": "0000000-00.0000.0.00.0000",
    "data_ultima_verificacao": "2023-03-02T21:31:56+00:00",
    "tempo_desde_ultima_verificacao": "há 2 meses",
    "ultima_verificacao": {
        "id": 1,
        "status": "PENDENTE",
        "criado_em": "2023-05-10T18:54:24+00:00",
        "concluido_em": "2023-05-10T18:54:24+00:00"
    }
}

Esse é um exemplo de resposta bem-sucedida de um processo com solicitação de atualização concluida.

HTTP 200 ? 
{
    "numero_cnj": "0000000-00.0000.0.00.0000",
    "data_ultima_verificacao": "2023-05-10T18:56:24+00:00",
    "tempo_desde_ultima_verificacao": "há 1 minuto",
    "ultima_verificacao": {
        "id": 1,
        "status": "SUCESSO",
        "criado_em": "2023-05-10T18:54:24+00:00",
        "concluido_em": "2023-05-10T18:56:33+00:00"
    }
}

Esse é um exemplo de resposta bem-sucedida de um processo não encontrado.

HTTP 200 ? 
{
    "numero_cnj": "0000000-00.0000.0.00.0000",
    "data_ultima_verificacao": null,
    "tempo_desde_ultima_verificacao": null,
    "ultima_verificacao": null
}
HTTP 401 ? 
{
    "error": "Unauthenticated"
}
HTTP 402 ? 
{
    "error": "Você não possui saldo em crédito da API."
}
HTTP 404 ? 
{
    "error": "NotFound"
}

Solicitar atualização de um processo

POST /api/v2/processos/numero_cnj/{numero}/solicitar-atualizacao
Requer autenticaçãoPaga

Solicita a atualização de um processo nos sistemas dos Tribunais para obter as informações mais recentes. A operação é ideal para sincronizar dados e obter acesso a novos andamentos ou documentos.

É possível solicitar download dos documentos públicos ou dos autos do processo, que são documentos restritos e exigem autenticação. Para autenticação via certificado digital, você pode cadastrá-los em https://api.escavador.com/servicos. A escolha entre as opções afeta o custo da solicitação.

A atualização é uma tarefa assíncrona. Após o envio, você deve consultar o endpoint de status ou configurar um webhook para aguardar a conclusão. Com o status SUCESSO, os dados atualizados e os documentos estarão disponíveis para consulta nos endpoints apropriados.

Visão geral

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

URL Parameters

?
numero string Obrigatório

Número único do processo. Obrigatório estar no formato de CNJ.

Body Parameters

?
enviar_callback integer Opcional

Se enviar_callback=1, um callback será enviado para sua URL configurada quando o processo for atualizado.

documentos_publicos integer Opcional

Se documentos_publicos=1, serão baixados os documentos públicos do processo. Não pode ser usado junto com autos=1.

autos integer Opcional

Se autos=1, serão baixados os autos completos do processo (documentos restritos). Requer autenticação via certificado ou usuário/senha.

utilizar_certificado boolean Opcional

Se utilizar_certificado=1, um dos certificados cadastrados na sua conta será utilizado para a autenticação no tribunal. Obrigatório se autos=1 e não for informado usuario e senha.

certificado_id integer Opcional

O ID de um certificado específico que você cadastrou. Se não for enviado, um certificado aleatório da sua conta será selecionado.

usuario string Opcional

Usuário de acesso ao sistema do tribunal. Obrigatório se autos=1 e não for informado utilizar_certificado=1.

senha string Opcional

Senha de acesso ao sistema do tribunal. Obrigatório se autos=1 e não for informado utilizar_certificado=1.

documentos_especificos string Opcional

Se autos == 1, você pode especificar quais documentos deseja receber.
INICIAIS: Serão baixados somente os documentos da primeira data do processo.

Exemplos de respostas válidas

Esse é um exemplo de resposta bem-sucedida.

HTTP 200 ? 
{
    "id": 125,
    "status": "PENDENTE",
    "numero_cnj": "0000000-00.0000.0.00.0000",
    "criado_em": "2023-05-10T19:09:43+00:00",
    "concluido_em": null
}
HTTP 401 ? 
{
    "error": "Unauthenticated"
}
HTTP 402 ? 
{
    "error": "Você não possui saldo em crédito da API."
}
HTTP 404 ? 
{
    "error": "NotFound"
}