Essa página tem como objetivo mostrar o fluxo de Consulta por Documento.
Criação de Request
on_demand
deve ser incluído no payload da solicitação com o valor true
.
Esta abordagem garante acesso aos dados mais atualizados, realizando comunicação direto com o tribunal.cpf
, cnpj
, oab
, name
, lawsuit_cnj
ou lawsuit_id
. Para buscas processuais, utilizaremos especificamente cpf
, cnpj
ou oab
, 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;
cache_ttl_in_days
(opcional): Número inteiro que define até quantos dias o resultado da busca pode considerar um cache válido;
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.
filter
deve ser incluído dentro de search_params
, com os seguintes filtros disponíveis:filter
(opcional): Um objeto que contém os filtros para a busca, como:
side
(opcional): Permite buscar por tipos de participantes do processo, podendo ser: ‘Passive’, ‘Active’, ‘Interested’, ‘Unknown’;
amount_gte
(opcional): Filtra processos com valor da causa maior ou igual ao especificado em amount_gte
;
amount_lte
(opcional): Filtra processos com valor da causa menor ou igual ao especificado em amount_lte
;
tribunals
(opcional): Um objeto que contém os filtros de tribunais:
keys
(opcional): Lista de códigos de tribunais disponíveis na lista de tribunais. Este filtro permite restringir a busca a processos que tenham ou não esses códigos específicos;not_equal
(opcional): Valor booleano que define se o filtro incluirá ou excluirá os valores especificados em keys
.subject_codes
(opcional): Um objeto que contém os filtros de assuntos:
contains
(opcional): Lista de códigos de assuntos. Restringe a busca a processos que incluam os códigos especificados.not_contains
(opcional): Lista de códigos de assuntos. Exclui processos que contenham os códigos especificados.classification_codes
(opcional): Um objeto que contém os filtros de classes processuais:
keys
(opcional): Lista de códigos de classes processuais. Este filtro permite restringir a busca a processos que tenham ou não esses códigos específicos;not_equal
(opcional): Valor booleano que define se o filtro incluirá ou excluirá os valores especificados em keys
.distribution_date_gte
(opcional): Permite especificar uma data mínima de distribuição. Este filtro localiza processos distribuídos após a data informada.
credential
(opcional): Objeto para o uso do cofre de credenciais:
customer_key
(opcional): Permite passar a chave do usuário cadastrada no cofre de credenciais. Caso não seja informada, a API tentará encontrar uma credencial cadastrada para uma customer_key
vazia.
last_step_date_gte
(opcional): Restringe a busca a processos cuja data da última movimentação seja maior que à data fornecida.
last_step_date_lte
(opcional): Restringe a busca a processos cuja data da última movimentação seja menor que à data fornecida.
party_names
(opcional): Lista de nomes que restringe a busca a processos que os contenham em alguma das partes.
Obs
Ao utilizar esse filtro em conjunto com o filtro de Side
, o filtro de Side
não será considerado para a restrição dessas partes, já que o filtro de Side
é utilizado para filtrar processos onde a parte principal buscada esteja no lado especificado.
party_documents
(opcional): Lista de documentos que restringe a busca a processos que os contenham em alguma das partes.
Obs
Ao utilizar esse filtro em conjunto com o filtro de Side
, o filtro de Side
não será considerado para a restrição desses documentos, já que o filtro de Side
é utilizado para filtrar processos onde a parte principal buscada esteja no lado especificado.
on_demand
:Consultar o status da request
Consultar o conteúdo da resposta
Processo encontrado
Exemplo de retorno quando o processo foi encontrado em nossa base de dados ou tribunal
Processo não encontrado
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.As propriedades de paginação: