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
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
QuodReportResponseEx.Response.Records
object
Resposta QUOD report
Estrutura de ReportPJResponseEx.Response.Records
Campo
Tipo
Descrição
Record
array<object>
Lista de registros consultados
Estrutura de Record[]
Campo
Tipo
Descrição
CPStatus
string
Status cadastral
Segment
string
Segmento
HasOnlyMinimumPII
boolean
Indica se possui apenas PII mínima
HasNegativeData
boolean
Indica existência de dados negativos
HasInquiryData
boolean
Indica existência de consultas
BestInfo
object
Bloco com dados principais
EnterpriseData
object
Informações empresariais (participações PJ)
QuodScore
object
Pontuações QUOD
Negative
object
Pendências
Inquiries
object
Consultas realizadas
Protests
object
Protestos
Estrutura de BestInfo
Campo
Tipo
Descrição
CPF
string
CPF da pessoa
CPFStatus
string
Situação do CPF
PersonName
object
Nome atual
MotherName
object
Nome da mãe
DOB
object
Data de nascimento
Age
string
Idade
Gender
string
Gênero
Address
object
Endereço atual
Email
object
E-mail atual
MobilePhoneNumber
object
Telefone celular atual
PersonNameHistory
object
Histórico de nomes
AddressHistory
object
Histórico de endereços
EmailHistory
object
Histórico de e-mails
MobilePhoneNumberHistory
object
Histórico de celulares
Estrutura de PersonName
Campo
Tipo
Descrição
DateLastSeen
object
Data da última ocorrência
Name
object
Nome completo
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 Email
Campo
Tipo
Descrição
DateLastSeen
object
Data da última ocorrência
Email
string
Endereço de e-mail
Estrutura de MobilePhoneNumber
Campo
Tipo
Descrição
DateLastSeen
object
Data da última ocorrência
PhoneNumber
string
Número de telefone
Estrutura de EnterpriseData
Campo
Tipo
Descrição
Partnerships
object
Participações da pessoa em empresas
Estrutura de EnterpriseData.Partnerships.Partnership[]
Campo
Tipo
Descrição
EntityType
string
Tipo da entidade (J/F)
CNPJ
string
CNPJ da empresa
CompanyName
string
Nome da empresa
CNPJStatus
string
Situação cadastral da empresa
PercentParticipation
string
Percentual de participação
ParticipationValue
string
Valor da participação
RelationshipDescription
string
Relação (ex.: "SOCIO")
DateStartPartner
object
Data de início da sociedade
DateStart
object
Data de início
FlagMainJob
string
Indicador de principal
DateReference
object
Data de referência
TrustLevel
string
Nível de confiança
Estrutura de QuodScore
Campo
Tipo
Descrição
Score
number
Score geral QUOD
Segment
string
Segmento
PaymentCommitmentScore
number
Score de comprometimento de pago
ProfileScore
number
Score de perfil
Estrutura de Negative
Campo
Tipo
Descrição
PendenciesControlCred
string
Pendências encontradas
Estrutura de Inquiries
Campo
Tipo
Descrição
InquiryCountLast30Days
number
Consultas nos últimos 30 dias
InquiryCountLast31to60Days
number
Consultas entre 31 e 60 dias
InquiryCountLast61to90Days
number
Consultas entre 61 e 90 dias
InquiryCountMore90Days
number
Consultas acima de 90 dias
InquiryDetails
object
Detalhes das consultas
Estrutura de InquiryDetail[]
Campo
Tipo
Descrição
DateInquiry
object
Data da consulta
InquiryCount
number
Quantidade de consultas
Segment
string
Segmento da consulta
Estrutura de Protests
Campo
Tipo
Descrição
Protest
array<object>
Lista de protestos
Language
Credentials
Header
Click Try It! to start a request and see the response here!
