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
providers
Array de Slugs dos providers que serão inclusos na busca
["quod"]
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
quod
object
Lista com os detalhes do documento consultado
Estrutura de quod
Campo
Tipo
Descrição
name
string
Nome do provider consultado
status
array<integer>
Status Code das Requisições
data
array
Lista com os detalhes da consulta
Estrutura de data
Campo
Tipo
Descrição
ReportPJResponseEx.Response.Records
object
Resposta QUOD report
Estrutura de ReportPJResponseEx.Response.Records
Campo
Tipo
Descrição
ReportPJOutput
array
Resposta QUOD report
Estrutura de ReportPJOutput[]
Campo
Tipo
Descrição
CNPJ
string
CNPJ da empresa
CPStatus
string
Status cadastral
HasOnlyMinimumPII
boolean
Indica se há apenas PII mínima
HasNegativeData
boolean
Indica existência de dados negativos
HasInquiryData
boolean
Indica existência de dados de consultas
BestInfo
object
Melhor conjunto de informações consolidadas
Partner
object
Dados societários
ScorePJ
object
Score PJ
Indicators
object
Indicadores
Negative
object
Pendências/negativos
Protests
object
Protestos
Estrutura de BestInfo
Campo
Tipo
Descrição
CompanyStatus
string
Situação cadastral
CompanyName
string
Razão social
TradeName
string
Nome fantasia
LegalType
string
Código de natureza jurídica
CountBranches
string
Quantidade de filiais
Nire
string
Número NIRE
MainActivity
string
CNAE principal
MainActivityDescription
string
Descrição do CNAE principal
SecondaryActivity
string
CNAE secundário
SecondaryActivityDescription
string
Descrição do CNAE secundário
DateFoundation
object
Data de fundação
Address
object
Endereço atual
PhoneNumber
string
Telefone
AddressHistory
object
Histórico de endereços
PhoneNumberHistory
object
Histórico de telefones
Conglomerate
object
Conglomerado de empresas relacionadas
Estrutura de Address
Campo
Tipo
Descrição
Street
string
Logradouro
Number
string
Número
Neighborhood
string
Bairro
City
string
Cidade
State
string
Estado
PostalCode
string
CEP
DateLastSeen
object
Data da última ocorrência
Estrutura de Partner
Campo
Tipo
Descrição
Partnerships
object
Participações societárias
CapitalStock
string
Capital social
TrustLevel
string
Nível de confiança
Estrutura de Partnerships.Partnership[]
Campo
Tipo
Descrição
EntityType
string
Tipo da entidade (F/J)
CpfCnpj
string
Documento do sócio
Name
string
Nome
Status
string
Status
FlagNegativeData
string
Indicador negativo
PercentParticipation
string
Percentual de participação
ParticipationValue
string
Valor da participação
RelationshipDescription
string
Ex.: "SOCIO"
DateStartPartner
object
Data de início da sociedade
FlagMainJob
string
Indicador de sócio principal
DateReference
object
Data de referência
TrustLevel
string
Nível de confiança
Estrutura de ScorePJ
Campo
Tipo
Descrição
Score
string
Score PJ
ReasonCode1
string
Código razão
Estrutura de Indicators
Campo
Tipo
Descrição
Indicators
object
Lista de indicadores
CountIndicators
string
Quantidade
Estrutura de Negative
Campo
Tipo
Descrição
PendenciesControlCred
string
Pendências encontradas
Estrutura de Protests
Campo
Tipo
Descrição
Protest
array<object>
Lista de protestos
Estrutura de Protests.Protest[]
Campo
Tipo
Descrição
data_consulta
string
Data da consulta (ISO)
Language
Credentials
Header
Click Try It! to start a request and see the response here!
