Parâmetros de consulta

A tabela abaixo detalha os campos aceitos na consulta a este dataset.

Campo Descrição Valores Possíveis Tipo de Campo
document Documento de identificação CPF Obrigatório
type Identificador do tipo de consulta ADVANCED, ADDITIONAL_INPUTS Obrigatório
subproducts Array de Slugs dos subprodutos que serão inclusos na busca ["processos-judiciais-e-administrativos-familiares-primeiro-nivel-pf"] Obrigatório

Quando o parâmetro type for definido como ADVANCED, a resposta incluirá os dados da Consulta Básica. Quando definido como ADDITIONAL_INPUTS, a resposta conterá apenas os subprodutos e providers explicitamente informados na requisição.

Corpo da Resposta

Campo	Tipo	Descrição
`ticketId`	`string`	Identificador da consulta
`executadoEm`	`date`	Data e hora da execução da consulta
`status`	`string`	`'Executado'`	`'Executado com exceção'`. Em caso de execução com exceção o campo `exceptions` será preenchido, porém a request retorna sucesso
`resultado`	`object`	Resposta da Consulta Básica
`exceptions`	`array<object>`	Lista de exceções encontradas durante a execução da consulta. Preenchido apenas quando `status = 'Executado com exceção'`

Estrutura de `exceptions`

Campo	Tipo	Descrição
`message`	`string`	Descrição do erro ocorrido. Exemplos: `"Os slugs informados estão inativos."`, `"Os slugs informados não foram encontrados."`
`slugs`	`array<string>`	Lista dos slugs que ocasionaram a exceção

Estrutura de `resultado`

Campo	Tipo	Descrição
processos-judiciais-e-administrativos-familiares-primeiro-nivel-pf	object	Lista com os detalhes do documento consultado

Estrutura de `processos-judiciais-e-administrativos-familiares-primeiro-nivel-pf`

Campo	Tipo	Descrição
name	string	Nome do subproduto consultado
status	integer	Status Code da Requisição
Result	object	Lista com os detalhes da consulta

Estrutura de `Result`

Campo	Tipo	Descrição
FirstLevelRelativesLawsuitsData	object	Processos Judiciais

Estrutura de `FirstLevelRelativesLawsuitsData`

Campo	Tipo	Descrição
DocNumber	string	Número do documento do indivíduo retornado.
RelationshipType	string	Tipo de relacionamento entre o indivíduo retornado e o CPF consultado.
LawsuitsData	object	Objeto com informações detalhadas sobre os processos judiciais e administrativos.

Estrutura de `LawsuitsData`

Campo	Tipo	Descrição
TotalLawsuits	integer	Total de processos para a entidade.
TotalReplacedLawsuits	integer	Total de processos substituídos para a entidade.
TotalLawsuitsAsAuthor	integer	Total de processos como 'autor' para a entidade.
TotalLawsuitsAsDefendant	integer	Total de processos como 'réu' para a entidade.
TotalLawsuitsAsOther	integer	Total de processos como 'outros' para a entidade.
FirstLawsuitDate	string	Data da primeira ocorrência de processo em que a pessoa está envolvida.
LastLawsuitDate	string	Data da última ocorrência de processo em que a pessoa está envolvida.
Last30DaysLawsuits	integer	Número de processos que se iniciaram nos últimos 30 dias.
Last90DaysLawsuits	integer	Número de processos que se iniciaram nos últimos 90 dias.
Last180DaysLawsuits	integer	Número de processos que se iniciaram nos últimos 180 dias.
Last365DaysLawsuits	integer	Número de processos que se iniciaram nos últimos 365 dias.
NumberOfFullNameNamesakes	integer	Indica a quantidade de pessoas de mesmo nome completo.
NextPageId	string	Número de identificação da página seguinte.
Lawsuits	array of objects	Lista de objetos com os detalhes de cada processo aonde a pessoa aparece.

Estrutura de `Lawsuits`

Campo	Tipo	Descrição
Number	string	Número do processo.
Type	string	Tipo do processo.
MainSubject	string	Assunto principal do processo.
CourtName	string	Nome do tribunal do processo.
CourtLevel	string	Nível do tribunal do processo.
CourtType	string	Tipo do tribunal do processo.
CourtDistrict	string	Distrito do tribunal do processo.
Judge	string	Juiz do processo.
JudgingBody	string	Vara do tribunal do processo.
State	string	Estado do processo.
Status	string	Status do processo.
LawsuitHostService	string	Nome do serviço de tramitação onde o processo foi cadastrado.
RelatedLawsuits	array of strings	Processos de alguma forma relacionados ao processo em questão.
InferredCNJSubjectName	string	Nome do Assunto de acordo com as normas do CNJ (campo inferido).
InferredCNJSubjectNumber	integer	Número do Assunto de acordo com as normas do CNJ (campo inferido).
InferredCNJProcedureTypeName	string	Nome do tipo do processo de acordo com as normas do CNJ (campo inferido).
InferredCNJProcedureTypeNumber	integer	Número do tipo do processo de acordo com as normas do CNJ (campo inferido).
InferredBroadCNJSubjectName	string	Nome do assunto principal de acordo com as normas do CNJ (campo inferido).
InferredBroadCNJSubjectNumber	integer	Número do assunto principal de acordo com as normas do CNJ (campo inferido).
OtherSubjects	array of strings	Outros assuntos associados ao processo.
NumberOfVolumes	integer	Número de volumes do processo.
NumberOfPages	integer	Número de páginas do processo.
Value	number	Valor total da causa extraído do processo.
ResJudicataDate	string	Data da Res Judicata do processo.
CloseDate	string	Data de fechamento do processo.
RedistributionDate	string	Data de redistribuição do processo.
PublicationDate	string	Data de publicação do processo.
NoticeDate	string	Data de notificação das partes do processo.
LastMovementDate	string	Data da última movimentação do processo.
CaptureDate	string	Data da captura inicial do processo.
LastUpdate	string	Data da última atualização dos dados.
NumberOfParties	integer	Número de partes envolvidas no processo.
NumberOfUpdates	integer	Número de atualizações do processo.
LawSuitAge	integer	Idade do processo, em dias.
AverageNumberOfUpdatesPerMonth	integer	Média de movimentações por mês do processo.
ReasonForConcealedData	integer	Enumerador para razões para os dados estarem ocultados.
LawsuitMatchType	string	Indica o tipo de chave utilizada para associação com o processo judicial (DOC ou NAME).
Parties	array of objects	Lista de objetos com informações das partes do processo.
Updates	array of objects	Lista de objetos com informações das atualizações do processo.
Petitions	array of objects	Lista de objetos com informações das petições do processo.
Decisions	array of objects	Lista de objetos com informações das decisões do processo.

Estrutura de `Parties`

Campo	Tipo	Descrição
Doc	string	Número do documento (CPF ou CNPJ) da parte.
IsPartyActive	boolean	Indica se a parte continua ativa no processo.
Name	string	Nome da parte descrito no processo.
Polarity	string	Polaridade (ativo, passivo, neutro) da parte no processo.
Type	string	Tipo da parte (réu, autor, advogado, etc...).
IsInference	boolean	Indica se o documento retornado foi calculado por inferência com base no nome da parte do processo.
PartyDetails	object	Detalhes adicionais sobre a parte, tais como o número da OAB (para advogados).
LastCaptureDate	string	Data da última vez que a parte foi capturada em associação a esse processo.

Estrutura de `Updates`

Campo	Tipo	Descrição
Content	string	Conteúdo (texto) da atualização.
PublishDate	string	Data de publicação da atualização.
CaptureDate	string	Data de captura da atualização.

Estrutura de `Petitions`

Campo	Tipo	Descrição
Type	string	Tipo da petição.
Author	string	Autor da petição.
CreationDate	string	Data de criação da petição.
JoinedDate	string	Data em que a petição foi juntada ao processo.

Estrutura de `Decisions`

Campo	Tipo	Descrição
DecisionContent	string	Conteúdo da decisão.
DecisionDate	string	Data da decisão do processo.