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 ou 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"]
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
object
Lista com os detalhes do documento consultado
Estrutura de processos
Campo
Tipo
Descrição
name
string
Nome do subproduto consultado
status
integer
Status Code da Requisição
envolvido_encontrado
object
Empresa/Pessoa consultada
items
array of objects
Lista de processos relacionados
Estrutura de envolvido_encontrado
Campo
Tipo
Descrição
nome
string
Nome da Empresa / Pessoa
outros_nomes
array of string
Outros nomes da empresa / pessoa
tipo_pessoa
string
Tipo da pessoa (Pessoa Física ou Jurídica)
quantidade_processos
number
Quantidade de processos encontrados
cpfs_com_esse_nome
number
Se pessoa física exibe a quantidade de CPF's com o mesmo nome