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
["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 data
Campo
Tipo
Descrição
reports
array
Relatórios consultados
Estrutura de reports
Campo
Tipo
Descrição
reportName
string
Nome do Relatório
registration
object
Dados de Registro
negativeData
object
Dados de Negativação
score
object
Score
negativeSummary
object
Resumo dos dados de Negativação
facts
object
Fatos
partner
object
Participação Societária
Estrutura de registration
Campo
Tipo
Descrição
documentNumber
string
Número do documento da pessoa física
alternativeDocumentNumber
string
Número do documento alternativo da pessoa física
alternativeDocumentCode
string
Código para identificar o tipo de documento
alternativeDocumentDescription
string
Descrição do documento alternativo
alternativeDocumentDate
string ($date)
Data da emissão do documento
issuingAgency
string
Órgão emissor do documento
issuingAgencyState
string
Estado onde o documento foi emitido
consumerName
string
Nome da pessoa física
motherName
string
Nome da mãe
consumerGender
string
Sexo da pessoa física
maritalStatus
string
Código do estado civil da pessoa física
maritalStatusDescription
string
Descrição do estado civil da pessoa física
birthSquareCity
string
Cidade de nascimento da pessoa física
birthSquareState
string
Estado de nascimento da pessoa física
birthDate
string ($date)
Data de nascimento do documento consultado
profession
string
Profissão da pessoa física
professionCode
string
Código da profissão da pessoa física
occupation
string
Ocupação da pessoa física
occupationCode
string
Código da ocupação da pessoa física
jobDescription
string
Descritivo do emprego da pessoa física
educationLevelCode
string
Código da escolaridade da pessoa física
educationLevelDescription
string
Descrição da escolaridade da pessoa física
dependentsNumber
string
Número de dependentes da pessoa física
statusRegistration
string
Situação da pessoa física
statusDate
string ($date)
Data da situação do documento da pessoa física
address
object
Endereço Principal
addresses
array
Endereços Relacionados
phones
array
Telefones
Estrutura de address
Campo
Tipo
Descrição
addressLine
string
Rua da residência da pessoa física
district
string
Distrito da residência da pessoa física
zipCode
string
Número do CEP da pessoa física
country
string
País da residência da pessoa física
city
string
Cidade da residência da pessoa física
state
string
Estado da residência da pessoa física
Estrutura de addresses
Campo
Tipo
Descrição
addressLine
string
Logradouro da residência
addressTypeCode
string
Código do tipo de endereço
addressTypeDescription
string
Descrição do tipo de endereço
addressNumber
string
Número do endereço
discrict
string
Bairro
zipCode
string
CEP
country
string
País
city
string
Cidade
state
string
Estado
addressComplement
string
Complemento do endereço
updateDate
string ($date)
Data de modificação
Estrutura de phones
Campo
Tipo
Descrição
regionCode
string
Código nacional (55)
areaCode
string
DDD da cidade
phoneNumber
string
Número do telefone
phoneType
string
Tipo do telefone
phoneTypeCode
string
Código do tipo de telefone
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
array
Pendência Financeira - PEFIN
summary
object
Resumo da Consulta
Estrutura de pefinResponse
Campo
Tipo
Descrição
occurrenceDate
string($date)
Data da ocorrência
legalNature
string
Natureza da dívida
contractId
string
Identificador do contrato
creditorName
string
Nome do credor
amount
number($double)
Valor da dívida
legalSquare
string
Praça da ocorrência
principal
boolean
Principal (true) ou Avalista (false)
flagSubJudice
boolean
Indica se é Subjudice
Estrutura de refin
Campo
Tipo
Descrição
refinResponse
array
Restrições Financeiras - REFIN
summary
object
Resumo da Consulta
Estrutura de refinResponse
Campo
Tipo
Descrição
occurrenceDate
string($date)
Data da ocorrência
legalNatureId
string
Identificador da natureza da dívida
legalNature
string
Natureza da dívida
contractId
string
Identificador do contrato
creditorName
string
Nome do credor
amount
number($double)
Valor da dívida
legalSquare
string
Praça da ocorrência
principal
boolean
Principal (true) ou Avalista (false)
flagSubJudice
boolean
Indica se é Subjudice
Estrutura de notary
Campo
Tipo
Descrição
notaryResponse
array
Protestos
summary
object
Resumo da Consulta
Estrutura de notaryResponse
Campo
Tipo
Descrição
occurrenceDate
string($date)
Data da ocorrência
amount
number($double)
Valor da dívida
officeNumber
string
Número do cartório
city
string
Cidade
federalUnit
string
Estado
legalSquare
string
Código da cidade (praça)
Estrutura de check
Campo
Tipo
Descrição
checkResponse
array
Cheques Sem Fundo (CCF)
summary
object
Resumo da Consulta
Estrutura de checkResponse
Campo
Tipo
Descrição
occurrenceDate
string($date)
Data da ocorrência
alinea
integer($int32)
Identificador do motivo da devolução do cheque
bankId
integer($int32)
Identificador do banco
bankName
string
Nome do banco
bankAgencyId
integer($int32)
Número da agência
checkNumber
string
Número do cheque
checkCount
integer($int32)
Quantidade de cheques
city
string
Cidade
federalUnit
string
Estado
legalSquare
string
Código da cidade (praça)
Estrutura de collectionRecords
Campo
Tipo
Descrição
collectionRecordsResponse
array
Dívidas Vencidas
summary
object
Resumo da Consulta
Estrutura de collectionRecordsResponse
Campo
Tipo
Descrição
occurrenceDate
string($date)
Data da ocorrência
legalNatureId
string
Identificador da natureza da dívida
legalNature
string
Natureza da dívida
contractId
string
Identificador do contrato
creditorName
string
Nome do credor
amount
number($double)
Valor da dívida
city
string
Cidade
federalUnit
string
Estado
legalSquare
string
Código da cidade (praça)
principal
boolean
Principal (true) ou Avalista (false)
Estrutura de summary
Campo
Tipo
Descrição
firstOcurrence
string($date)
Data mais recente
lastOcurrence
string($date)
Data mais antiga
count
integer($int32)
Quantidade total
balance
number($double)
Valor total
Estrutura de score
Campo
Tipo
Descrição
score
integer
Pontuação do score
scoreModel
string
Modelo do score
range
string
Faixa do score
defaultRate
string
Probabilidade de Inadimplência
codeMessage
integer
Código da mensagem de score
message
string
Mensagem do score
Estrutura de negativeSummary
Campo
Tipo
Descrição
hasNegative
boolean
Indicador de negativação
message
string
Mensagem de negativação
Estrutura de facts
Campo
Tipo
Descrição
inquiry
object
Consultas à Serasa
inquirySummary
object
Consultas à Serasa Resumo
stolenDocuments
object
Documentos Roubados
judgementFilings
object
Ações Judiciais
bankrupts
object
Participação em Falência
Estrutura de inquiry
Campo
Tipo
Descrição
inquiryResponse
array
Consultas à Serasa
summary
object
Resumo
Estrutura de inquiryResponse
Campo
Tipo
Descrição
occurrenceDate
string($date)
Data da ocorrência
segmentDescription
string
Segmento da empresa
daysQuantity
integer
Quantidade de dias da última consulta
Estrutura de inquiry - summary
Campo
Tipo
Descrição
count
integer
Quantidade total de itens
Estrutura de inquirySummary
Campo
Tipo
Descrição
inquiryQuantity
object
Consultas à Serasa Resumo
summary
object
Resumo
Estrutura de inquiryQuantity
Campo
Tipo
Descrição
actual
integer
Quantidade de consultas no mês atual por produtos Serasa Experian
checkActual
integer
Quantidade de consultas no mês atual por produtos Serasa Experian referentes a cheques
creditInquiriesQuantity
array
Array de consultas de crédito histórico
checkInquiriesQuantity
array
Array de consultas de crédito referentes a cheques
Estrutura de creditInquiriesQuantity
Campo
Tipo
Descrição
inquiryDate
string
AAAA-MM da consulta
occurrences
integer
Quantidade de ocorrências do período
Estrutura de checkInquiriesQuantity
Campo
Tipo
Descrição
inquiryDate
string
AAAA-MM da consulta
occurrences
integer
Quantidade de ocorrências do período referente a cheques
Estrutura de inquiryQuantity - summary
Campo
Tipo
Descrição
count
integer
Quantidade total de itens
creditCount
integer
Quantidade total de consultas por produtos Serasa Experian
checkCount
integer
Quantidade total de consultas por produtos Serasa Experian referentes a cheques
Estrutura de stolenDocuments
Campo
Tipo
Descrição
stolenDocumentsResponse
array
Documentos Roubados
summary
object
Resumo
Estrutura de stolenDocumentsResponse
Campo
Tipo
Descrição
occurrenceDate
string(date)
Data da ocorrência
documentType
string
Pessoa física ou jurídica
documentNumber
string
Número do documento
detailedReason
string
Razão detalhada
Estrutura de stolenDocuments - summary
Campo
Tipo
Descrição
count
integer
Quantidade total dos itens
Estrutura de judgementFilings
Campo
Tipo
Descrição
judgementFilingsResponse
array
Ações Judiciais
summary
object
Resumo
Estrutura de judgementFilingsResponse
Campo
Tipo
Descrição
occurrenceDate
string($date)
Data da ocorrência
legalNatureId
string
Identificador da natureza da dívida
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
legalSquare
string
Código da cidade (praça)
Estrutura de judgementFilings - summary
Campo
Tipo
Descrição
firstOcurrence
string($date)
Data da negativação mais recente
lastOcurrence
string($date)
Data da negativação mais antiga
count
integer($int32)
Quantidade total de ações judiciais
balance
number($double)
Valor total das ações judiciais
Estrutura de bankrupts
Campo
Tipo
Descrição
bankruptsResponse
array
Participação em Falência
summary
object
Resumo
Estrutura de bankruptsResponse
Campo
Tipo
Descrição
occurrenceDate
string($date)
Data da participação da falência
companyDocumentId
string
CNPJ da empresa em falência
companyName
string
Razão social da empresa em falência
companyLegalNatureID
string
Tipo de falência
companyLegalNature
string
Descrição do tipo de falência
legalSquare
string
Código da cidade (praça)
Estrutura de bankrupts - summary
Campo
Tipo
Descrição
firstOcurrence
string($date)
Data da negativação mais recente
lastOcurrence
string($date)
Data da negativação mais antiga
count
integer($int32)
Quantidade total de falências
balance
number($double)
Valor total das falências
Estrutura de partner
Campo
Tipo
Descrição
partnershipResponse
array
Participação Societária
Estrutura de partnershipResponse
Campo
Tipo
Descrição
businessDocument
string
Documento da empresa participada
companyName
string
Razão social da empresa participada
participationInitialDate
string($date)
Data inicial da participação
participationPercentage
number($double)
Percentual de participação
companyStatus
string
Situação da empresa participada
companyStatusCode
string
Código da situação da empresa participada
companyState
string
Estado da empresa participada
companyStatusDate
string($date)
Data da situação da empresa participada
updateDate
string($date)
Data de atualização da empresa participada
Language
Credentials
Header
Click Try It! to start a request and see the response here!
