Consulta Customizada
Essa página tem como objetivo mostrar o fluxo de Consulta customizada.
A consulta customizada permite realizar buscas utilizando filtros específicos, sem a necessidade de ter um cpf, cnpj, oab ou nome como input inicial. Retornamos processos de todos os tribunais que correspondem aos critérios definidos. Essa consulta é ideal para identificar processos com características específicas em um amplo espectro de jurisdições. Para utilizá-la, é necessário enviar uma requisição ao endpoint correspondente.
Para este tipo de consulta, certifique-se sobre a precificação, pois não é a mesma da consulta histórica.
Criação de Request
Para realizar a consulta customizada, é necessário primeiramente criar uma requisição para o endpoint de requests.
Filtros poderão ser adicionados à requisição, permitindo um retorno mais assertivo com base nos valores desejados. Para isso, o parâmetro 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 emamount_gte
; -
amount_lte
(opcional): Filtra processos com valor da causa menor ou igual ao especificado emamount_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 emkeys
.
-
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 emkeys
.
-
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 umacustomer_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 deSide
, o filtro deSide
não será considerado para a restrição dessas partes, já que o filtro deSide
é 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 deSide
, o filtro deSide
não será considerado para a restrição desses documentos, já que o filtro deSide
é utilizado para filtrar processos onde a parte principal buscada esteja no lado especificado.
Exemplo da criação da request por nome em nossa base de dados:
A resposta dessa requisição será um objeto JSON com os dados de criação da Request:
Na consulta customizada o search_type deve ser “custom”.
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.
Retorno:
Através da propriedade status é possível saber se a requisição está completa.
Consultar o conteúdo da resposta
Na URL vai o request_id retornado na primeira requisição.
Processo encontrado
Os parâmetro page e page_size são opcionais, porém necessários para percorrer as páginas com os processos, caso venham mais de uma, o que é comum no caso de consulta por nome.
O significado de cada campo pode ser encontrado no glossário: