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
["distribuicao-processos-judiciais-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
distribuicao-processos-judiciais-pf
object
Lista com os detalhes do documento consultado
Estrutura de distribuicao-processos-judiciais-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
LawsuitsDistributionData
object
Dados de Distribuição de Processos Judiciais
Estrutura de LawsuitsDistributionData
Campo
Tipo
Descrição
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. (Possui campos adicionais)
CourtNameDistribution
object
Distribuição dos dados de nome da corte dos processos. (Possui campos adicionais)
StatusDistribution
object
Distribuição dos dados de status dos processos. (Possui campos adicionais)
StateDistribution
object
Distribuição dos dados de UF dos processos. (Possui campos adicionais)
PartyTypeDistribution
object
Distribuição dos dados de tipo de parte dos processos. (Possui campos adicionais)
CourtTypeDistribution
object
Distribuição dos dados de tipo da corte dos processos. (Possui campos adicionais)
CourtLevelDistribution
object
Distribuição dos dados de nível da corte dos processos. (Possui campos adicionais)
CnjProcedureTypeDistribution
object
Distribuição dos dados de tipo de procedimento dos processos. (Possui campos adicionais)
CnjSubjectDistribution
object
Distribuição dos dados de assuntos dos processos. (Possui campos adicionais)
CnjBroadSubjectDistribution
object
Distribuição dos dados do assunto geral dos processos. (Possui campos adicionais)
LawsuitsDistributionByAlternativeParameterData
object
Dados de agregações referentes aos valores encontrados do campo de distribuição informado como parâmetro alternativo deste dataset.
Estrutura de LawsuitsDistributionData
Campo
Tipo
Descrição
AlternativeParameterName
string
Nome do campo informado como parâmetro alternativo que será utilizado para gerar as agregaçõ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!
