Dados de Distribuição de Processos dos Sócios

Parâmetros de consulta

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

CampoDescriçãoValores PossíveisTipo de Campo
documentDocumento de identificaçãoCNPJObrigatório
typeIdentificador do tipo de consultaADVANCED, ADDITIONAL_INPUTSObrigatório
subproductsArray de Slugs dos subprodutos que serão inclusos na busca["processos-socios-pj"]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

CampoTipoDescrição
ticketIdstringIdentificador da consulta
executadoEmdateData e hora da execução da consulta
statusstring'Executado''Executado com exceção'. Em caso de execução com exceção o campo exceptions será preenchido, porém a request retorna sucesso
resultadoobjectResposta da Consulta Básica
exceptionsarray<object>Lista de exceções encontradas durante a execução da consulta. Preenchido apenas quando status = 'Executado com exceção'

Estrutura de exceptions

CampoTipoDescrição
messagestringDescrição do erro ocorrido. Exemplos: "Os slugs informados estão inativos.", "Os slugs informados não foram encontrados."
slugsarray<string>Lista dos slugs que ocasionaram a exceção

Estrutura de resultado

CampoTipoDescrição
processos-socios-pjobjectLista com os detalhes do documento consultado

Estrutura de processos-socios-pj

CampoTipoDescrição
namestringNome do subproduto consultado
statusintegerStatus Code da Requisição
ResultobjectLista com os detalhes da consulta

Estrutura de Result

CampoTipoDescrição
OwnersLawsuitsDistributionDataobjectDados de Distribuição de Processos dos Sócios

Estrutura de OwnersLawsuitsDistributionData

NomeTipoDescrição
TotalOwnersintegerQuantidade de sócios que a empresa possui
MaxLawsuitsPerOwnerintegerQuantidade de processos máximo que um dos sócios possui
AvgLawsuitsPerOwnerintegerQuantidade de processos máximo para cada sócio
MinLawsuitsPerOwnerintegerQuantidade de processos mínimo que um dos sócios possui
TotalLawsuitsAsAuthorintegerQuantidade de processos no qual a empresa processou
TotalLawsuitsAsDefendantintegerQuantidade de processos no qual a empresa foi processada
TotalLawsuitsAsOtherintegerQuantidade de processos no qual a empresa participou que não seja como processada ou acusadora
IsRelatedToLawyersbooleanIndica se a empresa possui relação com advogados
IsRelatedToJudgesbooleanIndica se a empresa possui relação com juízes
TotalLawsuitsintegerTotal de processos da entidade
FirstLawsuitDatestringData da primeira ocorrência de processo em que a pessoa está envolvida
LastLawsuitDatestringData da última ocorrência de processo em que a pessoa está envolvida
Last30DaysLawsuitsintegerNúmero de processos em que a pessoa está envolvida que se iniciaram nos últimos 30 dias
Last90DaysLawsuitsintegerNúmero de processos em que a pessoa está envolvida que se iniciaram nos últimos 90 dias
Last180DaysLawsuitsintegerNúmero de processos em que a pessoa está envolvida que se iniciaram nos últimos 180 dias
Last365DaysLawsuitsintegerNúmero de processos em que a pessoa está envolvida que se iniciaram nos últimos 365 dias
TypeDistributionobjectDistribuição dos dados de tipo dos processos
CourtNameDistributionobjectDistribuição dos dados de nome da corte dos processos
StatusDistributionobjectDistribuição dos dados de status dos processos
StateDistributionobjectDistribuição dos dados de UF dos processos
PartyTypeDistributionobjectDistribuição dos dados de tipo de parte dos processos
CourtTypeDistributionobjectDistribuição dos dados de tipo da corte dos processos
CourtLevelDistributionobjectDistribuição dos dados de nível da corte dos processos
CnjProcedureTypeDistributionobjectDistribuição dos dados de tipo de procedimento dos processos
CnjSubjectDistributionobjectDistribuição dos dados de assuntos dos processos
CnjBroadSubjectDistributionobjectDistribuição dos dados do assunto geral dos processos
LawsuitsDistributionByAlternativeParameterDataobjectDados de agregações referentes aos valores encontrados do campo de distribuição alternativo

Estrutura de LawsuitsDistributionByAlternativeParameterData

NomeTipoDescrição
AlternativeParameterNamestringNome do campo informado como parâmetro alternativo que será utilizado para gerar as aggregações baseadas em seus valores encontrados na lista de processos judiciais do indivíduo.
DistributionFieldNamesarray of stringsNome dos campos referentes às distribuições de cada um dos valores de agregação (Ex: TypeDistribution, StatusDistribution, CourtLevelDistribution, etc.).
LawsuitsDistributionByAlternativeParameterValuesobjectEste objeto fornece as distribuições de todos os processos judiciais de um indivíduo em relação aos valores do campo de agregação informado como parâmetro do dataset e os demais campos de agregação (Type, Status, CourtLevel, etc.).
Language
Credentials
Header
Click Try It! to start a request and see the response here!