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
CNPJ
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-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
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-socios-pj
object
Lista com os detalhes do documento consultado
Estrutura de processos-socios-pj
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
OwnersLawsuitsDistributionData
object
Dados de Distribuição de Processos dos Sócios
Estrutura de OwnersLawsuitsDistributionData
Nome
Tipo
Descrição
TotalOwners
integer
Quantidade de sócios que a empresa possui
MaxLawsuitsPerOwner
integer
Quantidade de processos máximo que um dos sócios possui
AvgLawsuitsPerOwner
integer
Quantidade de processos máximo para cada sócio
MinLawsuitsPerOwner
integer
Quantidade de processos mínimo que um dos sócios possui
TotalLawsuitsAsAuthor
integer
Quantidade de processos no qual a empresa processou
TotalLawsuitsAsDefendant
integer
Quantidade de processos no qual a empresa foi processada
TotalLawsuitsAsOther
integer
Quantidade de processos no qual a empresa participou que não seja como processada ou acusadora
IsRelatedToLawyers
boolean
Indica se a empresa possui relação com advogados
IsRelatedToJudges
boolean
Indica se a empresa possui relação com juízes
TotalLawsuits
integer
Total de processos da 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 em que a pessoa está envolvida que se iniciaram nos últimos 30 dias
Last90DaysLawsuits
integer
Número de processos em que a pessoa está envolvida que se iniciaram nos últimos 90 dias
Last180DaysLawsuits
integer
Número de processos em que a pessoa está envolvida que se iniciaram nos últimos 180 dias
Last365DaysLawsuits
integer
Número de processos em que a pessoa está envolvida que se iniciaram nos últimos 365 dias
TypeDistribution
object
Distribuição dos dados de tipo dos processos
CourtNameDistribution
object
Distribuição dos dados de nome da corte dos processos
StatusDistribution
object
Distribuição dos dados de status dos processos
StateDistribution
object
Distribuição dos dados de UF dos processos
PartyTypeDistribution
object
Distribuição dos dados de tipo de parte dos processos
CourtTypeDistribution
object
Distribuição dos dados de tipo da corte dos processos
CourtLevelDistribution
object
Distribuição dos dados de nível da corte dos processos
CnjProcedureTypeDistribution
object
Distribuição dos dados de tipo de procedimento dos processos
CnjSubjectDistribution
object
Distribuição dos dados de assuntos dos processos
CnjBroadSubjectDistribution
object
Distribuição dos dados do assunto geral dos processos
LawsuitsDistributionByAlternativeParameterData
object
Dados de agregações referentes aos valores encontrados do campo de distribuição alternativo
Estrutura de LawsuitsDistributionByAlternativeParameterData
Nome
Tipo
Descrição
AlternativeParameterName
string
Nome 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.
DistributionFieldNames
array of strings
Nome dos campos referentes às distribuições de cada um dos valores de agregação (Ex: TypeDistribution, StatusDistribution, CourtLevelDistribution, etc.).
LawsuitsDistributionByAlternativeParameterValues
object
Este 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!