NAV
bash javascript php python

Visão geral

API do Escavador

Bem vindo à API do Escavador!

O Escavador coleta e compila dados públicos disponíveis em fontes oficiais, desde Diários Oficiais a Tribunais do poder judiciário de todo o Brasil. Integre a API do Escavador ao seu sistema e tenha acesso a informações públicas de pessoas, empresas e processos, disponibilizadas de maneira estruturada.

Ao lado direito da página são exibidos exemplos da utilização de cada endpoint da API em bash e nas linguagens javascript, php e python.

O limite de requisições no uso da API é de 500 requisições por minuto.

Para mais informações, fale conosco.

Saldo

É possível encontrar o custo em centavos de uma requisição no header Creditos-Utilizados, presente na resposta. Visite a página de histórico para saber como consultar seu saldo. Consulte também a página de preços para saber mais sobre os custos de cada versão.

Callbacks

Na API V2, é possível receber callbacks para diversos eventos, como o callback associado a uma solicitação de atualização de um processo. Para fazer uso dessa funcionalidade, é necessário configurar uma URL de callback no painel da API. Acesse nosso guia sobre configuração da URL de callback para saber mais.

Versões

A API do escavador possui duas versão, a V1 e a V2. você pode encontrar mais informações sobre cada uma delas abaixo. Além disso, consulte a página de preços para saber mais sobre os custos de cada versão. É importante que você identifique quais recursos da API você irá utilizar para escolher a versão mais adequada. Agende uma reunião com a nossa equipe de vendas para tirar dúvidas e conhecer melhor a API.

API V1

A API V1 conta com funcionalidades de busca e monitoramento de processos, pessoas e empresas, a consulta de jurisprudencias e legislacoes, e a consulta e monitoramento em diários oficiais.

API Endpoint: https://api.escavador.com/api/v1

Para acessar a documentação da V1 da API clique aqui.

API V2

A API V2 conta com a funcionalidade de busca de processos, se diferenciando da V1 por ter uma maior quantidade de informações estruturadas de forma mais detalhada.

API Endpoint: https://api.escavador.com/api/v2

Para acessar a documentação da V2 da API clique aqui.

Postman

Caso utilize o Postman para realizar os testes, você pode baixar essa collection para o Postman.

Autenticação

Solicitar Token de Acesso pelo Painel

A API do Escavador utiliza Bearer Token para autenticação de usuários. O Bearer Token é um método de autenticação que envolve o uso de um token alfanumérico enviado junto com as solicitações para a API. Esse token é adicionado ao cabeçalho HTTP da solicitação, no campo "Authorization". Ele garante que apenas usuários autorizados tenham acesso aos recursos da API. Para isso, é necessário ter uma conta na plataforma. Você pode fazer isso acessando aqui.

Bibliotecas

Python

Possuimos um SDK em python com suporte para ambas as versões da API, Para entender como utilizar o SDK, consulte nosso repositório no github.

Painel da API

O painel da API do Escavador é uma ferramenta que facilita o gerenciamento do seu uso da API, lá você pode acessar:

Guias

Autenticando na API

Acesse o painel da API na página de gestão de tokens. Clique no botão + Criar Token, forneça um nome para seu token e logo depois certifique-se de copiar o token gerado, pois ele não será exibido novamente. Use o token gerado no cabeçalho das requisições para ser autenticado pela API.
O painel de tokens oferece uma gestão melhor de seus tokens de acesso, informando o nome, data de criação, vida útil e o recurso de revogar seus tokens.

Com o token gerado, basta enviar o header Authorization com o valor Bearer {seu-token-gerado}, desta forma, iremos autenticar sua requisição.

Configurando uma URL de callback

Como dito anteriormente, é possível configurar um URL de callback para receber callbacks da API do Escavador. Para isso acesse a página de callbacks, no painel da API, lá você pode informar a URL de callback, assim, para monitoramentos ou buscas assíncronas, quando novos eventos ou resultados forem gerados, eles serão enviados para a URL configurada.

Gerando um token para validar callbacks da API

Com a URL de callbacks configurada, é importante que você valide se o callback é de fato da API do Escavador. Para isso basta gerar um token de segurança no painel da API, com isso, ao receber novos callbacks do Escavador, você pode validar se o token enviado é o mesmo que você gerou. Nós enviamos o token pelo header Authorization.

Paginação

Algumas rotas da API utilizam paginação para retornar os resultados, pois, é possivel que muitas informações sejam retornadas. Além disso, para navegar pelos resultados, basta acessar os links gerados no campo da paginação.

Atualização de processos

Status de uma atualização de processo

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.

Status de atualização do Processo

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

Exemplo de requisição:

curl -X GET -G "https://api.escavador.com/api/v2/processos/numero_cnj/0018063-19.2013.8.26.0002/status-atualizacao" \
    -H "Authorization: Bearer {access_token}" \
    -H "X-Requested-With: XMLHttpRequest"
const url = new URL("https://api.escavador.com/api/v2/processos/numero_cnj/0018063-19.2013.8.26.0002/status-atualizacao");

let headers = {
    "Authorization": "Bearer {access_token}",
    "X-Requested-With": "XMLHttpRequest",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

$client = new \GuzzleHttp\Client();
$response = $client->get("https://api.escavador.com/api/v2/processos/numero_cnj/0018063-19.2013.8.26.0002/status-atualizacao", [
    'headers' => [
            "Authorization" => "Bearer {access_token}",
            "X-Requested-With" => "XMLHttpRequest",
        ],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.escavador.com/api/v2/processos/numero_cnj/0018063-19.2013.8.26.0002/status-atualizacao'

headers = {
  'Authorization': 'Bearer {access_token}',
  'X-Requested-With': 'XMLHttpRequest'
}

response = requests.request('GET', url, headers=headers)
parsed = json.loads(response.text)
print(json.dumps(parsed, indent=4))

// Esse é um exemplo de resposta bem-sucedida de um processo sem solicitação de atualização.
Exemplo de resposta (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.
Exemplo de resposta (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.
Exemplo de resposta (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.
Exemplo de resposta (200):

{
  "numero_cnj": "0000000-00.0000.0.00.0000",
  "data_ultima_verificacao": null,
  "tempo_desde_ultima_verificacao": null,
  "ultima_verificacao": null
}

Exemplo de resposta (401):

{
  "error": "Unauthenticated"
}

Exemplo de resposta (402):

{
  "error": "Você não possui saldo em crédito da API."
}

Exemplo de resposta (404):

{
  "error": "NotFound"
}

HTTP Request

GET api/v2/processos/numero_cnj/{numero}/status-atualizacao

Headers

Campo Valor
Authorization Bearer {access_token}
X-Requested-With XMLHttpRequest

URI Parameters

Parâmetro Tipo Descrição
numero string Número único do processo. Obrigatório estar no formato de CNJ.
Exemplo: 0000000-00.0000.0.00.0000

Solicitar atualização de um processo

Solicita a inclusão ou atualização de um processo nos sistemas dos Tribunais, para obter as informações mais recentes.

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

Exemplo de requisição:

curl -X POST "https://api.escavador.com/api/v2/processos/numero_cnj/0018063-19.2013.8.26.0002/solicitar-atualizacao" \
    -H "Authorization: Bearer {access_token}" \
    -H "X-Requested-With: XMLHttpRequest" \
    -H "Content-Type: application/json" \
    -d '{"enviar_callback":1}'
const url = new URL("https://api.escavador.com/api/v2/processos/numero_cnj/0018063-19.2013.8.26.0002/solicitar-atualizacao");

let headers = {
    "Authorization": "Bearer {access_token}",
    "X-Requested-With": "XMLHttpRequest",
    "Content-Type": "application/json",
    "Accept": "application/json",
}

let body = {
    "enviar_callback": 1
}

fetch(url, {
    method: "POST",
    headers: headers,
    body: JSON.stringify(body)
})
    .then(response => response.json())
    .then(json => console.log(json));

$client = new \GuzzleHttp\Client();
$response = $client->post("https://api.escavador.com/api/v2/processos/numero_cnj/0018063-19.2013.8.26.0002/solicitar-atualizacao", [
    'headers' => [
            "Authorization" => "Bearer {access_token}",
            "X-Requested-With" => "XMLHttpRequest",
            "Content-Type" => "application/json",
        ],
    'json' => [
            "enviar_callback" => 1,
        ],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.escavador.com/api/v2/processos/numero_cnj/0018063-19.2013.8.26.0002/solicitar-atualizacao'

payload = {
  'enviar_callback': '1'
}

headers = {
  'Authorization': 'Bearer {access_token}',
  'X-Requested-With': 'XMLHttpRequest',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
parsed = json.loads(response.text)
print(json.dumps(parsed, indent=4))

// Esse é um exemplo de resposta bem-sucedida.
Exemplo de resposta (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
}

Exemplo de resposta (401):

{
  "error": "Unauthenticated"
}

Exemplo de resposta (402):

{
  "error": "Você não possui saldo em crédito da API."
}

Exemplo de resposta (404):

{
  "error": "NotFound"
}

HTTP Request

POST api/v2/processos/numero_cnj/{numero}/solicitar-atualizacao

Headers

Campo Valor
Authorization Bearer {access_token}
X-Requested-With XMLHttpRequest
Content-Type application/json

URI Parameters

Parâmetro Tipo Descrição
numero string Número único do processo. Obrigatório estar no formato de CNJ.
Exemplo: 0000000-00.0000.0.00.0000

Body Parameters

Parâmetro Tipo Status Descrição
enviar_callback integer opcional Se enviar_callback=1 será enviado um callback quando o processo for atualizado. Obrigatório ter uma url de callback.

Consulta de processos

Processo por numeração CNJ

Retorna dados da capa de um processo a partir da numeração CNJ.

Exemplo de requisição:

curl -X GET -G "https://api.escavador.com/api/v2/processos/numero_cnj/0018063-19.2013.8.26.0002" \
    -H "Authorization: Bearer {access_token}" \
    -H "X-Requested-With: XMLHttpRequest"
const url = new URL("https://api.escavador.com/api/v2/processos/numero_cnj/0018063-19.2013.8.26.0002");

let headers = {
    "Authorization": "Bearer {access_token}",
    "X-Requested-With": "XMLHttpRequest",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

$client = new \GuzzleHttp\Client();
$response = $client->get("https://api.escavador.com/api/v2/processos/numero_cnj/0018063-19.2013.8.26.0002", [
    'headers' => [
            "Authorization" => "Bearer {access_token}",
            "X-Requested-With" => "XMLHttpRequest",
        ],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));
from escavador import *
from escavador.v2 import Processo
config("API_KEY")

response = Processo.por_numero(
  numero_cnj="0000000-00.0000.0.00.0000" # também aceita formato "00000000000000000000"
)

// Esse é um exemplo de resposta bem-sucedida.
Exemplo de resposta (200):

{
  "numero_cnj": "1024000-20.2015.2.23.0000",
  "titulo_polo_ativo": "Maria da Conceição de Oliveira",
  "titulo_polo_passivo": "João da Silva",
  "ano_inicio": 2015,
  "data_inicio": "2015-11-21",
  "data_ultima_movimentacao": "2018-07-25",
  "quantidade_movimentacoes": 103,
  "fontes_tribunais_estao_arquivadas": false,
  "data_ultima_verificacao": "2023-02-09T14:30:11+00:00",
  "tempo_desde_ultima_verificacao": "há 1 mês",
  "fontes": [
    {
      "id": 3,
      "processo_fonte_id": 14626,
      "descricao": "TJSP - 1º grau",
      "nome": "Tribunal de Justiça de São Paulo",
      "sigla": "TJSP",
      "tipo": "TRIBUNAL",
      "data_inicio": "2015-11-27",
      "data_ultima_movimentacao": "2018-07-25",
      "segredo_justica": null,
      "arquivado": null,
      "grau": 1,
      "grau_formatado": "Primeiro Grau",
      "fisico": false,
      "sistema": "ESAJ",
      "capa": {
        "classe": "PROCEDIMENTO COMUM CIVEL",
        "assunto": "RESPONSABILIDADE CIVIL",
        "assuntos_normalizados": [
          {
            "id": 3642,
            "nome": "Responsabilidade Civil",
            "nome_com_pai": "DIREITO CIVIL > Responsabilidade Civil",
            "path_completo": "DIREITO CIVIL | Responsabilidade Civil",
            "bloqueado": false
          }
        ],
        "assunto_principal_normalizado": {
          "id": 3642,
          "nome": "Responsabilidade Civil",
          "nome_com_pai": "DIREITO CIVIL > Responsabilidade Civil",
          "path_completo": "DIREITO CIVIL | Responsabilidade Civil",
          "bloqueado": false
        },
        "area": "CIVEL",
        "orgao_julgador": "7ª VARA CIVEL",
        "valor_causa": {
          "valor": "50000.0000",
          "moeda": "R$",
          "valor_formatado": "R$ 50.000,00"
        },
        "data_distribuicao": "2015-11-27",
        "data_arquivamento": null,
        "informacoes_complementares": null
      },
      "url": "https://esaj.tjsp.jus.br/cpopg/search.do?conversationId=&dadosConsulta.localPesquisa.cdLocal=-1&cbPesquisa=NUMPROC&dadosConsulta.tipoNuProcesso=UNIFICADO&numeroDigitoAnoUnificado=1024000-20.2015&foroNumeroUnificado=0000&dadosConsulta.valorConsultaNuUnificado=1024000-20.2015.2.23.0000&dadosConsulta.valorConsulta=",
      "tribunal": {
        "id": 102,
        "nome": "Tribunal de Justiça de São Paulo",
        "sigla": "TJSP",
        "categoria": null
      },
      "quantidade_movimentacoes": 68,
      "data_ultima_verificacao": "2023-02-09T14:30:11+00:00",
      "envolvidos": [
        {
          "nome": "Maria da Conceição de Oliveira",
          "quantidade_processos": 1,
          "tipo_pessoa": "FISICA",
          "advogados": [
            {
              "nome": "Marta Brandao de Oliveira",
              "quantidade_processos": 21,
              "tipo_pessoa": "FISICA",
              "prefixo": null,
              "sufixo": null,
              "tipo": "ADVOGADO",
              "tipo_normalizado": "Advogado",
              "polo": "ADVOGADO",
              "cpf": "00000000000",
              "nome_normalizado": "Marta Brandao de Oliveira",
              "oabs": [
                {
                  "uf": "SP",
                  "tipo": "ADVOGADO",
                  "numero": 123123
                }
              ]
            },
            {
              "nome": "Fernando Marçal",
              "quantidade_processos": 10,
              "tipo_pessoa": "FISICA",
              "prefixo": null,
              "sufixo": null,
              "tipo": "ADVOGADO",
              "tipo_normalizado": "Advogado",
              "polo": "ADVOGADO",
              "cpf": "00000000000",
              "nome_normalizado": "Fernando Marçal",
              "oabs": [
                {
                  "uf": "SP",
                  "tipo": "ADVOGADO",
                  "numero": 123123
                }
              ]
            }
          ],
          "prefixo": null,
          "sufixo": null,
          "tipo": "REQUERENTE",
          "tipo_normalizado": "Requerente",
          "polo": "ATIVO",
          "cpf": "00000000000",
          "nome_normalizado": "Maria da Conceição de Oliveira"
        },
        {
          "nome": "Joao da Silva",
          "quantidade_processos": 97,
          "tipo_pessoa": "FISICA",
          "advogados": [
            {
              "nome": "Antonio Carlos de Souza",
              "quantidade_processos": 37,
              "tipo_pessoa": "FISICA",
              "prefixo": null,
              "sufixo": null,
              "tipo": "ADVOGADO",
              "tipo_normalizado": "Advogado",
              "polo": "ADVOGADO",
              "cpf": "00000000000",
              "nome_normalizado": "Antonio Carlos de Souza",
              "oabs": [
                {
                  "uf": "SP",
                  "tipo": "ADVOGADO",
                  "numero": 123123
                }
              ]
            },
            {
              "nome": "Fabiane Santos Carvalho",
              "quantidade_processos": 33,
              "tipo_pessoa": "FISICA",
              "prefixo": null,
              "sufixo": null,
              "tipo": "ADVOGADO",
              "tipo_normalizado": "Advogado",
              "polo": "ADVOGADO",
              "cpf": "00000000000",
              "nome_normalizado": "Fabiane Santos Carvalho",
              "oabs": [
                {
                  "uf": "SP",
                  "tipo": "ADVOGADO",
                  "numero": 123123
                }
              ]
            }
          ],
          "prefixo": null,
          "sufixo": null,
          "tipo": "REQUERIDO",
          "tipo_normalizado": "Requerido",
          "polo": "PASSIVO",
          "cpf": "00000000000",
          "nome_normalizado": "Joao da Silva"
        },
        {
          "nome": "Marcos Tira Teima",
          "quantidade_processos": 126,
          "tipo_pessoa": "FISICA",
          "prefixo": null,
          "sufixo": null,
          "tipo": "JUIZ",
          "tipo_normalizado": "Juiz",
          "polo": "NENHUM"
        }
      ]
    },
    {
      "id": 6,
      "processo_fonte_id": 14566,
      "descricao": "TJSP - 2º grau",
      "nome": "Tribunal de Justiça de São Paulo",
      "sigla": "TJSP",
      "tipo": "TRIBUNAL",
      "data_inicio": "2017-06-01",
      "data_ultima_movimentacao": "2018-04-26",
      "segredo_justica": null,
      "arquivado": null,
      "grau": 2,
      "grau_formatado": "Segundo Grau",
      "fisico": false,
      "sistema": "ESAJ",
      "capa": {
        "classe": "APELACAO CIVEL",
        "assunto": "DIREITO CIVIL-RESPONSABILIDADE CIVIL-INDENIZACAO POR DANO MORAL",
        "assuntos_normalizados": [
          {
            "id": 3644,
            "nome": "Indenização por Dano Moral",
            "nome_com_pai": "Responsabilidade Civil > Indenização por Dano Moral",
            "path_completo": "DIREITO CIVIL | Responsabilidade Civil | Indenização por Dano Moral",
            "bloqueado": false
          }
        ],
        "assunto_principal_normalizado": {
          "id": 3644,
          "nome": "Indenização por Dano Moral",
          "nome_com_pai": "Responsabilidade Civil > Indenização por Dano Moral",
          "path_completo": "DIREITO CIVIL | Responsabilidade Civil | Indenização por Dano Moral",
          "bloqueado": false
        },
        "area": "CIVEL",
        "orgao_julgador": "7ª CAMARA DE DIREITO PRIVADO",
        "valor_causa": {
          "valor": "50000.0000",
          "moeda": "R$",
          "valor_formatado": "R$ 50.000,00"
        },
        "data_distribuicao": "2017-06-01",
        "data_arquivamento": null,
        "informacoes_complementares": null
      },
      "url": "https://esaj.tjsp.jus.br/cposg/search.do?conversationId=&paginaConsulta=0&cbPesquisa=NUMPROC&numeroDigitoAnoUnificado=1024000-20.2015&foroNumeroUnificado=0000&dePesquisaNuUnificado=1024000-20.2015.8.22.0000&dePesquisaNuUnificado=UNIFICADO&dePesquisa=&tipoNuProcesso=UNIFICADO&uuidCaptcha=sajcaptcha_e6c6a295c5404a6887d81483bdd96048&g-recaptcha-response=",
      "tribunal": {
        "id": 102,
        "nome": "Tribunal de Justiça de São Paulo",
        "sigla": "TJSP",
        "categoria": null
      },
      "quantidade_movimentacoes": 35,
      "data_ultima_verificacao": "2023-02-09T14:30:00+00:00",
      "envolvidos": [
        {
          "nome": "Maria da Conceição de Oliveira",
          "quantidade_processos": 1,
          "tipo_pessoa": "FISICA",
          "advogados": [
            {
              "nome": "Fabiane Santos Carvalho",
              "quantidade_processos": 21,
              "tipo_pessoa": "FISICA",
              "prefixo": null,
              "sufixo": null,
              "tipo": "ADVOGADO",
              "tipo_normalizado": "Advogado",
              "polo": "ADVOGADO",
              "cpf": "00000000000",
              "nome_normalizado": "Fabiane Santos Carvalho",
              "oabs": [
                {
                  "uf": "SP",
                  "tipo": "ADVOGADO",
                  "numero": 123123
                }
              ]
            },
            {
              "nome": "Antonio Carlos de Souza",
              "quantidade_processos": 10,
              "tipo_pessoa": "FISICA",
              "prefixo": null,
              "sufixo": null,
              "tipo": "ADVOGADO",
              "tipo_normalizado": "Advogado",
              "polo": "ADVOGADO",
              "cpf": "00000000000",
              "nome_normalizado": "Antonio Carlos de Souza",
              "oabs": [
                {
                  "uf": "SP",
                  "tipo": "ADVOGADO",
                  "numero": 123123
                }
              ]
            }
          ],
          "prefixo": null,
          "sufixo": null,
          "tipo": "APELANTE",
          "tipo_normalizado": "Apelante",
          "polo": "ATIVO",
          "cpf": "00000000000",
          "nome_normalizado": "Maria da Conceicao de Oliveira"
        },
        {
          "nome": "Joao da Silva",
          "quantidade_processos": 97,
          "tipo_pessoa": "FISICA",
          "advogados": [
            {
              "nome": "",
              "quantidade_processos": 37,
              "tipo_pessoa": "FISICA",
              "prefixo": null,
              "sufixo": null,
              "tipo": "ADVOGADO",
              "tipo_normalizado": "Advogado",
              "polo": "ADVOGADO",
              "cpf": "00000000000",
              "nome_normalizado": "Marta Brandao de Oliveira",
              "oabs": [
                {
                  "uf": "SP",
                  "tipo": "ADVOGADO",
                  "numero": 123123
                }
              ]
            },
            {
              "nome": "Fernando Marçal",
              "quantidade_processos": 33,
              "tipo_pessoa": "FISICA",
              "prefixo": null,
              "sufixo": null,
              "tipo": "ADVOGADO",
              "tipo_normalizado": "Advogado",
              "polo": "ADVOGADO",
              "cpf": "00000000000",
              "nome_normalizado": "Fernando Marçal",
              "oabs": [
                {
                  "uf": "SP",
                  "tipo": "ADVOGADO",
                  "numero": 123123
                }
              ]
            }
          ],
          "prefixo": null,
          "sufixo": null,
          "tipo": "APELADO",
          "tipo_normalizado": "Apelado",
          "polo": "PASSIVO",
          "cpf": "00000000000",
          "nome_normalizado": "Joao da Silva"
        },
        {
          "nome": "Ronaldo de Assis",
          "quantidade_processos": 86,
          "tipo_pessoa": "FISICA",
          "prefixo": null,
          "sufixo": null,
          "tipo": "RELATOR",
          "tipo_normalizado": "Juiz",
          "polo": "NENHUM",
          "cpf": "00000000000",
          "nome_normalizado": "Ronaldo de Assis"
        }
      ]
    }
  ]
}

Exemplo de resposta (401):

{
  "error": "Unauthenticated"
}

Exemplo de resposta (402):

{
  "error": "Você não possui saldo em crédito da API."
}

Exemplo de resposta (404):

{
  "error": "NotFound"
}

HTTP Request

GET api/v2/processos/numero_cnj/{numero}

Headers

Campo Valor
Authorization Bearer {access_token}
X-Requested-With XMLHttpRequest

URI Parameters

Parâmetro Tipo Descrição
numero string Número único do processo. Obrigatório estar no formato de CNJ.
Exemplo: 0000000-00.0000.0.00.0000

Movimentações de um processo

Retorna as movimentações de um processo a partir do número CNJ.

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

Exemplo de requisição:

curl -X GET -G "https://api.escavador.com/api/v2/processos/numero_cnj/0018063-19.2013.8.26.0002/movimentacoes" \
    -H "Authorization: Bearer {access_token}" \
    -H "X-Requested-With: XMLHttpRequest"
const url = new URL("https://api.escavador.com/api/v2/processos/numero_cnj/0018063-19.2013.8.26.0002/movimentacoes");

let headers = {
    "Authorization": "Bearer {access_token}",
    "X-Requested-With": "XMLHttpRequest",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

$client = new \GuzzleHttp\Client();
$response = $client->get("https://api.escavador.com/api/v2/processos/numero_cnj/0018063-19.2013.8.26.0002/movimentacoes", [
    'headers' => [
            "Authorization" => "Bearer {access_token}",
            "X-Requested-With" => "XMLHttpRequest",
        ],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));
from escavador import *
from escavador.v2 import Processo
config("API_KEY")

response = Processo.movimentacoes(
  numero_cnj="0000000-00.0000.0.00.0000" # também aceita formato "00000000000000000000"
)

// Esse é um exemplo de resposta bem-sucedida.
Exemplo de resposta (200):

{
  "items": [
    {
      "id": 853879,
      "data": "2018-07-25",
      "tipo": "ANDAMENTO",
      "conteudo": "CERTIDAO DE CARTORIO EXPEDIDA",
      "fonte": {
        "fonte_id": 3,
        "nome": "Tribunal de Justiça de São Paulo",
        "tipo": "TRIBUNAL",
        "sigla": "TJSP",
        "grau": 1,
        "grau_formatado": "Primeiro Grau"
      }
    },
    {
      "id": 853877,
      "data": "2018-07-25",
      "tipo": "ANDAMENTO",
      "conteudo": "CERTIDAO DE CARTORIO EXPEDIDA",
      "fonte": {
        "fonte_id": 3,
        "nome": "Tribunal de Justiça de São Paulo",
        "tipo": "TRIBUNAL",
        "sigla": "TJSP",
        "grau": 1,
        "grau_formatado": "Primeiro Grau"
      }
    },
    {
      "id": 853875,
      "data": "2018-07-25",
      "tipo": "ANDAMENTO",
      "conteudo": "ARQUIVADO DEFINITIVAMENTE",
      "fonte": {
        "fonte_id": 3,
        "nome": "Tribunal de Justiça de São Paulo",
        "tipo": "TRIBUNAL",
        "sigla": "TJSP",
        "grau": 1,
        "grau_formatado": "Primeiro Grau"
      }
    },
    {
      "id": 853881,
      "data": "2018-06-05",
      "tipo": "ANDAMENTO",
      "conteudo": "SUSPENSAO DO PRAZO",
      "fonte": {
        "fonte_id": 3,
        "nome": "Tribunal de Justiça de São Paulo",
        "tipo": "TRIBUNAL",
        "sigla": "TJSP",
        "grau": 1,
        "grau_formatado": "Primeiro Grau"
      }
    },
    {
      "id": 853883,
      "data": "2018-06-02",
      "tipo": "ANDAMENTO",
      "conteudo": "SUSPENSAO DO PRAZO",
      "fonte": {
        "fonte_id": 3,
        "nome": "Tribunal de Justiça de São Paulo",
        "tipo": "TRIBUNAL",
        "sigla": "TJSP",
        "grau": 1,
        "grau_formatado": "Primeiro Grau"
      }
    },
    {
      "id": 853885,
      "data": "2018-05-24",
      "tipo": "ANDAMENTO",
      "conteudo": "CERTIDAO DE PUBLICACAO EXPEDIDA",
      "fonte": {
        "fonte_id": 3,
        "nome": "Tribunal de Justiça de São Paulo",
        "tipo": "TRIBUNAL",
        "sigla": "TJSP",
        "grau": 1,
        "grau_formatado": "Primeiro Grau"
      }
    },
    {
      "id": 853887,
      "data": "2018-05-23",
      "tipo": "ANDAMENTO",
      "conteudo": "REMETIDO AO DJE",
      "fonte": {
        "fonte_id": 3,
        "nome": "Tribunal de Justiça de São Paulo",
        "tipo": "TRIBUNAL",
        "sigla": "TJSP",
        "grau": 1,
        "grau_formatado": "Primeiro Grau"
      }
    },
    {
      "id": 853889,
      "data": "2018-05-10",
      "tipo": "ANDAMENTO",
      "conteudo": "PROFERIDO DESPACHO",
      "fonte": {
        "fonte_id": 3,
        "nome": "Tribunal de Justiça de São Paulo",
        "tipo": "TRIBUNAL",
        "sigla": "TJSP",
        "grau": 1,
        "grau_formatado": "Primeiro Grau"
      }
    },
    {
      "id": 853896,
      "data": "2018-05-04",
      "tipo": "ANDAMENTO",
      "conteudo": "DECISAO DE 2ª INSTANCIA - RECURSO NAO PROVIDO - JUNTADA",
      "fonte": {
        "fonte_id": 3,
        "nome": "Tribunal de Justiça de São Paulo",
        "tipo": "TRIBUNAL",
        "sigla": "TJSP",
        "grau": 1,
        "grau_formatado": "Primeiro Grau"
      }
    },
    {
      "id": 853895,
      "data": "2018-05-04",
      "tipo": "ANDAMENTO",
      "conteudo": "EMBARGOS DE DECLARACAO ACOLHIDOS",
      "fonte": {
        "fonte_id": 3,
        "nome": "Tribunal de Justiça de São Paulo",
        "tipo": "TRIBUNAL",
        "sigla": "TJSP",
        "grau": 1,
        "grau_formatado": "Primeiro Grau"
      }
    },
    {
      "id": 853893,
      "data": "2018-05-04",
      "tipo": "ANDAMENTO",
      "conteudo": "TRANSITO EM JULGADO AS PARTES - PROC. EM ANDAMENTO",
      "fonte": {
        "fonte_id": 3,
        "nome": "Tribunal de Justiça de São Paulo",
        "tipo": "TRIBUNAL",
        "sigla": "TJSP",
        "grau": 1,
        "grau_formatado": "Primeiro Grau"
      }
    },
    {
      "id": 853891,
      "data": "2018-05-04",
      "tipo": "ANDAMENTO",
      "conteudo": "CONCLUSOS PARA DESPACHO",
      "fonte": {
        "fonte_id": 3,
        "nome": "Tribunal de Justiça de São Paulo",
        "tipo": "TRIBUNAL",
        "sigla": "TJSP",
        "grau": 1,
        "grau_formatado": "Primeiro Grau"
      }
    },
    {
      "id": 853897,
      "data": "2018-04-26",
      "tipo": "ANDAMENTO",
      "conteudo": "RECEBIDOS OS AUTOS DO TRIBUNAL DE JUSTICA",
      "fonte": {
        "fonte_id": 3,
        "nome": "Tribunal de Justiça de São Paulo",
        "tipo": "TRIBUNAL",
        "sigla": "TJSP",
        "grau": 1,
        "grau_formatado": "Primeiro Grau"
      }
    },
    {
      "id": 849990,
      "data": "2018-04-26",
      "tipo": "ANDAMENTO",
      "conteudo": "EXPEDIDO CERTIDAO",
      "fonte": {
        "fonte_id": 6,
        "nome": "Tribunal de Justiça de São Paulo",
        "tipo": "TRIBUNAL",
        "sigla": "TJSP",
        "grau": 2,
        "grau_formatado": "Segundo Grau"
      }
    },
    {
      "id": 849988,
      "data": "2018-04-26",
      "tipo": "ANDAMENTO",
      "conteudo": "BAIXA DEFINITIVA",
      "fonte": {
        "fonte_id": 6,
        "nome": "Tribunal de Justiça de São Paulo",
        "tipo": "TRIBUNAL",
        "sigla": "TJSP",
        "grau": 2,
        "grau_formatado": "Segundo Grau"
      }
    },
    {
      "id": 849986,
      "data": "2018-04-26",
      "tipo": "ANDAMENTO",
      "conteudo": "EXPEDIDO CERTIDAO DE BAIXA DE RECURSO",
      "fonte": {
        "fonte_id": 6,
        "nome": "Tribunal de Justiça de São Paulo",
        "tipo": "TRIBUNAL",
        "sigla": "TJSP",
        "grau": 2,
        "grau_formatado": "Segundo Grau"
      }
    },
    {
      "id": 849992,
      "data": "2018-03-28",
      "tipo": "ANDAMENTO",
      "conteudo": "EXPEDIDO CERTIDAO",
      "fonte": {
        "fonte_id": 6,
        "nome": "Tribunal de Justiça de São Paulo",
        "tipo": "TRIBUNAL",
        "sigla": "TJSP",
        "grau": 2,
        "grau_formatado": "Segundo Grau"
      }
    },
    {
      "id": 849994,
      "data": "2018-03-26",
      "tipo": "ANDAMENTO",
      "conteudo": "JULGADO VIRTUALMENTE",
      "fonte": {
        "fonte_id": 6,
        "nome": "Tribunal de Justiça de São Paulo",
        "tipo": "TRIBUNAL",
        "sigla": "TJSP",
        "grau": 2,
        "grau_formatado": "Segundo Grau"
      }
    },
    {
      "id": 849998,
      "data": "2018-03-06",
      "tipo": "ANDAMENTO",
      "conteudo": "EXPEDIDO CERTIDAO",
      "fonte": {
        "fonte_id": 6,
        "nome": "Tribunal de Justiça de São Paulo",
        "tipo": "TRIBUNAL",
        "sigla": "TJSP",
        "grau": 2,
        "grau_formatado": "Segundo Grau"
      }
    },
    {
      "id": 849996,
      "data": "2018-03-06",
      "tipo": "ANDAMENTO",
      "conteudo": "CONCLUSOS PARA O RELATOR (EXPEDIDO TERMO COM CONCLUSAO)",
      "fonte": {
        "fonte_id": 6,
        "nome": "Tribunal de Justiça de São Paulo",
        "tipo": "TRIBUNAL",
        "sigla": "TJSP",
        "grau": 2,
        "grau_formatado": "Segundo Grau"
      }
    }
  ],
  "links": {
    "next": "https://api.escavador.com/api/v2/processos/numero_cnj/1024000-20.2015.8.22.0000/movimentacoes?cursor=eyJkYXRhIjoiMjAxOC0wMy0wNiAwMDowMDowMCIsIm1vdmltZW50YWNhb19pZCI6ODQ5OTk2LCJfcG9pbnRzVG9OZXh0SXRlbXMiOnRydWV9&li=216029777"
  },
  "paginator": {
    "per_page": 20
  }
}

Exemplo de resposta (401):

{
  "error": "Unauthenticated"
}

Exemplo de resposta (402):

{
  "error": "Você não possui saldo em crédito da API."
}

Exemplo de resposta (404):

{
  "error": "NotFound"
}

HTTP Request

GET api/v2/processos/numero_cnj/{numero}/movimentacoes

Headers

Campo Valor
Authorization Bearer {access_token}
X-Requested-With XMLHttpRequest

URI Parameters

Parâmetro Tipo Descrição
numero string Número único do processo. Obrigatório estar no formato de CNJ.
Exemplo: 0000000-00.0000.0.00.0000

Processos do envolvido por Nome ou CPF/CNPJ

Retorna os processos de um envolvido a partir do nome ou CPF/CNPJ.

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

Exemplo de requisição:

curl -X GET -G "https://api.escavador.com/api/v2/envolvido/processos?nome=Tiago+Azevedo+Souza" \
    -H "Authorization: Bearer {access_token}" \
    -H "X-Requested-With: XMLHttpRequest"
const url = new URL("https://api.escavador.com/api/v2/envolvido/processos");

let params = {
    "nome": "Tiago Azevedo Souza",
};

Object.keys(params).forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {access_token}",
    "X-Requested-With": "XMLHttpRequest",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

$client = new \GuzzleHttp\Client();
$response = $client->get("https://api.escavador.com/api/v2/envolvido/processos", [
    'headers' => [
            "Authorization" => "Bearer {access_token}",
            "X-Requested-With" => "XMLHttpRequest",
        ],
    'query' => [
            "nome" => "Tiago Azevedo Souza",
        ],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));
from escavador import *
from escavador.v2 import Processo
config("API_KEY")

response = Processo.por_envolvido(
  nome="Companhia de Aguas do Estado do Parana",
  tribunais=[SiglaTribunal.TJAL, SiglaTribunal.TREBA, SiglaTribunal.TRT15] # opcional
)

// Esse é um exemplo de resposta bem-sucedida.
Exemplo de resposta (200):

{
  "envolvido_encontrado": {
    "nome": "Engenharia e Construcoes Ltda",
    "tipo_pessoa": "JURIDICA",
    "quantidade_processos": 2
  },
  "items": [
    {
      "numero_cnj": "1060225-21.2023.5.56.0002",
      "titulo_polo_ativo": "Joao da Silva",
      "titulo_polo_passivo": "Empresa de Engenharia e outros",
      "ano_inicio": 2023,
      "data_inicio": "2023-03-11",
      "data_ultima_movimentacao": "2023-03-11",
      "quantidade_movimentacoes": 2,
      "fontes_tribunais_estao_arquivadas": false,
      "data_ultima_verificacao": "2023-03-14T19:00:14+00:00",
      "tempo_desde_ultima_verificacao": "há 15 minutos",
      "fontes": [
        {
          "id": 47,
          "processo_fonte_id": 1048903,
          "descricao": "TRT-2 - 1º grau",
          "nome": "Tribunal Regional do Trabalho da 2ª Região",
          "sigla": "TRT-2",
          "tipo": "TRIBUNAL",
          "data_inicio": "2023-03-11",
          "data_ultima_movimentacao": "2023-03-11",
          "segredo_justica": false,
          "arquivado": null,
          "grau": 1,
          "grau_formatado": "Primeiro Grau",
          "fisico": false,
          "sistema": "PJE",
          "capa": {
            "classe": "ACAO TRABALHISTA - RITO ORDINARIO",
            "assunto": "SALARIO POR FORA - INTEGRACAO",
            "assuntos_normalizados": [
              {
                "id": 6870,
                "nome": "Horas Extras",
                "nome_com_pai": "Duração do Trabalho > Horas Extras",
                "path_completo": "DIREITO DO TRABALHO | Direito Individual do Trabalho  | Duração do Trabalho | Horas Extras",
                "bloqueado": false
              },
              {
                "id": 7041,
                "nome": "Salário por Fora - Integração",
                "nome_com_pai": "Salário/Diferença Salarial > Salário por Fora - Integração",
                "path_completo": "DIREITO DO TRABALHO | Direito Individual do Trabalho  | Verbas Remuneratórias, Indenizatórias e Benefícios | Salário/Diferença Salarial | Salário por Fora - Integração",
                "bloqueado": false
              }
            ],
            "assunto_principal_normalizado": {
              "id": 7041,
              "nome": "Salário por Fora - Integração",
              "nome_com_pai": "Salário/Diferença Salarial > Salário por Fora - Integração",
              "path_completo": "DIREITO DO TRABALHO | Direito Individual do Trabalho  | Verbas Remuneratórias, Indenizatórias e Benefícios | Salário/Diferença Salarial | Salário por Fora - Integração",
              "bloqueado": false
            },
            "area": "TRABALHISTA",
            "orgao_julgador": "7ª VARA DO TRABALHO DE SAO PAULO",
            "valor_causa": {
              "valor": "310455.6100",
              "moeda": "R$",
              "valor_formatado": "R$ 310.455,61"
            },
            "data_distribuicao": "2023-03-11",
            "data_arquivamento": null,
            "informacoes_complementares": null
          },
          "url": "https://pje.trt2.jus.br/consultaprocessual/detalhe-processo/10003246720235020007",
          "tribunal": {
            "id": 13,
            "nome": "Tribunal Regional do Trabalho da 2ª Região",
            "sigla": "TRT-2",
            "categoria": null
          },
          "quantidade_movimentacoes": 2,
          "data_ultima_verificacao": "2023-03-14T19:00:14+00:00",
          "envolvidos": [
            {
              "nome": "Joao da Silva",
              "quantidade_processos": 1,
              "tipo_pessoa": "FISICA",
              "advogados": [
                {
                  "nome": "Paulo Roberto de Oliveira",
                  "quantidade_processos": 3,
                  "tipo_pessoa": "FISICA",
                  "prefixo": null,
                  "sufixo": null,
                  "tipo": "ADVOGADO",
                  "tipo_normalizado": "Advogado",
                  "polo": "ADVOGADO",
                  "cpf": "00000000000",
                  "oabs": [
                    {
                      "uf": "SP",
                      "tipo": "ADVOGADO",
                      "numero": 123123
                    }
                  ]
                },
                {
                  "nome": "Daniel Felipe Assis",
                  "quantidade_processos": 8,
                  "tipo_pessoa": "FISICA",
                  "prefixo": null,
                  "sufixo": null,
                  "tipo": "ADVOGADO",
                  "tipo_normalizado": "Advogado",
                  "polo": "ADVOGADO",
                  "oabs": [
                    {
                      "uf": "SP",
                      "tipo": "ADVOGADO",
                      "numero": 123123
                    }
                  ]
                }
              ],
              "prefixo": null,
              "sufixo": null,
              "tipo": "RECLAMANTE",
              "tipo_normalizado": "Reclamante",
              "polo": "ATIVO",
              "cpf": "00000000000"
            },
            {
              "nome": "Empresa de Engenharia e outros",
              "quantidade_processos": 2,
              "tipo_pessoa": "JURIDICA",
              "prefixo": null,
              "sufixo": null,
              "tipo": "RECLAMADO",
              "tipo_normalizado": "Reclamado",
              "polo": "PASSIVO",
              "cnpj": "00000000000000"
            },
            {
              "nome": "Empresa de Construcoes",
              "quantidade_processos": 2,
              "tipo_pessoa": "JURIDICA",
              "prefixo": null,
              "sufixo": null,
              "tipo": "RECLAMADO",
              "tipo_normalizado": "Reclamado",
              "polo": "PASSIVO",
              "cnpj": "00000000000000"
            },
            {
              "nome": "Engenharia e Construcoes Ltda",
              "quantidade_processos": 66,
              "tipo_pessoa": "JURIDICA",
              "prefixo": null,
              "sufixo": null,
              "tipo": "RECLAMADO",
              "tipo_normalizado": "Reclamado",
              "polo": "PASSIVO",
              "cnpj": "00000000000000"
            },
            {
              "nome": "Construtora e Incorporadora Ltda",
              "quantidade_processos": 1,
              "tipo_pessoa": "JURIDICA",
              "prefixo": null,
              "sufixo": null,
              "tipo": "RECLAMADO",
              "tipo_normalizado": "Reclamado",
              "polo": "PASSIVO",
              "cnpj": "00000000000000"
            }
          ]
        }
      ]
    },
    {
      "numero_cnj": "0205615-29.2023.3.12.0026",
      "titulo_polo_ativo": "Maria Almeida Sampaio",
      "titulo_polo_passivo": "Engenharia e Construcoes Ltda",
      "ano_inicio": 2023,
      "data_inicio": "2023-03-10",
      "data_ultima_movimentacao": "2023-03-10",
      "quantidade_movimentacoes": 2,
      "fontes_tribunais_estao_arquivadas": false,
      "data_ultima_verificacao": "2023-03-14T19:00:14+00:00",
      "tempo_desde_ultima_verificacao": "há 15 minutos",
      "fontes": [
        {
          "id": 355,
          "processo_fonte_id": 1048904,
          "descricao": "TRT-20 - 1º grau",
          "nome": "Tribunal Regional do Trabalho da 20ª Região",
          "sigla": "TRT-20",
          "tipo": "TRIBUNAL",
          "data_inicio": "2023-03-10",
          "data_ultima_movimentacao": "2023-03-10",
          "segredo_justica": false,
          "arquivado": null,
          "grau": 1,
          "grau_formatado": "Primeiro Grau",
          "fisico": false,
          "sistema": "PJE",
          "capa": {
            "classe": "ACAO TRABALHISTA - RITO ORDINARIO",
            "assunto": "ISONOMIA/DIFERENCA SALARIAL",
            "assuntos_normalizados": [
              {
                "id": 6793,
                "nome": "isonomia/Diferença Salarial",
                "nome_com_pai": "Enquadramento > isonomia/Diferença Salarial",
                "path_completo": "DIREITO DO TRABALHO | Direito Individual do Trabalho  | Categoria Profissional Especial | Bancários | Enquadramento | isonomia/Diferença Salarial",
                "bloqueado": false
              },
              {
                "id": 6978,
                "nome": "Adicional de Periculosidade",
                "nome_com_pai": "Adicional > Adicional de Periculosidade",
                "path_completo": "DIREITO DO TRABALHO | Direito Individual do Trabalho  | Verbas Remuneratórias, Indenizatórias e Benefícios | Adicional | Adicional de Periculosidade",
                "bloqueado": false
              }
            ],
            "assunto_principal_normalizado": {
              "id": 6793,
              "nome": "isonomia/Diferença Salarial",
              "nome_com_pai": "Enquadramento > isonomia/Diferença Salarial",
              "path_completo": "DIREITO DO TRABALHO | Direito Individual do Trabalho  | Categoria Profissional Especial | Bancários | Enquadramento | isonomia/Diferença Salarial",
              "bloqueado": false
            },
            "area": "TRABALHISTA",
            "orgao_julgador": "2ª VARA DO TRABALHO DE ARACAJU",
            "valor_causa": {
              "valor": "292319.7200",
              "moeda": "R$",
              "valor_formatado": "R$ 292.319,72"
            },
            "data_distribuicao": "2023-03-10",
            "data_arquivamento": null,
            "informacoes_complementares": null
          },
          "url": "https://pje.trt20.jus.br/consultaprocessual/detalhe-processo/00002054020235200002",
          "tribunal": {
            "id": 31,
            "nome": "Tribunal Regional do Trabalho da 20ª Região",
            "sigla": "TRT-20",
            "categoria": null
          },
          "quantidade_movimentacoes": 2,
          "data_ultima_verificacao": "2023-03-14T19:00:14+00:00",
          "envolvidos": [
            {
              "nome": "Maria Almeida Sampaio",
              "quantidade_processos": 1,
              "tipo_pessoa": "FISICA",
              "advogados": [
                {
                  "nome": "Petrucio Silveira",
                  "quantidade_processos": 16,
                  "tipo_pessoa": "FISICA",
                  "prefixo": null,
                  "sufixo": null,
                  "tipo": "ADVOGADO",
                  "tipo_normalizado": "Advogado",
                  "polo": "ADVOGADO",
                  "cpf": "00000000000",
                  "oabs": [
                    {
                      "uf": "SE",
                      "tipo": "ADVOGADO",
                      "numero": 123123
                    }
                  ]
                },
                {
                  "nome": "Kevin Correia Borges",
                  "quantidade_processos": 8,
                  "tipo_pessoa": "FISICA",
                  "prefixo": null,
                  "sufixo": null,
                  "tipo": "ADVOGADO",
                  "tipo_normalizado": "Advogado",
                  "polo": "ADVOGADO",
                  "cpf": "00000000000",
                  "oabs": [
                    {
                      "uf": "SE",
                      "tipo": "ADVOGADO",
                      "numero": 123123
                    }
                  ]
                }
              ],
              "prefixo": null,
              "sufixo": null,
              "tipo": "RECLAMANTE",
              "tipo_normalizado": "Reclamante",
              "polo": "ATIVO",
              "cpf": "00000000000"
            },
            {
              "nome": "Engenharia e Construcoes Ltda",
              "quantidade_processos": 66,
              "tipo_pessoa": "JURIDICA",
              "prefixo": null,
              "sufixo": null,
              "tipo": "RECLAMADO",
              "tipo_normalizado": "Reclamado",
              "polo": "PASSIVO",
              "cnpj": "00000000000000"
            }
          ]
        }
      ]
    }
  ],
  "links": {
    "next": "https://api.escavador.com/api/v2/envolvido/processos?nome=Joao%20da%20Silva&cursor=eyJwcm9jZXNzby5kYXRhX2luaWNpbyI6IjIwMjItMDctMDUgMDA6MDA6MDAiLCJwcm9jZXNzby5pZCI6MTEwNjg3NSwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cnVlfQ&li=216025845"
  },
  "paginator": {
    "per_page": 20
  }
}

Exemplo de resposta (401):

{
  "error": "Unauthenticated"
}

Exemplo de resposta (402):

{
  "error": "Você não possui saldo em crédito da API."
}

Exemplo de resposta (404):

{
  "error": "NotFound"
}

HTTP Request

GET api/v2/envolvido/processos

Headers

Campo Valor
Authorization Bearer {access_token}
X-Requested-With XMLHttpRequest

Query Parameters

Parâmetro Status Descrição
nome opcional Nome do envolvido. Obrigatório se cpf_cnpj não for enviado.
cpf_cnpj opcional CPF/CNPJ do envolvido. Obrigatório se nome não for enviado.
ordem opcional Ordem dos items na resposta com base na data de início do processo. Pode ser asc ou desc
Default: desc.
limit opcional Quantidade de processos por página. Pode ser 50 ou 100.
tribunais[] opcional Filtra processos a partir das siglas de tribunais enviadas.
incluir_homonimos opcional Inclui processos de envolvidos do mesmo nome que não identificamos o CPF. Disponível apenas para busca por CPF
Default: false.
status opcional Filtra processos a partir do status do processo, pode ser ATIVO ou INATIVO. Obs. A classificação do status é feito por IA e vai considerar a última atualização que possuímos do processo na nossa base.
data_minima opcional Filtra processos que iniciaram após a data informada. A data deve ser estar no formato AAAA-MM-DD.
data_maxima opcional Filtra processos que iniciaram antes da data informada. A data deve ser estar no formato AAAA-MM-DD e, caso a data minima seja enviada, deve ser maior que a data minima.

Resumo de Processos do envolvido por Nome ou CPF/CNPJ

Retorna a quantidade de processos de um envolvido a partir do nome ou CPF/CNPJ.

Exemplo de requisição:

curl -X GET -G "https://api.escavador.com/api/v2/envolvido/resumo?nome=Empresa+Fantasia+SA" \
    -H "Authorization: Bearer {access_token}" \
    -H "X-Requested-With: XMLHttpRequest"
const url = new URL("https://api.escavador.com/api/v2/envolvido/resumo");

let params = {
    "nome": "Empresa Fantasia SA",
};

Object.keys(params).forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {access_token}",
    "X-Requested-With": "XMLHttpRequest",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

$client = new \GuzzleHttp\Client();
$response = $client->get("https://api.escavador.com/api/v2/envolvido/resumo", [
    'headers' => [
            "Authorization" => "Bearer {access_token}",
            "X-Requested-With" => "XMLHttpRequest",
        ],
    'query' => [
            "nome" => "Empresa Fantasia SA",
        ],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.escavador.com/api/v2/envolvido/resumo'

params = {
  'nome': 'Empresa Fantasia SA'
}

headers = {
  'Authorization': 'Bearer {access_token}',
  'X-Requested-With': 'XMLHttpRequest'
}

response = requests.request('GET', url, headers=headers, params=params)
parsed = json.loads(response.text)
print(json.dumps(parsed, indent=4))

// Esse é um exemplo de resposta bem-sucedida.
Exemplo de resposta (200):

{
  "nome": "Empresa Fantasia S.A",
  "tipo_pessoa": "JURIDICA",
  "quantidade_processos": 3516803
}

Exemplo de resposta (401):

{
  "error": "Unauthenticated"
}

Exemplo de resposta (404):

{
  "error": "NotFound"
}

HTTP Request

GET api/v2/envolvido/resumo

Headers

Campo Valor
Authorization Bearer {access_token}
X-Requested-With XMLHttpRequest

Query Parameters

Parâmetro Status Descrição
nome opcional Nome do envolvido. Obrigatório se cpf_cnpj não for enviado.
cpf_cnpj opcional CPF/CNPJ do envolvido. Obrigatório se nome não for enviado.

Processos de um advogado por OAB

Retorna os processos de um advogado a partir da OAB

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

Exemplo de requisição:

curl -X GET -G "https://api.escavador.com/api/v2/advogado/processos?oab_estado=SP&oab_numero=123456" \
    -H "Authorization: Bearer {access_token}" \
    -H "X-Requested-With: XMLHttpRequest"
const url = new URL("https://api.escavador.com/api/v2/advogado/processos");

let params = {
    "oab_estado": "SP",
    "oab_numero": "123456",
};

Object.keys(params).forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {access_token}",
    "X-Requested-With": "XMLHttpRequest",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

$client = new \GuzzleHttp\Client();
$response = $client->get("https://api.escavador.com/api/v2/advogado/processos", [
    'headers' => [
            "Authorization" => "Bearer {access_token}",
            "X-Requested-With" => "XMLHttpRequest",
        ],
    'query' => [
            "oab_estado" => "SP",
            "oab_numero" => "123456",
        ],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));
from escavador import *
from escavador.v2 import Processo
config("API_KEY")

response = Processo.por_oab(
  numero="123456", # também pode ser int
  estado="AC"
)

// Esse é um exemplo de resposta bem-sucedida.
Exemplo de resposta (200):

{
  "advogado_encontrado": {
    "nome": "JOÃO DA SILVA",
    "tipo": "ADVOGADO",
    "quantidade_processos": 521
  },
  "items": [
    {
      "numero_cnj": "0000000-00.2022.2.03.0000",
      "titulo_polo_ativo": "Marcio Castro Chagas",
      "titulo_polo_passivo": "Mauro Emerson Gomes",
      "ano_inicio": 2022,
      "data_inicio": "2023-02-10",
      "data_ultima_movimentacao": "2023-02-10",
      "quantidade_movimentacoes": 1,
      "fontes_tribunais_estao_arquivadas": false,
      "data_ultima_verificacao": "2023-03-14T18:06:59+00:00",
      "tempo_desde_ultima_verificacao": "há 2 horas",
      "fontes": [
        {
          "id": 1104,
          "processo_fonte_id": 1125512,
          "descricao": "TSE - 3º grau",
          "nome": "Tribunal Superior Eleitoral",
          "sigla": "TSE",
          "tipo": "TRIBUNAL",
          "data_inicio": "2023-02-10",
          "data_ultima_movimentacao": "2023-02-10",
          "segredo_justica": false,
          "arquivado": null,
          "grau": 3,
          "grau_formatado": "Superior",
          "fisico": false,
          "sistema": "UNIFICADO",
          "capa": {
            "classe": "RECURSO ESPECIAL ELEITORAL",
            "assunto": "DIREITO ELEITORAL",
            "assuntos_normalizados": [
              {
                "id": 3388,
                "nome": "Eleições",
                "nome_com_pai": "Conselhos Regionais de Fiscalização Profissional e Afins > Eleições",
                "path_completo": "DIREITO ADMINISTRATIVO E OUTRAS MATÉRIAS DE DIREITO PÚBLICO | Organização Político-administrativa / Administração Pública | Conselhos Regionais de Fiscalização Profissional e Afins | Eleições",
                "bloqueado": false
              },
              {
                "id": 3935,
                "nome": "Propaganda eleitoral",
                "nome_com_pai": "Campanha Eleitoral > Propaganda eleitoral",
                "path_completo": "DIREITO ELEITORAL E PROCESSO ELEITORAL DO STF | Eleição | Campanha Eleitoral | Propaganda eleitoral",
                "bloqueado": false
              },
              {
                "id": 4564,
                "nome": "DIREITO ELEITORAL",
                "nome_com_pai": "DIREITO ELEITORAL",
                "path_completo": "DIREITO ELEITORAL",
                "bloqueado": false
              },
              {
                "id": 4717,
                "nome": "Eleições",
                "nome_com_pai": "DIREITO ELEITORAL > Eleições",
                "path_completo": "DIREITO ELEITORAL | Eleições",
                "bloqueado": false
              },
              {
                "id": 4904,
                "nome": "Propaganda Política",
                "nome_com_pai": "Partidos Políticos > Propaganda Política",
                "path_completo": "DIREITO ELEITORAL | Partidos Políticos | Propaganda Política",
                "bloqueado": false
              },
              {
                "id": 5770,
                "nome": "Propaganda Política - Propaganda Eleitoral - Impulsionamento",
                "nome_com_pai": "Propaganda Política - Propaganda Eleitoral > Propaganda Política - Propaganda Eleitoral - Impulsionamento",
                "path_completo": "DIREITO ELEITORAL | Eleições | Propaganda Política - Propaganda Eleitoral | Propaganda Política - Propaganda Eleitoral - Impulsionamento",
                "bloqueado": false
              }
            ],
            "assunto_principal_normalizado": {
              "id": 4564,
              "nome": "DIREITO ELEITORAL",
              "nome_com_pai": "DIREITO ELEITORAL",
              "path_completo": "DIREITO ELEITORAL",
              "bloqueado": false
            },
            "area": null,
            "orgao_julgador": "MINISTRO JOÃO",
            "valor_causa": {
              "valor": null,
              "moeda": null,
              "valor_formatado": null
            },
            "data_distribuicao": "2023-02-10",
            "data_arquivamento": null,
            "informacoes_complementares": null
          },
          "url": "https://consultaunificadapje.tse.jus.br/#/public/resultado/0000000-00.2022.2.03.0000",
          "tribunal": {
            "id": 36,
            "nome": "Tribunal Superior Eleitoral",
            "sigla": "TSE",
            "categoria": null
          },
          "quantidade_movimentacoes": 1,
          "data_ultima_verificacao": "2023-03-14T18:06:59+00:00",
          "envolvidos": [
            {
              "nome": "Marcio Castro Chagas",
              "quantidade_processos": 1,
              "tipo_pessoa": null,
              "advogados": [
                {
                  "nome": "João Paulo de Silva",
                  "quantidade_processos": 5,
                  "tipo_pessoa": "FISICA",
                  "prefixo": null,
                  "sufixo": null,
                  "tipo": "ADVOGADO",
                  "tipo_normalizado": "Advogado",
                  "polo": "ADVOGADO",
                  "cpf": "00000000000",
                  "oabs": [
                    {
                      "uf": "CE",
                      "tipo": "ADVOGADO",
                      "numero": 123023
                    }
                  ]
                }
              ],
              "prefixo": null,
              "sufixo": null,
              "tipo": "AUTOR",
              "tipo_normalizado": "Autor",
              "polo": "ATIVO"
            },
            {
              "nome": "Mauro Emerson Gomes",
              "quantidade_processos": 1,
              "tipo_pessoa": "JURIDICA",
              "advogados": [
                {
                  "nome": "Roberta dos Santos Conceição",
                  "quantidade_processos": 49,
                  "tipo_pessoa": "FISICA",
                  "prefixo": null,
                  "sufixo": null,
                  "tipo": "ADVOGADO",
                  "tipo_normalizado": "Advogado",
                  "polo": "ADVOGADO",
                  "cpf": "00000000000",
                  "oabs": [
                    {
                      "uf": "CE",
                      "tipo": "ADVOGADO",
                      "numero": 123123
                    }
                  ]
                },
                {
                  "nome": "Luiz Carlos Silveira",
                  "quantidade_processos": 31,
                  "tipo_pessoa": "JURIDICA",
                  "prefixo": null,
                  "sufixo": null,
                  "tipo": "ADVOGADO",
                  "tipo_normalizado": "Advogado",
                  "polo": "ADVOGADO",
                  "oabs": [
                    {
                      "uf": "CE",
                      "tipo": "ADVOGADO",
                      "numero": 123123
                    }
                  ]
                }
              ],
              "prefixo": null,
              "sufixo": null,
              "tipo": "REU",
              "tipo_normalizado": "Réu",
              "polo": "PASSIVO"
            },
            {
              "nome": "Rede Servicos Online do Brasil Ltda",
              "quantidade_processos": 10996,
              "tipo_pessoa": "JURIDICA",
              "advogados": [
                {
                  "nome": "Joana D'Arc de Souza",
                  "quantidade_processos": 101,
                  "tipo_pessoa": "FISICA",
                  "prefixo": null,
                  "sufixo": null,
                  "tipo": "ADVOGADO",
                  "tipo_normalizado": "Advogado",
                  "polo": "ADVOGADO",
                  "cpf": "00000000000",
                  "oabs": [
                    {
                      "uf": "SP",
                      "tipo": "ADVOGADO",
                      "numero": 123123
                    }
                  ]
                }
              ],
              "prefixo": null,
              "sufixo": null,
              "tipo": "REU",
              "tipo_normalizado": "Réu",
              "polo": "PASSIVO",
              "cnpj": "00000000000000"
            }
          ]
        }
      ]
    }
  ],
  "links": {
    "next": "https://api.escavador.com/api/v2/advogado/processos?oab_estado=SP&oab_numero=123123&cursor=eyJwcm9jZXNzby5kYXRhX2luaWNpbyI6IjIwMjEtMDEtMTkgMDA6MDA6MDAiLCJwcm9jZXNzby5pZCI6MTEwNzI0NCwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cnVlfQ&li=216038277"
  },
  "paginator": {
    "per_page": 20
  }
}

Exemplo de resposta (401):

{
  "error": "Unauthenticated"
}

Exemplo de resposta (402):

{
  "error": "Você não possui saldo em crédito da API."
}

Exemplo de resposta (404):

{
  "error": "NotFound"
}

HTTP Request

GET api/v2/advogado/processos

Headers

Campo Valor
Authorization Bearer {access_token}
X-Requested-With XMLHttpRequest

Query Parameters

Parâmetro Status Descrição
oab_estado obrigatório Estado da OAB.
oab_numero obrigatório Número da OAB. Máximo de 6 dígitos
oab_tipo opcional Tipo da OAB, pode ser informado caso o mesmo número exista para diferentes tipos. Pode ser ADVOGADO, SUPLEMENTAR, ESTAGIARIO ou CONSULTOR_ESTRANGEIRO.
ordem opcional Ordem dos items na resposta com base na data de início do processo. Pode ser asc ou desc
Default: desc.
tribunais[] opcional Filtra processos a partir das siglas de tribunais enviadas.
status opcional Filtra processos a partir do status do processo, pode ser ATIVO ou INATIVO. Obs. A classificação do status é feito por IA e vai considerar a última atualização que possuímos do processo na nossa base.
data_minima opcional Filtra processos que iniciaram após a data informada. A data deve ser estar no formato AAAA-MM-DD.
data_maxima opcional Filtra processos que iniciaram antes da data informada. A data deve ser estar no formato AAAA-MM-DD e, caso a data minima seja enviada, deve ser maior que a data minima.

Resumo de processos do advogado por OAB

Retorna um resumo do advogado a partir do oab, mostrando a quantidade de processos e o tipo da oab informada

Exemplo de requisição:

curl -X GET -G "https://api.escavador.com/api/v2/advogado/resumo?oab_estado=SP&oab_numero=123456" \
    -H "Authorization: Bearer {access_token}" \
    -H "X-Requested-With: XMLHttpRequest"
const url = new URL("https://api.escavador.com/api/v2/advogado/resumo");

let params = {
    "oab_estado": "SP",
    "oab_numero": "123456",
};

Object.keys(params).forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {access_token}",
    "X-Requested-With": "XMLHttpRequest",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

$client = new \GuzzleHttp\Client();
$response = $client->get("https://api.escavador.com/api/v2/advogado/resumo", [
    'headers' => [
            "Authorization" => "Bearer {access_token}",
            "X-Requested-With" => "XMLHttpRequest",
        ],
    'query' => [
            "oab_estado" => "SP",
            "oab_numero" => "123456",
        ],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.escavador.com/api/v2/advogado/resumo'

params = {
  'oab_estado': 'SP',
  'oab_numero': '123456'
}

headers = {
  'Authorization': 'Bearer {access_token}',
  'X-Requested-With': 'XMLHttpRequest'
}

response = requests.request('GET', url, headers=headers, params=params)
parsed = json.loads(response.text)
print(json.dumps(parsed, indent=4))

// Esse é um exemplo de resposta bem-sucedida.
Exemplo de resposta (200):

{
  "nome": "Fulano da Silva",
  "tipo": "ADVOGADO",
  "quantidade_processos": 153
}

Exemplo de resposta (401):

{
  "error": "Unauthenticated"
}

Exemplo de resposta (404):

{
  "error": "NotFound"
}

HTTP Request

GET api/v2/advogado/resumo

Headers

Campo Valor
Authorization Bearer {access_token}
X-Requested-With XMLHttpRequest

Query Parameters

Parâmetro Status Descrição
oab_estado obrigatório Estado da OAB.
oab_numero obrigatório Número da OAB. Máximo de 6 dígitos
oab_tipo opcional Tipo da OAB, pode ser informado caso o mesmo número exista para diferentes tipos. Pode ser ADVOGADO, SUPLEMENTAR, ESTAGIARIO ou CONSULTOR_ESTRANGEIRO.

Monitoramento de novos processos

Criar novo monitoramento

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

Exemplo de requisição:

curl -X POST "https://api.escavador.com/api/v2/monitoramentos/novos-processos" \
    -H "Authorization: Bearer {access_token}" \
    -H "X-Requested-With: XMLHttpRequest" \
    -H "Content-Type: application/json" \
    -d '{"termo":"Jo\u00e3o","variacoes":["Jo\u00e3o","Jo\u00e3ozinho"],"termos_auxiliares":[{"condicao":"CONTEM","termo":"Maria"},{"condicao":"NAO_CONTEM","termo":"Jo\u00e3o"},{"condicao":"CONTEM_ALGUMA","termo":"Jos\u00e9"}],"tribunais":["TJSP","TJMG"]}'
const url = new URL("https://api.escavador.com/api/v2/monitoramentos/novos-processos");

let headers = {
    "Authorization": "Bearer {access_token}",
    "X-Requested-With": "XMLHttpRequest",
    "Content-Type": "application/json",
    "Accept": "application/json",
}

let body = {
    "termo": "Jo\u00e3o",
    "variacoes": [
        "Jo\u00e3o",
        "Jo\u00e3ozinho"
    ],
    "termos_auxiliares": [
        {
            "condicao": "CONTEM",
            "termo": "Maria"
        },
        {
            "condicao": "NAO_CONTEM",
            "termo": "Jo\u00e3o"
        },
        {
            "condicao": "CONTEM_ALGUMA",
            "termo": "Jos\u00e9"
        }
    ],
    "tribunais": [
        "TJSP",
        "TJMG"
    ]
}

fetch(url, {
    method: "POST",
    headers: headers,
    body: JSON.stringify(body)
})
    .then(response => response.json())
    .then(json => console.log(json));

$client = new \GuzzleHttp\Client();
$response = $client->post("https://api.escavador.com/api/v2/monitoramentos/novos-processos", [
    'headers' => [
            "Authorization" => "Bearer {access_token}",
            "X-Requested-With" => "XMLHttpRequest",
            "Content-Type" => "application/json",
        ],
    'json' => [
            "termo" => "João",
            "variacoes" => ['João', 'Joãozinho'],
            "termos_auxiliares" => [['condicao' => 'CONTEM', 'termo' => 'Maria'], ['condicao' => 'NAO_CONTEM', 'termo' => 'João'], ['condicao' => 'CONTEM_ALGUMA', 'termo' => 'José']],
            "tribunais" => ['TJSP', 'TJMG'],
        ],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.escavador.com/api/v2/monitoramentos/novos-processos'

payload = {
  'termo': 'João',
  'variacoes': ["Jo\u00e3o","Jo\u00e3ozinho"],
  'termos_auxiliares': [{"condicao":"CONTEM","termo":"Maria"},{"condicao":"NAO_CONTEM","termo":"Jo\u00e3o"},{"condicao":"CONTEM_ALGUMA","termo":"Jos\u00e9"}],
  'tribunais': ["TJSP","TJMG"]
}

headers = {
  'Authorization': 'Bearer {access_token}',
  'X-Requested-With': 'XMLHttpRequest',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
parsed = json.loads(response.text)
print(json.dumps(parsed, indent=4))

// Esse é um exemplo de resposta bem-sucedida.
Exemplo de resposta (200):

{
  "id": 112,
  "termo": "Fulano de tal",
  "tipo": "TERMO",
  "criado_em": "2023-11-23 18:15:13"
}

// Esse é um exemplo de monitoramento com variacoes.
Exemplo de resposta (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.
Exemplo de resposta (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.
Exemplo de resposta (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"
    ]
  }
}

Exemplo de resposta (401):

{
  "error": "Unauthenticated"
}

Exemplo de resposta (402):

{
  "error": "Você não possui saldo em crédito da API."
}

Exemplo de resposta (404):

{
  "error": "NotFound"
}

HTTP Request

POST api/v2/monitoramentos/novos-processos

Headers

Campo Valor
Authorization Bearer {access_token}
X-Requested-With XMLHttpRequest
Content-Type application/json

Body Parameters

Parâmetro Tipo Status Descrição
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 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 string[][] opcional Lista de termos 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 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.

Listar todos os monitoramentos

Retorna todos os monitoramentos de novos processos do usuário

Exemplo de requisição:

curl -X GET -G "https://api.escavador.com/api/v2/monitoramentos/novos-processos" \
    -H "Authorization: Bearer {access_token}" \
    -H "X-Requested-With: XMLHttpRequest"
const url = new URL("https://api.escavador.com/api/v2/monitoramentos/novos-processos");

let headers = {
    "Authorization": "Bearer {access_token}",
    "X-Requested-With": "XMLHttpRequest",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

$client = new \GuzzleHttp\Client();
$response = $client->get("https://api.escavador.com/api/v2/monitoramentos/novos-processos", [
    'headers' => [
            "Authorization" => "Bearer {access_token}",
            "X-Requested-With" => "XMLHttpRequest",
        ],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.escavador.com/api/v2/monitoramentos/novos-processos'

headers = {
  'Authorization': 'Bearer {access_token}',
  'X-Requested-With': 'XMLHttpRequest'
}

response = requests.request('GET', url, headers=headers)
parsed = json.loads(response.text)
print(json.dumps(parsed, indent=4))

// Esse é um exemplo de resposta bem-sucedida.
Exemplo de resposta (200):

{
  "items": [
    {
      "id": 103,
      "termo": "EMPRESA SA",
      "tipo": "TERMO",
      "alertar_apenas_novo_processo": true,
      "criado_em": "2023-11-22 22:13:43"
    },
    {
      "id": 111,
      "termo": "Fulano",
      "tipo": "TERMO",
      "alertar_apenas_novo_processo": true,
      "criado_em": "2023-11-23 18:12:12"
    },
    {
      "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"
        ]
      }
    }
  ]
}

Exemplo de resposta (401):

{
  "error": "Unauthenticated"
}

Exemplo de resposta (402):

{
  "error": "Você não possui saldo em crédito da API."
}

Exemplo de resposta (404):

{
  "error": "NotFound"
}

HTTP Request

GET api/v2/monitoramentos/novos-processos

Headers

Campo Valor
Authorization Bearer {access_token}
X-Requested-With XMLHttpRequest

Retornar um monitoramento específico

Retorna um monitoramento de novos processos a partir do id

Exemplo de requisição:

curl -X GET -G "https://api.escavador.com/api/v2/monitoramentos/novos-processos/1" \
    -H "Authorization: Bearer {access_token}" \
    -H "X-Requested-With: XMLHttpRequest"
const url = new URL("https://api.escavador.com/api/v2/monitoramentos/novos-processos/1");

let headers = {
    "Authorization": "Bearer {access_token}",
    "X-Requested-With": "XMLHttpRequest",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

$client = new \GuzzleHttp\Client();
$response = $client->get("https://api.escavador.com/api/v2/monitoramentos/novos-processos/1", [
    'headers' => [
            "Authorization" => "Bearer {access_token}",
            "X-Requested-With" => "XMLHttpRequest",
        ],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.escavador.com/api/v2/monitoramentos/novos-processos/1'

headers = {
  'Authorization': 'Bearer {access_token}',
  'X-Requested-With': 'XMLHttpRequest'
}

response = requests.request('GET', url, headers=headers)
parsed = json.loads(response.text)
print(json.dumps(parsed, indent=4))

// Esse é um exemplo de resposta bem-sucedida.
Exemplo de resposta (200):

{
  "id": 112,
  "termo": "Fulano de tal",
  "tipo": "TERMO",
  "criado_em": "2023-11-23 18:15:13"
}

// Esse é um exemplo de monitoramento com variacoes.
Exemplo de resposta (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.
Exemplo de resposta (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.
Exemplo de resposta (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"
    ]
  }
}

Exemplo de resposta (401):

{
  "error": "Unauthenticated"
}

Exemplo de resposta (402):

{
  "error": "Você não possui saldo em crédito da API."
}

Exemplo de resposta (404):

{
  "error": "NotFound"
}

HTTP Request

GET api/v2/monitoramentos/novos-processos/{id}

Headers

Campo Valor
Authorization Bearer {access_token}
X-Requested-With XMLHttpRequest

URI Parameters

Parâmetro Tipo Descrição
id integer required Id do monitoramento.

Remover um monitoramento

Remove um monitoramento de novos processos a partir do id

Exemplo de requisição:

curl -X DELETE "https://api.escavador.com/api/v2/monitoramentos/novos-processos/1" \
    -H "Authorization: Bearer {access_token}" \
    -H "X-Requested-With: XMLHttpRequest"
const url = new URL("https://api.escavador.com/api/v2/monitoramentos/novos-processos/1");

let headers = {
    "Authorization": "Bearer {access_token}",
    "X-Requested-With": "XMLHttpRequest",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "DELETE",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

$client = new \GuzzleHttp\Client();
$response = $client->delete("https://api.escavador.com/api/v2/monitoramentos/novos-processos/1", [
    'headers' => [
            "Authorization" => "Bearer {access_token}",
            "X-Requested-With" => "XMLHttpRequest",
        ],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://api.escavador.com/api/v2/monitoramentos/novos-processos/1'

headers = {
  'Authorization': 'Bearer {access_token}',
  'X-Requested-With': 'XMLHttpRequest'
}

response = requests.request('DELETE', url, headers=headers)
parsed = json.loads(response.text)
print(json.dumps(parsed, indent=4))

Exemplo de resposta (204):

[]

HTTP Request

DELETE api/v2/monitoramentos/novos-processos/{id}

Headers

Campo Valor
Authorization Bearer {access_token}
X-Requested-With XMLHttpRequest

URI Parameters

Parâmetro Tipo Descrição
id integer required Id do monitoramento.

Tribunais

Retornar os Tribunais disponíveis

Retorna a lista de tribunais que são utilizados na V2, utilize essa rota caso queira filtrar os processos por tribunal nas rotas que possuem essa opção.

Exemplo de requisição:

curl -X GET -G "https://api.escavador.com/api/v2/tribunais" \
    -H "Authorization: Bearer {access_token}" \
    -H "X-Requested-With: XMLHttpRequest"
const url = new URL("https://api.escavador.com/api/v2/tribunais");

let headers = {
    "Authorization": "Bearer {access_token}",
    "X-Requested-With": "XMLHttpRequest",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

$client = new \GuzzleHttp\Client();
$response = $client->get("https://api.escavador.com/api/v2/tribunais", [
    'headers' => [
            "Authorization" => "Bearer {access_token}",
            "X-Requested-With" => "XMLHttpRequest",
        ],
]);
$body = $response->getBody();
print_r(json_decode((string) $body));
from escavador import *
from escavador.v2 import Tribunal
config("API_KEY")

response = Tribunal.listar(
  estados=['BA','SP']
)

// Esse é um exemplo de resposta bem-sucedida.
Exemplo de resposta (200):

{
  "items": [
    {
      "nome": "Supremo Tribunal Federal",
      "sigla": "STF",
      "categoria": null,
      "estados": []
    },
    {
      "nome": "Tribunal Regional do Trabalho da 1ª Região",
      "sigla": "TRT-1",
      "categoria": null,
      "estados": [
        {
          "nome": "Rio de Janeiro",
          "sigla": "RJ"
        }
      ]
    },
    {
      "nome": "Tribunal Regional do Trabalho da 2ª Região",
      "sigla": "TRT-2",
      "categoria": null,
      "estados": [
        {
          "nome": "São Paulo",
          "sigla": "SP"
        }
      ]
    },
    {
      "nome": "Tribunal Regional do Trabalho da 3ª Região",
      "sigla": "TRT-3",
      "categoria": null,
      "estados": [
        {
          "nome": "Minas Gerais",
          "sigla": "MG"
        }
      ]
    }
  ]
}

Exemplo de resposta (401):

{
  "error": "Unauthenticated"
}

Exemplo de resposta (402):

{
  "error": "Você não possui saldo em crédito da API."
}

Exemplo de resposta (404):

{
  "error": "NotFound"
}

HTTP Request

GET api/v2/tribunais

Headers

Campo Valor
Authorization Bearer {access_token}
X-Requested-With XMLHttpRequest

Query Parameters

Parâmetro Status Descrição
estados[] opcional Filtra os tribunais de acordo com os estados enviados.

Estrutura das respostas

Introdução

Nesta seção você irá conhecer as estruturas de dados que os retornos de várias chamadas da API V2 do Escavador têm em comum. Entender essas estruturas possibilita saber quando um método projetado para um retorno específico da API pode também ser aplicado ao retorno de outra chamada diferente.

Abaixo, apresentamos cada uma das estruturas de dados e seus campos. Cada campo é descrito pela sua chave, seu significado, seus tipos possíveis, bem como uma indicação se sempre está presente ou pode ser omitido.

Estrutura Error

Resposta da API com sinalização de erro ocorrido.

Campo Tipo Retorno Sempre presente Descrição Exemplo
code string Sim Código único do tipo de erro ocorrido "UNPROCESSABLE_ENTITY"
message string Sim Mensagem de erro "Não foi possível processar a solicitação"
errors object Sim Objeto contendo um detalhamento de cada erro ocorrido {"nome": ["O campo nome é obrigatório quando cpf cnpj não está presente."], "cpf_cnpj": ["O campo cpf cnpj é obrigatório quando nome não está presente."]}
appends null Sim Campo reservado para uso futuro null

Estrutura Processo

Representação de um processo no seu estado atual.

Campo Tipo Retorno Sempre presente Descrição Exemplo
numero_cnj string Sim Número único do processo no padrão CNJ "0000000-00.0000.0.00.0000"
titulo_polo_ativo string / null Sim Nome do polo ativo do processo "Carlos Müller Lacerda da Paixão e outros"
titulo_polo_passivo string / null Sim Nome do polo passivo do processo "Banco do Brasil Investimentos S/A"
ano_inicio integer Sim Ano de início do processo 2019
data_inicio string / null Sim Data de início do processo no formato YYYY-MM-DD "2019-01-01"
data_ultima_movimentacao string Sim Data da última movimentação registrada, no formato YYYY-MM-DD "2019-01-01"
quantidade_movimentacoes integer Sim Quantidade de movimentações registradas 1
fontes_tribunais_estao_arquivadas boolean Sim Indica se todas fontes do tipo "TRIBUNAL" estão arquivadas false
data_ultima_verificacao string Sim Momento da última verificação do processo nas fontes oficiais no formato ISO 8601 "2019-01-01T00:01:23+00:00"
tempo_desde_ultima_verificacao string Sim Tempo decorrido desde a última verificação do processo "há 1 mês"
fontes array[FonteProcesso] Sim Fontes de onde o processo foi extraído [{...}, {...}, ...]

Estrutura ProcessoFonte

Informações de um processo em relação a uma das fontes que foi extraído, tal como os dados desta fonte. Cada processo pode ter várias fontes.

Campo Tipo Retorno Sempre presente Descrição Exemplo
id integer Sim Identificador único dessa fonte no sistema do Escavador 1
processo_fonte_id integer Sim Identificador único do processo naquela fonte dentro do sistema do Escavador 1
descricao string Sim Descrição da fonte "Tribunal de Justiça de Minas Gerais"
nome string Sim Nome da fonte "Tribunal de Justiça de Minas Gerais"
sigla string Sim Sigla da fonte "TJMG"
tipo string Sim Tipo da fonte "TRIBUNAL"
data_inicio string / null Sim Data de início da tramitação do processo naquela fonte, no formato YYYY-MM-DD "2019-01-01"
data_ultima_movimentacao string Sim Data da última movimentação registrada naquela fonte, no formato YYYY-MM-DD "2019-01-01"
segredo_justica boolean / null Sim Indica se o processo está sob segredo de justiça false
arquivado boolean / null Sim Indica se o processo está arquivado false
status_predito string Sim Indica se o processo está ATIVO ou INATIVO ATIVO
grau string Sim Grau da instância do processo nessa fonte 1
grau_formatado string Sim Grau do processo por extenso "Primeiro Grau"
fisico boolean Sim Indica se o processo é físico ou eletrônico false
sistema string Sim Sistema de onde o processo foi extraído "PROJUDI"
url string Sim URL para acessar o processo na fonte, caso existir "https://..."
quantidade_movimentacoes integer Sim Quantidade de movimentações registradas naquela fonte 1
data_ultima_verificacao string Sim Momento da última verificação do processo naquela fonte no formato ISO 8601 "2019-01-01T00:01:23+00:00"
envolvidos **array[Envolvido] Sim Pessoas e instituições envolvidas no processo [{...}, {...}, ...]
capa CapaProcessoTribunal Não Informações da capa do processo, se a fonte for do tipo "TRIBUNAL" {...}
tribunal Tribunal Não Informações do tribunal, se a fonte for do tipo "TRIBUNAL" {...}
caderno string Não Título do caderno do diário oficial onde o processo foi publicado, se a fonte for do tipo "DIARIO_OFICIAL" "Jurisdicional das Comarcas"

Estrutura ProcessoFonteCapa

Contém informações da capa de um processo em uma fonte, quando foi extraído de um tribunal.

Campo Tipo Retorno Sempre presente Descrição Exemplo
classe string Sim Classe do processo "Procedimento Comum"
assunto string / null Sim Assunto do processo "Responsabilidade Civil"
assuntos_normalizados array[Assunto] Sim Assuntos do processo [{...}, {...}, ...]
assunto_principal_normalizado Assunto / null Sim Principal assunto do processo {...}
area string / null Sim Área do processo "Cível"
orgao_julgador string / null Sim Órgão responsável por julgar o processo "1ª Vara Cível"
valor_causa ValorCausa / null Sim Valor monetário da causa do processo {...}
data_distribuicao string / null Sim Data de distribuição do processo, no formato YYYY-MM-DD "2019-01-01"
data_arquivamento string / null Sim Data de arquivamento do processo, no formato YYYY-MM-DD "2019-01-01"
informacoes_complementares array[InformacaoComplementar] / null Sim Informações complementares [{...}, {...}, ...]

Estrutura ValorCausa

Representa o valor monetário da causa de um processo.

Campo Tipo Retorno Sempre presente Descrição Exemplo
valor string Sim Valor monetário da causa do processo, como string que contém um float 12345.6789
moeda string Sim Moeda da causa do processo "R$"
valor_formatado string Sim Valor monetário da causa do processo, formatado "R$ 12.345,68"

Estrutura InformacaoComplementar

Representação chave-valor para informações não-fundamentais de um processo.

Campo Tipo Retorno Sempre presente Descrição Exemplo
tipo string Sim Tipo ou significado da informação "Juiz"
valor string Sim Valor da informação "José da Silva"

Estrutura Assunto

Representa um assunto de que se trata um processo.

Campo Tipo Retorno Sempre presente Descrição Exemplo
id integer Sim Identificador único do assunto no sistema do Escavador 1
nome string Sim Descrição do assunto em específico "Obrigação de Fazer / Não Fazer"
nome_com_pai string Sim Descrição do assunto e seu pai (mais genérico) "Liquidação / Cumprimento / Execução > Obrigação de Fazer / Não Fazer"
path_completo string Sim Path completo do assunto, desde a raiz menos específica até o assunto em específico "DIREITO PROCESSUAL CIVIL E DO TRABALHO > Liquidação / Cumprimento / Execução > Obrigação de Fazer / Não Fazer"

Estrutura Movimentação

Representação de uma movimentação de um processo.

Campo Tipo Retorno Sempre presente Descrição Exemplo
id integer Sim Identificador único da movimentação no sistema do Escavador 12345678
data string Sim Dia em que ocorreu, no formato YYYY-MM-DD "2019-01-01"
tipo string Sim Indica se a movimentação representa uma publicação ou andamento do processo "PUBLICAÇÃO"
conteudo string Sim Conteúdo da movimentação "Distribuído em 01/01/2019 para: Tribunal Pleno"
fonte FonteMovimentacao Sim Fonte da movimentação {...}

Estrutura MovimentacaoFonte

Representação da fonte da qual uma movimentação foi extraída, e informações da movimentação em relação a esta fonte.

Campo Tipo Retorno Sempre presente Descrição Exemplo
fonte_id integer Sim Identificador único da fonte no sistema do Escavador 123
nome string Sim Nome completo da fonte "Tribunal de Justiça do Estado de São Paulo"
tipo string Sim Tipo da fonte (TRIBUNAL ou DIARIO_OFICIAL) "TRIBUNAL"
sigla string Sim Sigla da fonte "TJSP"
grau integer Sim Grau do processo no momento da movimentação naquela fonte 1
grau_formatado string Sim Grau do processo no momento da movimentação naquela fonte, formatado "Primeiro Grau"
caderno string / null Não Título do caderno do diário oficial onde a movimentação foi publicada, se a fonte for do tipo "DIARIO_OFICIAL" "Jurisdicional das Comarcas"

Estrutura Envolvido

Representa as informações de um envolvido no contexto de um processo.

Campo Tipo Retorno Sempre presente Descrição Exemplo
nome string / null Sim Nome do envolvido "José da Silva"
quantidade_processos integer Sim Quantidade de processos em que o envolvido é parte 1
tipo_pessoa string Sim Indica se é pessoa física ou jurídica "FISICA"
prefixo string / null Sim Prefixo do envolvido, se tiver "Dr."
sufixo string / null Sim Sufixo do envolvido, se tiver "- Foragido"
tipo string / null Sim Tipo do envolvido naquele processo "Relator"
tipo_normalizado string / null Sim "Juiz"
polo string / null Sim O polo do envolvido naquele processo (ATIVO, PASSIVO, ADVOGADO, etc). "NENHUM"
cpf string / null Não CPF do envolvido, se for pessoa física e este dado existir "12345678900"
cnpj string / null Não CNPJ do envolvido, se for pessoa jurídica e este dado existir "12345678000190"
oabs array[Oab] Não Lista de carteiras da OAB do envolvido, se for advogado [{...}, {...}, ...]
advogados array[Envolvido] Não Lista de advogados do envolvido, se tiver [{...}, {...}, ...]

Estrutura EnvolvidoEncontrado

Informações essenciais de um envolvido encontrado em buscas de processos por envolvido.

Campo Tipo Retorno Sempre presente Descrição Exemplo
nome string Sim Nome do envolvido "Banco do Brasil Exportações S.A"
tipo_pessoa string Sim Indica se é pessoa física ou jurídica "JURIDICA"
quantidade_processos integer Sim Quantidade de processos em que o envolvido é parte 1234

Estrutura Oab

Dados que caracterizam uma carteira da OAB.

Campo Tipo Retorno Sempre presente Descrição Exemplo
numero string Sim Número da carteira "123456"
uf string Sim UF da carteira "SP"
tipo string Sim Tipo da carteira "ADVOGADO"

Estrutura Tribunal

Dados que caracterizam um tribunal.

Campo Tipo Retorno Sempre presente Descrição Exemplo
id integer Sim Id do tribunal 1
nome string Sim Nome do tribunal "Tribunal Superior do Trabalho"
sigla string Sim Sigla do tribunal "TST"
categoria string Sim Categoria do tribunal "Tribunais Superiores e Conselhos"
estados array[Estado] Sim Estados que o tribunal pertence [{...}, {...}, ...]

Estrutura Estado

Dados que caracterizam um Estado.

Campo Tipo Retorno Sempre presente Descrição Exemplo
nome string Sim Nome do estado "Bahia"
sigla string Sim Sigla do estado "BA"

Estrutura StatusAtualizacaoProcesso

Campo Tipo Retorno Sempre presente Descrição Exemplo
numero_cnj string Sim Número do Processo "0000000-00.0000.0.00.0000"
data_ultima_verificacao data Sim Data que o processo foi verificado no Tribunal "2023-03-02T21:31:56+00:00"
tempo_desde_ultima_verificacao data Sim Tempo desde a ultima atualização "há 2 meses"
ultima_verificacao array[BuscaAtualizacaoProcesso] Não Objeto contendo informações da ultima verificação do Processo [{...}, {...}, ...]

Estrutura BuscaAtualizacaoProcesso

Campo Tipo Retorno Sempre presente Descrição Exemplo
numero_cnj string Não Número do Processo "0000000-00.0000.0.00.0000"
id integer Sim id da Busca de atualização 1
status string Sim Status da atualização do processo "PENDENTE"
criado_em data Sim Data que a busca do robô foi inicializada "2023-03-02T21:31:56+00:00"
concluido_em data Sim Data que a busca do robô foi concluída "2023-03-02T21:31:56+00:00"

Detalhes dos Callbacks

Introdução

Callbacks são avisos que o Escavador dispara (Via método POST) para certos eventos que ocorrem em sua conta.

As chamadas são enviadas com content-type application/json.

A URL de callback pode ser cadastrado pelo painel da API.

Para garantir que os callbacks recebidos tem como origem a API do Escavador, você pode gerar um token no painel da API. Esse token será enviado em todos os callbacks pelo header Authorization.

Em caso de ocorrer falha na entrega do webhook na url de callback cadastrada, o Escavador irá tentar enviar novamente mais 10 vezes. Sendo assim, um total de 11 tentativas serão feitas. Cada tentativa tem um intervalo de 2n minutos, sendo n o número da tentativa.

Estes são os eventos e seus respectivos dados enviados:

Monitoramento de novos processos: novo processo encontrado

Ocorre quando um Monitoramento de novos processos encontra algum processo novo.

Campos enviados no callback

Parâmetro Descrição
event novo_processo
monitoramento Informações do Monitoramento.
processo Informações do processo encontrado

POST JSON

{
   "event":"novo_processo",
   "monitoramento":{
      "id":11,
      "termo":"Bruno Souza Cabral",
      "criado_em":"2024-01-18T15:15:08+00:00",
      "variacoes":[],
      "termos_auxiliares":[]
   },
   "processo":{
      "numero_cnj":"0008649-70.2021.8.12.0110",
      "data_inicio":"2021-10-06",
      "tribunal":"TJMS",
      "estado_origem":{
         "nome":"Mato Grosso do Sul",
         "sigla":"MS"
      }
   },
   "uuid":"e774c93cbef5bbaab6bc6707f2609167"
}

Atualização de processos: atualização concluída

Ocorre quando uma atualização de processo é concluída e foi setado para enviar callback.

Campos enviados no callback

Parâmetro Descrição
event atualizacao_processo_concluida
atualizacao.id ID da atualização
atualizacao.status.numero_cnj Status da atualização, pode ser SUCESSO, NAO_ENCONTRADO ou ERRO
atualizacao.numero_cnj Número do CNJ do processo

POST JSON

{
    "event": "atualizacao_processo_concluida",
    "atualizacao": {
        "id": 22,
        "status": "SUCESSO",
        "criado_em": "2024-02-07T17:07:44+00:00",
        "numero_cnj": "0011699-83.2017.5.15.0087",
        "concluido_em": "2024-02-07T17:08:46+00:00",
        "enviar_callback": "SIM"
    },
    "uuid": "65b45990e91de83f8f40483102ce97ca"
}