/requests
.
Rota de Consulta de Processos
Nesta rota, é possível buscar processos (Código CNJ), documentos (CPF ou CNPJ), OAB ou nome. Nesta seção, abordaremos exclusivamente as buscas processuais. Para buscar um processo, você deve realizar uma solicitação POST para a rota/requests
.
Payload da Solicitação
A solicitação POST deve incluir um payload com as seguintes propriedades: search_type: Este campo define o tipo de entidade que será buscada. Os valores possíveis são:cpf
, cnpj
, oab
, name
, lawsuit_cnj
ou lawsuit_id
. Para buscas processuais, utilizaremos especificamente lawsuit_cnj
ou lawsuit_id
, que correspondem ao número do processo.
-
search_key
: O número do processo (Código CNJ), CPF, CNPJ, OAB ou Name que você deseja buscar, para busca processual será sempre o número do processo; -
cache_ttl_in_days
(opcional): Número inteiro que define até quantos dias o resultado da busca pode considerar um cache válido; -
with_attachments
(opcional): Esse campo define se você quer trazer anexos referente ao processo buscado podendo ser true ou false -
search_params
: Um objeto que contém alguns parâmetros da busca como: -lawsuit_instance
(opcional): Este parâmetro permite definir a instância em que deseja buscar o processo; -masked_response
Define se a resposta virá minificada. Este parâmetro é aplicável apenas a consultas (simples ou completas) por documento no contexto de busca processual. - masked_response =true
: retornará uma consulta completa - masked_response =false
: retornará uma consulta simples*Obs
Consulte as condições comerciais desses diferentes tipos de consultas por documento. -
judit-ia
(opcional): Array de strings que define quais análises da Judit IA devem ser aplicadas à consulta. Atualmente, é possível utilizar o valor “summary” para obter um resumo automático do processo retornado na consulta processual.
O parâmetro
with_attachments
determina se a busca incluirá ou não os anexos, conforme o valor booleano especificado.A funcionalidade Judit IA está em versão Beta e ainda se encontra em fase de testes.
Aqui está o exemplo do retorno da criação da sua request feita por cnj
Consultar o status da request
Esta é uma etapa importante para saber quando a consulta terminou,
já que as respostas serão adicionadas de forma incremental por tribunal.
Consultando sua request
Aqui está um exemplo de como consultar suas buscas usando curl de uma requisição através dorequest_id
:
O parâmetro
request_id
é o mesmo gerado na resposta criação da request.Exemplo de response da solicitação GET acima
Aqui está um exemplo da resposta da solicitação:A resposta será um array onde cada objeto corresponde a uma instância.
Verifique o parâmetro
request_status
para garantir que a resposta foi processada com sucesso. O valor deve ser completed. Caso contrário, a solicitação ainda está em processamento.