Baixar Collection

Respostas - Escavador Business API - Documentação

Grupo

Estrutura das respostas

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"
estado_origem Estado Não Objeto com dados do estado de origem do processo {"nome": "Minas Gerais", "sigla": "MG"}
unidade_origem UnidadeOrigem Não Objeto com dados da unidade de origem {...}
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"
processos_relacionados array Não Lista de processos relacionados []
match_documento_por string / null Não Indica como o documento pesquisado deu match com o processo. Valores: DOCUMENTO_TRIBUNAL, NOME_EXATO_UNICO, NOME_ALGORITMO, NOME_EXATO_MUNICIPIO, NOME_EXATO_ESTADO, MESMO_ADVOGADO_OUTRO_PROCESSO, DOCUMENTO_TRIBUNAL_OUTRA_FONTE. Veja o algoritmo de match. null quando não houver match por documento "DOCUMENTO_TRIBUNAL"
fontes array[ProcessoFonte] 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
outros_numeros array Não Lista de outras numerações do processo naquela fonte []
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 / null Sim Indica se o processo está ATIVO ou INATIVO. null se a fonte for do tipo "DIARIO_OFICIAL" 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"
quantidade_envolvidos integer Não Número total de envolvidos naquela fonte específica 4
match_documento_por string / null Não Indica como o documento pesquisado deu match com o processo nesta fonte. Valores: DOCUMENTO_TRIBUNAL, NOME_EXATO_UNICO, NOME_ALGORITMO, NOME_EXATO_MUNICIPIO, NOME_EXATO_ESTADO, MESMO_ADVOGADO_OUTRO_PROCESSO, DOCUMENTO_TRIBUNAL_OUTRA_FONTE. Veja o algoritmo de match. null quando não houver match por documento nesta fonte "DOCUMENTO_TRIBUNAL"
envolvidos **array[Envolvido] Sim Pessoas e instituições envolvidas no processo [{...}, {...}, ...]
capa ProcessoFonteCapa Não Informações da capa do processo, se a fonte for do tipo "TRIBUNAL" {...}
audiencias array Não Lista de audiências marcadas []
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"
situacao string / null Não Situação atual do processo na capa null
orgao_julgador string / null Sim Órgão responsável por julgar o processo "1ª Vara Cível"
orgao_julgador_normatizado UnidadeOrigem / null Não Objeto com dados detalhados do órgão julgador {...}
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"
categoria_raiz string Não Categoria raiz do assunto `"DIREITO CIVIL
bloqueado boolean Não Indica se o assunto está bloqueado false

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 MovimentacaoFonte 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 1T
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"
documento string / null Não CPF ou CNPJ do envolvido, quando disponível para a resposta "00000000000191"
quantidade_processos integer Sim Quantidade de processos vinculados ao envolvido encontrado 1234

Estrutura EstatisticasEnvolvido

Resumo agregado dos processos vinculados ao envolvido encontrado.

Campo Tipo Retorno Sempre presente Descrição Exemplo
envolvido_encontrado EnvolvidoEncontrado Sim Dados do envolvido consultado {...}
indicadores IndicadoresEstatisticasEnvolvido Sim Indicadores objetivos calculados a partir dos processos do envolvido {...}
estatisticas AgregacoesEstatisticasEnvolvido Sim Listas agregadas com os principais agrupamentos dos processos do envolvido {...}

Estrutura IndicadoresEstatisticasEnvolvido

Indicadores objetivos sobre a situação do envolvido e dos processos encontrados.

Campo Tipo Retorno Sempre presente Descrição Exemplo
recuperacao_judicial.encontrada boolean Sim Indica se a empresa está em recuperação judicial no momento da consulta. Esse indicador é diferente de possuir apenas histórico de processo de recuperação judicial. true
segredo_justica.quantidade_processos integer Sim Quantidade de processos encontrados com segredo de justiça 7

Estrutura AgregacoesEstatisticasEnvolvido

Principais agrupamentos dos processos do envolvido. Cada lista é ordenada por quantidade, da maior para a menor. Em agrupamentos por fonte ou assunto, um mesmo processo pode aparecer em mais de uma categoria.

Campo Tipo Retorno Sempre presente Descrição Exemplo
assuntos array[AssuntoEstatisticaEnvolvido] Sim Principais assuntos normalizados dos processos [{...}, {...}, ...]
classes array[ClasseEstatisticaEnvolvido] Sim Principais classes processuais [{...}, {...}, ...]
tribunais array[TribunalEstatisticaEnvolvido] Sim Principais tribunais dos processos [{...}, {...}, ...]
polos array[PoloEstatisticaEnvolvido] Sim Distribuição dos processos por polo do envolvido. Cada processo é contado em apenas um polo [{...}, {...}, ...]
status array[StatusEstatisticaEnvolvido] Sim Distribuição dos processos por status predito [{...}, {...}, ...]
graus array[GrauEstatisticaEnvolvido] Sim Distribuição dos processos por grau/instância. Um processo com fontes em mais de um grau pode ser contado em mais de uma categoria [{...}, {...}, ...]
materias array[MateriaEstatisticaEnvolvido] Sim Principais matérias dos processos, calculadas a partir do assunto raiz, com estatísticas de valor da causa quando conhecidas [{...}, {...}, ...]

Estrutura AssuntoEstatisticaEnvolvido

Campo Tipo Retorno Sempre presente Descrição Exemplo
id integer Sim Identificador único do assunto no sistema do Escavador 1263
nome string Sim Nome do assunto "DIREITO DO TRABALHO"
nome_com_pai string Sim Nome do assunto com seu assunto pai "Horas Extras > Adicional de Horas Extras"
path string / null Sim Caminho completo do assunto "DIREITO DO TRABALHO | Direito Individual do Trabalho"
quantidade_processos integer Sim Quantidade de processos encontrados nesse assunto 12

Estrutura ClasseEstatisticaEnvolvido

Campo Tipo Retorno Sempre presente Descrição Exemplo
nome string Sim Nome da classe processual "Procedimento Comum Civel"
quantidade_processos integer Sim Quantidade de processos encontrados nessa classe 9800

Estrutura TribunalEstatisticaEnvolvido

Campo Tipo Retorno Sempre presente Descrição Exemplo
id integer Sim Identificador único do tribunal no sistema do Escavador 1
sigla string Sim Sigla do tribunal "TJSP"
nome string Sim Nome do tribunal "Tribunal de Justica de Sao Paulo"
quantidade_processos integer Sim Quantidade de processos encontrados nesse tribunal 10500

Estrutura PoloEstatisticaEnvolvido

Campo Tipo Retorno Sempre presente Descrição Exemplo
polo string Sim Polo do envolvido nos processos. Pode ser DESCONHECIDO, ATIVO, PASSIVO, ADVOGADO, NENHUM ou TERCEIRO "PASSIVO"
quantidade_processos integer Sim Quantidade de processos encontrados nesse polo 44394

Estrutura StatusEstatisticaEnvolvido

Campo Tipo Retorno Sempre presente Descrição Exemplo
status string Sim Status predito do processo. Pode ser ATIVO, INATIVO ou DESCONHECIDO "ATIVO"
quantidade_processos integer Sim Quantidade de processos encontrados nesse status 14196

Estrutura GrauEstatisticaEnvolvido

Campo Tipo Retorno Sempre presente Descrição Exemplo
grau integer / null Sim Grau/instância do processo. O valor 3 representa instâncias superiores. null indica grau desconhecido 1
grau_formatado string Sim Grau/instância formatado "Primeiro Grau"
quantidade_processos integer Sim Quantidade de processos encontrados nesse grau 54358

Estrutura MateriaEstatisticaEnvolvido

Campo Tipo Retorno Sempre presente Descrição Exemplo
id integer Sim Identificador do assunto raiz que representa a matéria 1313
area string Sim Nome do assunto raiz que representa a matéria "DIREITO CIVIL"
quantidade_processos integer Sim Quantidade de processos encontrados nessa matéria 18400
valor_total_causa_conhecido number Sim Soma dos valores de causa conhecidos nessa matéria. Quando não há valores conhecidos, retorna 0 18450320.44
quantidade_processos_com_valor integer Sim Quantidade de processos nessa matéria com valor da causa conhecido 91
quantidade_processos_sem_valor integer Sim Quantidade de processos nessa matéria sem valor da causa conhecido 35
maior_valor_causa_conhecido number / null Sim Maior valor da causa conhecido nessa matéria 5200000.00
menor_valor_causa_conhecido number / null Sim Menor valor da causa conhecido nessa matéria 1800.00
valor_medio_causa_quando_conhecido number / null Sim Valor médio da causa considerando apenas processos com valor conhecido 202750.77

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 UnidadeOrigem

Dados que caracterizam uma Unidade Organizacional (Vara, Comarca, Gabinete).

Campo Tipo Retorno Sempre presente Descrição Exemplo
nome string Sim Nome da unidade/órgão "VARA ÚNICA DA COMARCA DE TARUMIRIM"
endereco string Sim Endereço físico da unidade "Av Cunha, 40, Tarumirim/MG"
classificacao string Sim Classificação da unidade "V - Vara"
cidade string Sim Cidade onde a unidade está localizada "Tarumirim"
estado Estado Sim Objeto contendo dados do estado {"nome": "Minas Gerais", "sigla": "MG"}
tribunal_sigla string Sim Sigla do tribunal ao qual a unidade pertence "TJMG"

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"