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
["serasa"]
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
serasa
object
Lista com os detalhes do documento consultado
Estrutura de serasa
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 reports
Campo
Tipo
Descrição
reportName
string
Nome do Relatório
identificationReport
object
Dados de Registro
QSAReport
object
Quadro Social Administrativo
score
object
Score
scores
object
Informações adicionais do Score
negativeData
object
Dados de Negativação
facts
object
Fatos
Estrutura de identificationReport
Campo
Tipo
Descrição
updateDate
string ($date)
Data da última atualização das informações
statusRegistration
string
Situação do CNPJ consultado
companyName
string
Nome da empresa consultada
companyAlias
string
Nome fantasia da empresa consultada
address.addressLine
string
Endereço da empresa
address.zipCode
string
CEP
address.district
string
Bairro
address.city
string
Cidade
address.state
string
Estado
phone.areaCode
string
Código de área
phone.phoneNumber
string
Número de telefone
companyUrl
string
Site oficial da empresa consultada
partnership
string
Tipo da sociedade que a empresa participa
companyRegister
string
Registro da empresa consultada
companyRegisterDate
string
Data do registro da empresa
companyFoundation
string ($date)
Data da fundação da empresa
numberEmployees
integer
Quadro de funcionários efetivos da empresa
taxOption
string
Opção tributária da empresa
stateRegistration
string
Inscrição estadual da empresa
economicActivity
string
Área de atuação da empresa
importPurchases
number ($double)
Porcentagem da importação sobre compras
exportSales
number ($double)
Porcentagem da exportação sobre vendas
cnae
string
Classificação Nacional de Atividades Econômicas
serasaActiveCode
string
Código da área de atuação registrado na base Serasa Experian
branchOffices
string
Número de filiais da empresa consultada
nireNumber
string
Registro de legalidade da empresa
predecessorList.predecessorName
string
Nome da empresa antecessora
predecessorList.predecessorDate
string ($date)
Data da empresa antecessora
legalNatureCode
string
Código da Natureza Jurídica
Estrutura de QSAReport
Campo
Tipo
Descrição
companyData.socialCapitalValue
number ($double)
Capital social da empresa
companyData.accomplishedValue
number ($double)
Capital realizado da empresa
companyData.informationUpdateDate
string
Data de atualização das informações
companyData.countryOrigin
string
País de origem
companyData.controlType
string
Tipo de controle da empresa
companyData.nature
string
Natureza da empresa
partnersList.documentType
string
Tipo do documento do sócio (CPF ou CNPJ)
partnersList.documentId
string
Número do documento do sócio
partnersList.name
string
Nome/Razão social do sócio
partnersList.sinceDate
string ($date)
Data de entrada do sócio na empresa
partnersList.nationality
string
Nacionalidade do sócio
partnersList.restrictionSign
boolean
Indicativo de anotações do sócio
partnersList.documentConsistency
boolean
Indicativo de inconsistência do sócio
partnersList.capitalTotalValue
number ($double)
Capital total do sócio
partnersList.capitalVoterValue
number ($double)
Capital votante do sócio
directorsList.documentType
string
Tipo do documento do administrador (CPF ou CNPJ)
directorsList.documentId
string
Número do documento do administrador
directorsList.name
string
Nome/Razão social do administrador
directorsList.role
string
Cargo do administrador
directorsList.maritalStatus
string
Estado civil do administrador (apenas para CPF’s)
directorsList.sinceDate
string ($date)
Data de entrada do administrador na empresa
directorsList.mandateStart
string ($date)
Data de início de mandato do administrador
directorsList.mandateEnd
string ($date)
Data de final de mandato do administrador
directorsList.nationality
string
Nacionalidade do administrador
directorsList.restrictionSign
boolean
Indicativo de anotações do sócio
directorsList.documentConsistency
boolean
Indicativo de inconsistência do sócio
Estrutura de score
Campo
Tipo
Descrição
score
integer
Pontuação do score
scoreModel
string
Modelo de score: Score Positivo
defaultRate
string
Probabilidade de não pagamento
message
string
Mensagem informativa
Estrutura de scores
Campo
Tipo
Descrição
scoreResponse.score
integer
Pontuação do score
scoreResponse.scoreModel
string
Modelo do score
scoreResponse.message
string
Mensagem informativa
Estrutura de negativeData
Campo
Tipo
Descrição
pefin
object
Pendência Financeira - PEFIN
refin
object
Restrições Financeiras - REFIN
notary
object
Protestos
check
object
Cheques Sem Fundo (CCF)
collectionRecords
object
Dívidas Vencidas
Estrutura de pefin
Campo
Tipo
Descrição
pefinResponse.occurrenceDate
string ($date)
Data da ocorrência
pefinResponse.legalNatureId
string
Código da Natureza
pefinResponse.legalNature
string
Natureza da dívida
pefinResponse.contractId
string
Identificador do contrato
pefinResponse.creditorName
string
Nome do credor
pefinResponse.amount
number ($double)
Valor da dívida
pefinResponse.federalUnit
string
Estado
pefinResponse.principal
boolean
Principal (true) ou Avalista (false)
pefinResponse.summary.firstOcurrence
string ($date)
Data da negativação mais recente
pefinResponse.summary.lastOcurrence
string ($date)
Data da negativação mais antiga
pefinResponse.summary.count
integer ($int32)
Quantidade total de pendências financeiras
pefinResponse.summary.balance
number ($double)
Valor total de pendências financeiras
Estrutura de refin
Campo
Tipo
Descrição
refinResponse.occurrenceDate
string ($date)
Data da ocorrência
refinResponse.legalNatureId
string
Código da Natureza
refinResponse.legalNature
string
Natureza da dívida
refinResponse.contractId
string
Identificador do contrato
refinResponse.creditorName
string
Nome do credor
refinResponse.amount
number ($double)
Valor da dívida
refinResponse.principal
boolean
Principal (true) ou Avalista (false)
refinResponse.summary.firstOcurrence
string ($date)
Data da negativação mais recente
refinResponse.summary.lastOcurrence
string ($date)
Data da negativação mais antiga
refinResponse.summary.count
integer ($int32)
Quantidade total de restrições financeiras
refinResponse.summary.balance
number ($double)
Valor total de restrições financeiras
Estrutura de notary
Campo
Tipo
Descrição
notaryResponse.occurrenceDate
string ($date)
Data da ocorrência
notaryResponse.amount
number ($double)
Valor da dívida
notaryResponse.officeNumber
string
Número do cartório
notaryResponse.city
string
Cidade
notaryResponse.federalUnit
string
Estado
notaryResponse.summary.firstOcurrence
string ($date)
Data da negativação mais recente
notaryResponse.summary.lastOcurrence
string ($date)
Data da negativação mais antiga
notaryResponse.summary.count
integer ($int32)
Quantidade total de protestos
notaryResponse.summary.balance
number ($double)
Valor total dos protestos
Estrutura de check
Campo
Tipo
Descrição
checkResponse.occurrenceDate
string ($date)
Data da ocorrência
checkResponse.alinea
integer ($int32)
Identificador do motivo da devolução do cheque
checkResponse.bankName
string
Nome do banco
checkResponse.bankAgencyId
integer ($int32)
Número da agência
checkResponse.checkNumber
string
Número do cheque
checkResponse.checkCount
integer ($int32)
Quantidade de cheques
checkResponse.city
string
Cidade
checkResponse.federalUnit
string
Estado
checkResponse.summary.firstOcurrence
string ($date)
Data da negativação mais recente
checkResponse.summary.lastOcurrence
string ($date)
Data da negativação mais antiga
checkResponse.summary.count
integer ($int32)
Quantidade total de cheques sem fundo
checkResponse.summary.balance
number ($double)
Valor total de cheques sem fundo
Estrutura de collectionRecords
Campo
Tipo
Descrição
collectionRecordsResponse.occurrenceDate
string ($date)
Data da ocorrência
collectionRecordsResponse.legalNatureId
string
Código da Natureza
collectionRecordsResponse.legalNature
string
Natureza da dívida
collectionRecordsResponse.debtMode
string
Identificador da natureza da dívida
collectionRecordsResponse.contractId
string
Identificador do contrato
collectionRecordsResponse.creditorName
string
Nome do credor
collectionRecordsResponse.amount
number ($double)
Valor da dívida
collectionRecordsResponse.city
string
Cidade
collectionRecordsResponse.federalUnit
string
Estado
collectionRecordsResponse.principal
boolean
Principal (true) ou Avalista (false)
collectionRecordsResponse.summary.firstOcurrence
string ($date)
Data da negativação mais recente
collectionRecordsResponse.summary.lastOcurrence
string ($date)
Data da negativação mais antiga
collectionRecordsResponse.summary.count
integer ($int32)
Quantidade total de dívidas vencidas
collectionRecordsResponse.summary.balance
number ($double)
Valor total de dívidas vencidas
Estrutura de facts
Campo
Tipo
Descrição
inquiryCompanyResponse
object
Consultas à Serasa
judgementFilings
object
Ações Judiciais
bankrupts
object
Participação em Falência
Estrutura de inquiryCompanyResponse
Campo
Tipo
Descrição
occurrenceDate
string ($date)
Data da consulta
companyName
string
Número do CNPJ consultante
companyDocumentId
string
Nome do CNPJ consultante
daysQuantity
string
Quantidade de consultas no dia
quantity.actual
integer
Quantidade de consulta do mês atual
quantity.historical.inquiryDate
string ($date)
Data dos meses anteriores
quantity.historical.occurrences
integer
Quantidade de consulta dos meses anteriores
Estrutura de judgementFilings
Campo
Tipo
Descrição
occurrenceDate
string ($date)
Data da ocorrência
legalNatureId
string
Código da Natureza
legalNature
string
Natureza da dívida
amount
number ($double)
Valor da dívida
distributor
string
Número do distribuidor
civilCourt
string
Identificador da vara judicial
city
string
Cidade
state
string
Estado
summary.firstOcurrence
string ($date)
Data da negativação mais recente
summary.lastOcurrence
string ($date)
Data da negativação mais antiga
summary.count
integer ($int32)
Quantidade total de ações judiciais
summary.balance
number ($double)
Valor total das açõe
Estrutura de judgementFilings
Campo
Tipo
Descrição
occurrenceDate
string ($date)
Data da ocorrência
legalNatureId
string
Código da Natureza
legalNature
string
Natureza da dívida
amount
number ($double)
Valor da dívida
distributor
string
Número do distribuidor
civilCourt
string
Identificador da vara judicial
city
string
Cidade
state
string
Estado
summary.firstOcurrence
string ($date)
Data da negativação mais recente
summary.lastOcurrence
string ($date)
Data da negativação mais antiga
summary.count
integer ($int32)
Quantidade total de ações judiciais
summary.balance
number ($double)
Valor total das ações judiciais
Language
Credentials
Header
Click Try It! to start a request and see the response here!
