For the complete documentation index, see llms.txt. This page is also available as Markdown.

Financeiro

Lista de devedores da PGFN (PJ94)

Retorna se o CNPJ consultado está registrado em dívidas ativas com a PGFN.

Seção: pjPgfnDebtors

Parâmetro obrigatório: cnpj

Atributo
Tipo
Descrição

statusCode

String

Status da consulta (detalhes)

data

Objeto

Dados de retorno

data.message

String

Mensagem descritiva do resultado da consulta

data.hasDebts

Booleano

Status da dívida (true/false)

data.debtValue

String

Valor devido à PGFN

{
  "statusCode": "",
  "data": {
    "message": "",
    "hasDebts": "",
    "debtValue": ""
  }
}
Regra
Descrição

has_debts_on_pgfn

A regra será inválida se houver dívidas com a PGFN.

Associado à CVM (PJ65)

Retorna informações de CNPJ que têm relação com o mercado financeiro

Seção: pjAssociatedCvm

Parâmetro obrigatório: cnpj

Atributo
Tipo
Descrição

statusCode

String

Status da consulta (detalhes)

data

Objeto

Dados de retorno

data.message

String

Descrição do status da consulta

data.associates

Array

Descreve os dados dos Tipos de Cadastro na Comissão de Valores Mobiliários

data.associates[x].name

String

Nome da pessoa física

data.associates[x].type

String

Tipo de registro

data.associates[x].recordDate

String

Data de registro

data.associates[x].situation

String

Status do cadastro

data.associates[x].directors

Array

Lista de objetos que contêm dados sobre os diretores

data.associates[x].directors[x].name

String

Nome da empresa da qual o CPF é diretor

data.associates[x].directors[x].startDate

String

Data de início do cargo de diretor

data.associates[x].directors[x].instruction

String

Cargo do diretor na empresa

{
  "statusCode": "",
  "data": "",
  "message": "",
  "associates": [
    {
      "name": "",
      "type": "",
      "recordDate": "",
      "situation": "",
      "directors": [
        {
          "name": "",
          "startDate": "",
          "instruction": ""
        }
      ]
    }
  ]
}
Regra
Descrição

has_no_participant_cvm

A regra será inválida se o CPF/CNPJ consultado não estiver registrado na CVM.

Penalidades temporárias na CVM (PJ93)

Consulte a lista de penalidades temporárias da CVM se o participante estiver temporariamente impedido de atuar no mercado de capitais devido a uma decisão em um Processo Administrativo Sancionador.

Seção: pjPenaltiesOnCvm

Parâmetro obrigatório: nome

Atributo
Tipo
Descrição

statusCode

String

Status da consulta (detalhes)

data

Objeto

Dados de retorno

data.message

String

Descrição do status da consulta

data.listOfSetences

Array

Lista de participantes sancionados

data.listOfSetences[x].processNumber

String

Número do processo

data.listOfSetences[x].name

String

Participante

data.listOfSetences[x].decisionType

String

Tipo de decisão

data.listOfSetences[x].judgementDate

String

Data da decisão da CVM

data.listOfSetences[x].effectiveDate

String

Data de vigência da penalidade

data.listOfSetences[x].timeOfWithdrawal

String

Tempo de afastamento

Regra
Descrição

has_penalties_on_cvm

A regra será inválida se o CPF estiver temporariamente impedido de atuar na CVM.

Participação societária na empresa (PJ90)

Retorna o percentual de participação dos sócios em uma empresa.

Seção: pjCompanyOwnersPercentage

Parâmetro obrigatório: cnpj

Atributo
Tipo
Descrição

statusCode

String

Status da consulta (detalhes)

data

Objeto

Dados de retorno

data.message

String

Descrição do status da consulta

data.companyShares

Array

Valor estimado de renda

data.companyShares[x].cnpj

String

CNPJ

data.companyShares[x].cpf

String

CPF

data.companyShares[x].corporateName

String

Nome da empresa

data.companyShares[x].totalShare

String

Percentual de participação

Regra
Descrição

has_no_total_share

A regra será inválida se o valor da participação for nulo ou inválido.

Sistema de Informações de Crédito (PJ96)

Retorna as informações de crédito de uma pessoa.

Seção: pjCreditOperationsSCR

Parâmetros obrigatórios: cnpj, PJ

Atributo
Tipo
Descrição

statusCode

String

Status da consulta (detalhes)

data

Objeto

Dados de retorno

data.message

String

Descrição do status da consulta

data.clientCode

String

CNPJ

data.registrationDate

Data

Data de registro

data.baseDate

Data

Data-base para consulta

data.assumedCoobligation

Número

Coobrigação assumida na cessão de crédito pelo cliente

data.receivedCoobligation

Número

Coobrigação recebida na cessão de crédito

data.processedDocumentsPercentage

Número

Percentual dos documentos 3040 esperados para a data-base e que já foram incorporados ao banco de dados do SCR no Banco Central, desconsiderando as instituições financeiras isentas

data.processedVolumePercentage

Número

Percentual do volume esperado para a data-base e que já foi incorporado ao banco de dados do SCR no Banco Central, desconsiderando as instituições financeiras isentas

data.totalOfInstituions

String

Número de instituições financeiras (IFs) nas quais o cliente possui operações

data.totalOfTransactions

String

Número de operações do cliente no SFN

data.totalDisagreementTransactions

String

Número de operações marcadas com manifestação de discordância

data.totalSubJudiceTransactions

String

Número de operações marcadas como sub judice

data.fullLiabilityDisagreement

String

Responsabilidade total das operações marcadas com manifestação de discordância

data.fullLiabilitySubJudice

String

Responsabilidade total das operações sub judice

data.indirectVendorRisk

String

Risco indireto assumido pelo cliente em operações de vendor

data.operationSumaryList

Array

Lista contendo o resumo das operações

data.operationSumaryList[x].modalityCategoryCode

String

Código da modalidade da operação

data.operationSumaryList[x].modalityCategoryDescription

String

Descrição do código da modalidade da operação

data.operationSumaryList[x].modalitySubCategoryCode

String

Código da subcategoria

data.operationSumaryList[x].modalitySubCategoryDescription

String

Descrição do indicador da subcategoria

data.operationSumaryList[x].listOfDebts

Array

Lista de vencimentos

data.operationSumaryList[x].listOfDebts[x].expirationCode

String

Indicador de vencimento

data.operationSumaryList[x].listOfDebts[x].expirationDescription

String

Descrição do indicador de vencimento

data.operationSumaryList[x].listOfDebts[x].value

String

Valor de vencimento

Score de crédito - NOVO (PJ87)

Retorna o score de crédito de uma empresa com base em seu comportamento; o score estimará a probabilidade de inadimplência e o quão arriscado é o perfil em relação ao crédito

Seção: pjCreditScore

Parâmetro obrigatório: cnpj

Atributo
Tipo
Descrição

statusCode

String

Status da consulta (detalhes)

message

String

Descrição do status da consulta

data

Objeto

Dados de retorno

data.score

Inteiro

Classificação do Consumer Score

data.scoreMessage

String

Contexto da recomendação para tomada de decisão

Regra
Descrição

credit_score_available

A regra se tornará inválida se o score de crédito não estiver disponível.

credit_score_below

A regra se tornará inválida se o score de crédito estiver abaixo do valor definido.

credit_score_over

A regra se tornará inválida se o score de crédito estiver acima do valor definido.

credit_score_between

A regra se tornará inválida se o score de crédito estiver entre os valores definidos.

Perfil de crédito - NOVO (PJ88)

Retorna uma avaliação abrangente da saúde financeira de uma empresa, fornecendo seu score de crédito e apresentando um perfil financeiro detalhado. Com base em uma ampla gama de dados, incluindo dívidas registradas, histórico de consultas, protestos, devoluções e atividade bancária, bem como dados complementares, como vínculos com outras empresas e registros de falência ou recuperação judicial, oferece uma análise preditiva da capacidade de pagamento atual e futura da empresa. Essa solução permite acesso a uma visão financeira confiável e completa do negócio, tornando-a ideal para decisões de crédito e análise de risco, oferecendo insights claros para mitigar riscos e maximizar oportunidades financeiras.

Os blocos de dados só serão retornados se houver informação disponível.

Seção: pjCreditProfileDetails

Parâmetro obrigatório: cnpj

Atributo
Tipo
Descrição

statusCode

String

Status da consulta (detalhes)

message

String

Descrição do status da consulta

data

Objeto

Dados de retorno

data.civilActions

Objeto

Um bloco que fornece uma visão consolidada dos registros de ações cíveis

data.civilActions.totalActions

String

Quantidade total de ações cíveis

data.civilActions.totalValue

String

Valor total das ações cíveis

data.civilActions.firstValue

String

Valor da primeira ação cível

data.civilActions.firstDate

String

Data da primeira ação cível

data.civilActions.highestValue

String

Maior valor das ações cíveis

data.civilActions.highestDate

String

Maior valor das ações cíveis

data.civilActions.latestOccurrences

Array

Uma lista contendo informações sobre as últimas ocorrências de ações cíveis

data.civilActions.latestOccurrences[x].defendant

String

Nome do réu

data.civilActions.latestOccurrences[x].action

String

Título da ação cível

data.civilActions.latestOccurrences[x].document

String

Documento

data.civilActions.latestOccurrences[x].courtDistrict

String

Comarca

data.civilActions.latestOccurrences[x].state

String

Estado

data.civilActions.latestOccurrences[x].court

String

Tribunal

data.civilActions.latestOccurrences[x].plaintiff

String

Autor da ação cível

data.civilActions.latestOccurrences[x].lawsuitNumber

String

Número da ação cível

data.civilActions.latestOccurrences[x].distribution

String

Distribuição

data.civilActions.latestOccurrences[x].amount

String

Valor

data.administrators

Objeto

Uma lista contendo informações detalhadas sobre cada administrador da empresa

data.administrators.name

String

Nome

data.administrators.cpf

String

CPF

data.administrators.entry

String

Data de entrada

data.administrators.mandate

String

Indeterminado

data.administrators.position

String

Cargo

data.administrators.cpfStatus

String

Status do CPF

data.administrators.debtIndicator

String

Indicador de dívida

data.administrators.fraudIndicator

String

Indicador de fraude

data.administrators.documentRestrictions

Objeto

Restrições documentais

data.administrators.documentRestrictions.pendingRestrictions

Objeto

Restrições pendentes

data.administrators.documentRestrictions.pendingRestrictions.quantity

String

Quantidade total

data.administrators.documentRestrictions.pendingRestrictions.last

String

Data do último registro

data.administrators.documentRestrictions.pendingRestrictions.amount

String

Valor

data.administrators.documentRestrictions.nonSufficientFundsChecks

Objeto

Cheques sem fundos

data.administrators.documentRestrictions.nonSufficientFundsChecks.quantity

String

Quantidade total

data.administrators.documentRestrictions.nonSufficientFundsChecks.last

String

Data do último registro

data.administrators.documentRestrictions.nonSufficientFundsChecks.amount

String

Valor

data.administrators.documentRestrictions.protests

Objeto

Protestos

data.administrators.documentRestrictions.protests.quantity

String

Quantidade total

data.administrators.documentRestrictions.protests.last

String

Data do último registro

data.administrators.documentRestrictions.protests.amount

String

Valor

data.administrators.documentRestrictions.judicialActions

Objeto

Ações judiciais

data.administrators.documentRestrictions.judicialActions.quantity

String

Quantidade total

data.administrators.documentRestrictions.judicialActions.last

String

Data do último registro

data.administrators.documentRestrictions.judicialActions.amount

String

Valor

data.administrators.documentRestrictions.bankruptciesAndJudicialRecoveries

Objeto

Falências e recuperações judiciais

data.administrators.documentRestrictions.bankruptciesAndJudicialRecoveries.quantity

String

Quantidade total

data.administrators.documentRestrictions.bankruptciesAndJudicialRecoveries.last

String

Data do último registro

data.administrators.documentRestrictions.bankruptciesAndJudicialRecoveries.amount

String

Valor

data.administrators.documentRestrictions.inquiries

Objeto

Consultas

data.administrators.documentRestrictions.inquiries.quantity

String

Quantidade total

data.administrators.documentRestrictions.inquiries.last

String

Data do último registro

data.administrators.documentRestrictions.inquiries.amount

String

Valor

data.fraudAlert

Objeto

Alerta de fraude

data.fraudAlert.message

String

Mensagem de alerta de fraude

data.userReportedReturnedChecks

Objeto

Um bloco que fornece uma visão consolidada dos cheques bancários devolvidos informados pelo usuário

data.userReportedReturnedChecks.totalQuantity

String

Quantidade total

data.userReportedReturnedChecks.initialPeriod

String

Período inicial

data.userReportedReturnedChecks.finalPeriod

String

Período final

data.userReportedReturnedChecks.latestOccurrences

Array

Uma lista contendo informações sobre as últimas ocorrências de cheques bancários devolvidos informados pelo usuário

data.userReportedReturnedChecks.latestOccurrences[x].informer

String

Informante

data.userReportedReturnedChecks.latestOccurrences[x].bank

String

Banco

data.userReportedReturnedChecks.latestOccurrences[x].agency

String

Agência

data.userReportedReturnedChecks.latestOccurrences[x].initialChecks

String

Cheques bancários iniciais

data.userReportedReturnedChecks.latestOccurrences[x].finalChecks

String

Cheques bancários finais

data.userReportedReturnedChecks.latestOccurrences[x].occurrenceDate

String

Data da ocorrência

data.userReportedReturnedChecks.latestOccurrences[x].registrationDate

String

Data de registro

data.userReportedReturnedChecks.latestOccurrences[x].reason

String

Motivo

data.userReportedReturnedChecks.latestOccurrences[x].city

String

Cidade

data.userReportedReturnedChecks.latestOccurrences[x].state

String

Estado

data.nonSufficientFundsChecks

Objeto

Um bloco que fornece uma visão consolidada de cheques bancários sem fundos suficientes

data.nonSufficientFundsChecks.totalNsfChecks

String

Quantidade total

data.nonSufficientFundsChecks.totalRelatedNames

String

Total de nomes relacionados

data.nonSufficientFundsChecks.latestOccurrences

Array

Uma lista contendo informações sobre as últimas ocorrências de cheques bancários sem fundos suficientes

data.nonSufficientFundsChecks.latestOccurrences[x].name

String

Nome

data.nonSufficientFundsChecks.latestOccurrences[x].lastDate

String

Data da ocorrência

data.nonSufficientFundsChecks.latestOccurrences[x].bankNumber

String

Número do banco

data.nonSufficientFundsChecks.latestOccurrences[x].bankName

String

Nome do banco

data.nonSufficientFundsChecks.latestOccurrences[x].agency

String

Agência

data.nonSufficientFundsChecks.latestOccurrences[x].reason

String

Motivo

data.nonSufficientFundsChecks.latestOccurrences[x].quantity

String

Quantidade total

data.revokedChecks

Objeto

Um bloco que fornece uma visão consolidada de cheques bancários revogados

data.revokedChecks.total

String

Quantidade total

data.revokedChecks.initialPeriod

String

Período inicial

data.revokedChecks.finalPeriod

String

Período final

data.revokedChecks.latestOccurrences

Array

Uma lista contendo informações sobre as últimas ocorrências de cheques bancários revogados

data.revokedChecks.latestOccurrences[x].date

String

Data de suspensão

data.revokedChecks.latestOccurrences[x].bank

String

Banco

data.revokedChecks.latestOccurrences[x].agency

String

Agência

data.revokedChecks.latestOccurrences[x].checks

String

Cheques bancários

data.revokedChecks.latestOccurrences[x].occurrenceDate

String

Data da ocorrência

data.futureCommitment

Objeto

Um bloco que fornece uma visão consolidada dos compromissos futuros

data.futureCommitment.commitmentsList

Array

Uma lista contendo período e pontuação dos compromissos

data.futureCommitment.commitmentsList [x].period

String

Período do compromisso

data.futureCommitment.commitmentsList [x].score

String

Pontuação do compromisso

data.futureCommitment.creditList

Array

Uma lista contendo período e pontuação dos créditos

data.futureCommitment.creditList[x].period

String

Período do compromisso

data.futureCommitment.creditList[x].score

String

Pontuação do compromisso

data.creditObtained

Objeto

Um bloco que fornece uma visão consolidada do crédito obtido

data.creditObtained.score

String

Pontuação de crédito obtido

data.creditObtained.behaviorIndicatorList

Array

Uma lista contendo período e pontuação do indicador de comportamento

data.creditObtained.behaviorIndicatorList[x].monthYear

String

Mês e ano

data.creditObtained.behaviorIndicatorList[x].monthlyScore

String

Pontuação mensal

data.otherInformation

Objeto

Um bloco que fornece uma visão consolidada de outras informações

data.otherInformation.supplierRelationshipDuration

String

Uma lista contendo período e valores do relacionamento com fornecedores

data.otherInformation.supplierRelationshipDuration[x].period

String

Período

data.otherInformation.supplierRelationshipDuration[x].amount

String

Valor

data.otherInformation.importantEvents

Array

Uma lista contendo informações sobre eventos importantes

data.otherInformation.importantEvents[x].indicator

String

Indicador

data.otherInformation.importantEvents[x].period

String

Período

data.otherInformation.importantEvents[x].score

String

Pontuação

data.latePayment

Objeto

Um bloco que fornece uma visão consolidada de pagamentos em atraso

data.latePayment.latePayment6to15DaysPeriod

Array

Uma lista contendo informações sobre pagamentos em atraso de 6 a 15 dias

data.latePayment.latePayment6to15DaysPeriod[x].monthYear

String

Mês e ano

data.latePayment.latePayment6to15DaysPeriod[x].monthlyScore

String

Pontuação mensal

data.latePayment.latePayment16to30DaysPeriod

Array

Uma lista contendo informações sobre pagamentos em atraso de 16 a 30 dias

data.latePayment.latePayment16to30DaysPeriod[x].monthYear

String

Mês e ano

data.latePayment.latePayment16to30DaysPeriod[x].monthlyScore

String

Pontuação mensal

data.latePayment.latePayment31to60DaysPeriod

Array

Uma lista contendo informações sobre pagamentos em atraso de 31 a 60 dias

data.latePayment.latePayment31to60DaysPeriod[x].monthYear

String

Mês e ano

data.latePayment.latePayment31to60DaysPeriod[x].monthlyScore

String

Pontuação mensal

data.latePayment.latePaymentover60DaysPeriod

Array

Uma lista contendo informações sobre pagamentos em atraso acima de 60 dias

data.latePayment.latePaymentover60DaysPeriod[x].monthYear

String

Mês e ano

data.latePayment.latePaymentover60DaysPeriod[x].monthlyScore

String

Pontuação mensal

data.latePayment.latePaymentaverageDelayDays

Array

Uma lista contendo informações sobre os dias médios de atraso no pagamento

data.latePayment.latePaymentaverageDelayDays[x].monthYear

String

Mês e ano

data.latePayment.latePaymentaverageDelayDays[x].monthlyScore

String

Pontuação mensal

data.onTimePayment

Array

Uma lista contendo informações sobre pagamentos em dia

data.onTimePayment[x].monthYear

String

Mês e ano

data.onTimePayment[x].monthlyScore

String

Pontuação mensal

data.commitments

Objeto

Um bloco que fornece uma visão consolidada de compromissos

data.commitments.score

String

Pontuação de compromissos

data.commitments.behaviorIndicatorList

Array

Uma lista contendo período e pontuação do indicador de comportamento

data.commitments.behaviorIndicatorList[x].monthYear

String

Mês e ano

data.commitments.behaviorIndicatorList[x].monthlyScore

String

Pontuação mensal

data.inquiries

Objeto

Um bloco que fornece uma visão consolidada de consultas

data.inquiries.totalQuantity

String

Quantidade total

data.inquiries.initialPeriod

String

Período inicial

data.inquiries.finalPeriod

String

Período final

data.inquiries.monthlyInquiries

Array

Uma lista contendo período e quantidade de consultas

data.inquiries.monthlyInquiries[x].monthYear

String

Mês e ano

data.inquiries.monthlyInquiries[x].quantity

String

Total de consultas

data.inquiries.recentInquiries

Array

Uma lista contendo informações sobre consultas recentes

data.inquiries.recentInquiries[x].date

String

Data da consulta

data.inquiries.recentInquiries[x].companyName

String

Nome da empresa

data.inquiries.recentInquiries[x].cnpj

String

CNPJ

data.decision

String

Sugestão de negociação com a empresa

data.bankruptciesAndJudicialRecoveries

Objeto

Um bloco que fornece uma visão consolidada de falências e recuperações judiciais

data.bankruptciesAndJudicialRecoveries.totalQuantity

String

Quantidade total

data.bankruptciesAndJudicialRecoveries.initialPeriod

String

Período inicial

data.bankruptciesAndJudicialRecoveries.finalPeriod

String

Período final

data.bankruptciesAndJudicialRecoveries.latestOccurrences

Array

Uma lista contendo informações sobre as últimas ocorrências de cheques bancários revogados

data.bankruptciesAndJudicialRecoveries.latestOccurrences[x].occurrenceType

String

Tipo de ocorrência

data.bankruptciesAndJudicialRecoveries.latestOccurrences[x].date

String

Data

data.bankruptciesAndJudicialRecoveries.latestOccurrences[x].city

String

Cidade

data.bankruptciesAndJudicialRecoveries.latestOccurrences[x].state

String

Estado

data.bankruptciesAndJudicialRecoveries.latestOccurrences[x].court

String

Tribunal

data.completeIdentification

Objeto

Um bloco que fornece uma visão consolidada da identificação da empresa

data.completeIdentification.cnpj

String

CNPJ

data.completeIdentification.companyName

String

Nome da empresa

data.completeIdentification.tradingName

String

Nome fantasia

data.completeIdentification.cnpjStatus

String

Status do CNPJ

data.completeIdentification.statusDate

String

Data do status

data.completeIdentification.federalRevenueInquiryDate

String

Data da consulta à Receita Federal

data.completeIdentification.nireNumber

String

Número do NIRE

data.completeIdentification.nireFederativeUnit

String

UF do NIRE

data.completeIdentification.stateRegistration

String

Inscrição estadual

data.completeIdentification.stateRegistrationFederativeUnit

String

UF da inscrição estadual

data.completeIdentification.foundationDate

String

Data de abertura

data.completeIdentification.sintegraStatus

String

Status do Sintegra

data.completeIdentification.sintegraInquiryDate

String

Data da consulta ao Sintegra

data.completeIdentification.legalNatureCode

String

Código da natureza jurídica

data.completeIdentification.legalNature

String

Natureza jurídica

data.completeIdentification.segment

String

segmento

data.completeIdentification.initialCapitalCurrency

String

Moeda do capital inicial

data.completeIdentification.initialCapital

String

Capital inicial

data.completeIdentification.registrationDate

String

Data de registro

data.completeIdentification.agency

String

Agência

data.completeIdentification.currentCapitalCurrency

String

Moeda do capital atual

data.completeIdentification.currentCapital

String

Capital atual

data.completeIdentification.capitalChangeDate

String

Data da alteração do capital

data.completeIdentification.currentAgency

String

Agência atual

data.completeIdentification.primaryBusinessActivity

Objeto

Atividade principal

data.completeIdentification.primaryBusinessActivity.activity

String

Atividade

data.completeIdentification.primaryBusinessActivity.cnae

String

Código CNAE

data.completeIdentification.secondaryBusinessActivity

Objeto

Atividade secundária

data.completeIdentification.secondaryBusinessActivity.activity

String

Atividade

data.completeIdentification.secondaryBusinessActivity.cnae

String

Código CNAE

data.completeIdentification.otherBusinessActivities

Objeto

Outra atividade empresarial

data.completeIdentification.otherBusinessActivities.activity

String

Atividade

data.completeIdentification.otherBusinessActivities.cnae

String

Código CNAE

data.completeIdentification.branchQuantity

String

Quantidade de filiais

data.completeIdentification.branches

String

Lista de filiais

data.completeIdentification.fgts

Objeto

FGTS

data.completeIdentification.fgts.status

String

Status do FGTS

data.completeIdentification.fgts.validityDate

String

Data de validade

data.completeIdentification.fgts.inquiryDate

String

Data da consulta

data.completeLocation

Objeto

Um bloco que fornece uma visão consolidada da localização da empresa

data.completeLocation.headOffice

Objeto

Um bloco que fornece uma visão consolidada da matriz da empresa

data.completeLocation.headOffice.headOfficeAddress

String

Endereço

data.completeLocation.headOffice.headOfficeComplement

String

Complemento

data.completeLocation.headOffice.headOfficeIbgeCode

String

Código IBGE

data.completeLocation.headOffice.headOfficeNeighborhood

String

Bairro

data.completeLocation.headOffice.headOfficeZipCode

String

CEP

data.completeLocation.headOffice.headOfficeCity

String

Cidade

data.completeLocation.headOffice.headOfficeState

String

Estado

data.completeLocation.headOffice.headOffice

Objeto

Um bloco que fornece uma lista de números de telefone da matriz da empresa

data.completeLocation.headOffice.headOffice.phoneNumber

String

Número de telefone

data.completeLocation.headOffice.branch

Array

Uma lista contendo informações sobre as filiais da empresa

data.completeLocation.headOffice.branch[x].branchAddress

String

Endereço

data.completeLocation.headOffice.branch[x].branchComplement

String

Complemento

data.completeLocation.headOffice.branch[x].branchIbgeCode

String

Código IBGE

data.completeLocation.headOffice.branch[x].branchNeighborhood

String

Bairro

data.completeLocation.headOffice.branch[x].branchZipCode

String

CEP

data.completeLocation.headOffice.branch[x].branchCity

String

Cidade

data.completeLocation.headOffice.branch[x].branchState

String

Estado

data.completeLocation.headOffice.branch[x].branchPhone

Objeto

Um bloco que fornece uma lista de números de telefone das filiais da empresa

data.completeLocation.headOffice.branch[x].branchPhone.phoneNumber

String

Número de telefone

data.consultedCompanyParticipations

Array

Uma lista contendo informações sobre participações em empresas consultadas

data.consultedCompanyParticipations.participatedCompanyName

String

Nome da empresa

data.consultedCompanyParticipations.participatedCnpj

String

CNPJ

data.consultedCompanyParticipations.cnpjStatus

String

Status do CNPJ

data.consultedCompanyParticipations.participation

String

Percentual de participação

data.consultedCompanyParticipations.entry

String

Data de entrada

data.consultedCompanyParticipations.debtIndicator

String

Indicador de dívida

data.consultedCompanyParticipations.fraudIndicator

String

Indicador de fraude

data.consultedCompanyParticipations.documentRestrictions

Objeto

Restrições documentais

data.consultedCompanyParticipations.documentRestrictions.pendingRestrictions

Objeto

Restrições pendentes

data.consultedCompanyParticipations.documentRestrictions.pendingRestrictions.quantity

String

Quantidade total

data.consultedCompanyParticipations.documentRestrictions.pendingRestrictions.last

String

Data do último registro

data.consultedCompanyParticipations.documentRestrictions.pendingRestrictions.amount

String

Valor

data.consultedCompanyParticipations.documentRestrictions.nonSufficientFundsChecks

Objeto

Cheques sem fundos

data.consultedCompanyParticipations.documentRestrictions.nonSufficientFundsChecks.quantity

String

Quantidade total

data.consultedCompanyParticipations.documentRestrictions.nonSufficientFundsChecks.last

String

Data do último registro

data.consultedCompanyParticipations.documentRestrictions.nonSufficientFundsChecks.amount

String

Valor

data.consultedCompanyParticipations.documentRestrictions.protests

Objeto

Protestos

data.consultedCompanyParticipations.documentRestrictions.protests.quantity

String

Quantidade total

data.consultedCompanyParticipations.documentRestrictions.protests.last

String

Data do último registro

data.consultedCompanyParticipations.documentRestrictions.protests.amount

String

Valor

data.consultedCompanyParticipations.documentRestrictions.judicialActions

Objeto

Ações judiciais

data.consultedCompanyParticipations.documentRestrictions.judicialActions.quantity

String

Quantidade total

data.consultedCompanyParticipations.documentRestrictions.judicialActions.last

String

Data do último registro

data.consultedCompanyParticipations.documentRestrictions.judicialActions.amount

String

Valor

data.consultedCompanyParticipations.documentRestrictions.bankruptciesAndJudicialRecoveries

Objeto

Falências e recuperações judiciais

data.consultedCompanyParticipations.documentRestrictions.bankruptciesAndJudicialRecoveries.quantity

String

Quantidade total

data.consultedCompanyParticipations.documentRestrictions.bankruptciesAndJudicialRecoveries.last

String

Data do último registro

data.consultedCompanyParticipations.documentRestrictions.bankruptciesAndJudicialRecoveries.amount

String

Valor

data.consultedCompanyParticipations.documentRestrictions.inquiries

Objeto

Consultas

data.participaçõesDaEmpresaConsultada.restriçõesDocumentais.consultas.quantidade

String

Quantidade total

data.participaçõesDaEmpresaConsultada.restriçõesDocumentais.consultas.última

String

Data do último registro

data.participaçõesDaEmpresaConsultada.restriçõesDocumentais.consultas.valor

String

Valor

data.participaçõesEmOutrasEmpresas

Array

Uma lista contendo informações sobre participações em outras empresas

data.participaçõesEmOutrasEmpresas[x].nomeDaEmpresaParticipada

String

Nome da empresa

data.participaçõesEmOutrasEmpresas[x].cnpjDaEmpresaParticipada

String

CNPJ

data.participaçõesEmOutrasEmpresas[x].statusDoCnpj

String

Status do CNPJ

data.participaçõesEmOutrasEmpresas[x].participação

String

Percentual de participação

data.participaçõesEmOutrasEmpresas[x].entrada

String

Data de entrada

data.participaçõesEmOutrasEmpresas[x].indicadorDeDívida

String

Indicador de dívida

data.participaçõesEmOutrasEmpresas[x].indicadorDeFraude

String

Indicador de fraude

data.participaçõesDeSóciosOuAdministradoresEmOutrasEmpresas

Array

Uma lista contendo informações sobre participações de sócios ou administradores em outras empresas

data.participaçõesDeSóciosOuAdministradoresEmOutrasEmpresas.nomeDoSócio

String

Nome

data.participaçõesDeSóciosOuAdministradoresEmOutrasEmpresas.cpf

String

CPF

data.participaçõesDeSóciosOuAdministradoresEmOutrasEmpresas.sóciosParticipantes

Array

Uma lista contendo detalhes sobre participações dos sócios

data.participaçõesDeSóciosOuAdministradoresEmOutrasEmpresas.sóciosParticipantes[x].nomeDaEmpresa

String

Nome da empresa

data.participaçõesDeSóciosOuAdministradoresEmOutrasEmpresas.sóciosParticipantes[x].cnpj

String

CNPJ

data.participaçõesDeSóciosOuAdministradoresEmOutrasEmpresas.sóciosParticipantes[x].statusDoCnpj

String

Status do CNPJ

data.participaçõesDeSóciosOuAdministradoresEmOutrasEmpresas.sóciosParticipantes[x].participação

String

Percentual de participação

data.participaçõesDeSóciosOuAdministradoresEmOutrasEmpresas.sóciosParticipantes[x].entrada

String

Data de entrada

data.participaçõesDeSóciosOuAdministradoresEmOutrasEmpresas.sóciosParticipantes[x].indicadorDeDívida

String

Indicador de dívida

data.participaçõesDeSóciosOuAdministradoresEmOutrasEmpresas.sóciosParticipantes[x].indicadorDeFraude

String

Indicador de fraude

data.participaçõesDeSóciosOuAdministradoresEmOutrasEmpresas.sóciosParticipantes[x].restriçõesDocumentais

Objeto

Restrições documentais

data.participaçõesDeSóciosOuAdministradoresEmOutrasEmpresas.sóciosParticipantes[x].restriçõesDocumentais.restriçõesPendentes

Objeto

Restrições pendentes

data.participaçõesDeSóciosOuAdministradoresEmOutrasEmpresas.sóciosParticipantes[x].restriçõesDocumentais.restriçõesPendentes.quantidade

String

Quantidade total

data.participaçõesDeSóciosOuAdministradoresEmOutrasEmpresas.sóciosParticipantes[x].restriçõesDocumentais.restriçõesPendentes.última

String

Data do último registro

data.participaçõesDeSóciosOuAdministradoresEmOutrasEmpresas.sóciosParticipantes[x].restriçõesDocumentais.restriçõesPendentes.valor

String

Valor

data.participaçõesDeSóciosOuAdministradoresEmOutrasEmpresas.sóciosParticipantes[x].restriçõesDocumentais.chequesSemFundos

Objeto

Cheques sem fundos

data.participaçõesDeSóciosOuAdministradoresEmOutrasEmpresas.sóciosParticipantes[x].restriçõesDocumentais.chequesSemFundos.quantidade

String

Quantidade total

data.participaçõesDeSóciosOuAdministradoresEmOutrasEmpresas.sóciosParticipantes[x].restriçõesDocumentais.chequesSemFundos.última

String

Data do último registro

data.participaçõesDeSóciosOuAdministradoresEmOutrasEmpresas.sóciosParticipantes[x].restriçõesDocumentais.chequesSemFundos.valor

String

Valor

data.participaçõesDeSóciosOuAdministradoresEmOutrasEmpresas.sóciosParticipantes[x].restriçõesDocumentais.protestos

Objeto

Protestos

data.participaçõesDeSóciosOuAdministradoresEmOutrasEmpresas.sóciosParticipantes[x].restriçõesDocumentais.protestos.quantidade

String

Quantidade total

data.participaçõesDeSóciosOuAdministradoresEmOutrasEmpresas.sóciosParticipantes[x].restriçõesDocumentais.protestos.última

String

Data do último registro

data.participaçõesDeSóciosOuAdministradoresEmOutrasEmpresas.sóciosParticipantes[x].restriçõesDocumentais.protestos.valor

String

Valor

data.participaçõesDeSóciosOuAdministradoresEmOutrasEmpresas.sóciosParticipantes[x].restriçõesDocumentais.açõesJudiciais

Objeto

Ações judiciais

data.participaçõesDeSóciosOuAdministradoresEmOutrasEmpresas.sóciosParticipantes[x].restriçõesDocumentais.açõesJudiciais.quantidade

String

Quantidade total

data.participaçõesDeSóciosOuAdministradoresEmOutrasEmpresas.sóciosParticipantes[x].restriçõesDocumentais.açõesJudiciais.última

String

Data do último registro

data.participaçõesDeSóciosOuAdministradoresEmOutrasEmpresas.sóciosParticipantes[x].restriçõesDocumentais.açõesJudiciais.valor

String

Valor

data.participaçõesDeSóciosOuAdministradoresEmOutrasEmpresas.sóciosParticipantes[x].restriçõesDocumentais.falênciasERecuperaçõesJudiciais

Objeto

Falências e recuperações judiciais

data.participaçõesDeSóciosOuAdministradoresEmOutrasEmpresas.sóciosParticipantes[x].restriçõesDocumentais.falênciasERecuperaçõesJudiciais.quantidade

String

Quantidade total

data.participaçõesDeSóciosOuAdministradoresEmOutrasEmpresas.sóciosParticipantes[x].restriçõesDocumentais.falênciasERecuperaçõesJudiciais.última

String

Data do último registro

data.participaçõesDeSóciosOuAdministradoresEmOutrasEmpresas.sóciosParticipantes[x].restriçõesDocumentais.falênciasERecuperaçõesJudiciais.valor

String

Valor

data.participaçõesDeSóciosOuAdministradoresEmOutrasEmpresas.sóciosParticipantes[x].restriçõesDocumentais.consultas

Objeto

Consultas

data.participaçõesDeSóciosOuAdministradoresEmOutrasEmpresas.sóciosParticipantes[x].restriçõesDocumentais.consultas.quantidade

String

Quantidade total

data.participaçõesDeSóciosOuAdministradoresEmOutrasEmpresas.sóciosParticipantes[x].restriçõesDocumentais.consultas.última

String

Data do último registro

data.participaçõesDeSóciosOuAdministradoresEmOutrasEmpresas.sóciosParticipantes[x].restriçõesDocumentais.consultas.valor

String

Valor

data.restriçõesPendentes

Objeto

Um bloco que fornece uma visão consolidada sobre restrições pendentes

data.restriçõesPendentes.totalDePendências

String

Total de pendências

data.restriçõesPendentes.totalDeCredores

String

Total de credores

data.restriçõesPendentes.valor

String

Valor

data.restriçõesPendentes.períodoInicial

String

Período inicial

data.restriçõesPendentes.períodoFinal

String

Período final

data.restriçõesPendentes.primeiroValor

String

Primeiro valor pendente

data.restriçõesPendentes.primeiraData

String

Primeira data pendente

data.restriçõesPendentes.maiorValor

String

Maior valor pendente

data.restriçõesPendentes.maiorData

String

Maior data pendente

data.restriçõesPendentes.últimasOcorrências

Array

Uma lista contendo informações sobre as últimas restrições pendentes

data.restriçõesPendentes.últimasOcorrências[x].informante

String

Informante

data.restriçõesPendentes.últimasOcorrências[x].tipo

String

Tipo

data.restriçõesPendentes.últimasOcorrências[x].cidade

String

Cidade

data.restriçõesPendentes.últimasOcorrências[x].estado

String

Estado

data.restriçõesPendentes.últimasOcorrências[x].documentoDeOrigem

String

Origem do documento

data.restriçõesPendentes.últimasOcorrências[x].dataDoDébito

String

Data do débito

data.restriçõesPendentes.últimasOcorrências[x].disponívelEm

String

disponível em

data.restriçõesPendentes.últimasOcorrências[x].valor

String

Valor

data.protestos

Objeto

Um bloco que fornece uma visão consolidada sobre protestos

data.protestos.totalDeProtestos

String

Total de protestos

data.protestos.valorTotal

String

Valor total dos protestos

data.protestos.primeiroValor

String

Primeiro valor de protesto

data.protestos.primeiraData

String

Primeira data de protesto

data.protestos.maiorValor

String

Maior valor de protesto

data.protestos.maiorData

String

Maior data de protesto

data.protestos.últimasOcorrências

Array

Uma lista contendo informações sobre os últimos protestos

data.protestos.últimasOcorrências[x].data

String

Data

data.protestos.últimasOcorrências[x].dataDeVencimento

String

Data de vencimento

data.protestos.últimasOcorrências[x].cartório

String

Cartório

data.protestos.últimasOcorrências[x].cidade

String

Cidade

data.protestos.últimasOcorrências[x].estado

String

Estado

data.protestos.últimasOcorrências[x].valor

String

Valor

data.score

Objeto

Score de crédito

data.score.score

Inteiro

Classificação da pontuação

data.score.mensagemDaPontuação

String

Contexto da recomendação para tomada de decisão

data.score.probabilidade

String

Probabilidade

data.score.classificaçãoNumérica

String

Classificação numérica

data.score.classificaçãoAlfabética

String

Classificação alfabética

data.sócios

Objeto

Um bloco que fornece uma visão consolidada sobre sócios

data.sócios.nomeDaEmpresa

String

Nome da empresa

data.sócios.cpfCnpj

String

CNP/CNPJ

data.sócios.tipoDeDocumento

String

Tipo de documento

data.sócios.statusDoDocumento

String

Status do documento

data.sócios.participação

String

Percentual de participação

data.sócios.dataDeEntrada

String

Data de entrada

data.sócios.assinaPelaEmpresa

String

Assina pela empresa

data.sócios.indicadorDeDívida

String

Indicador de dívida

data.sócios.indicadorDeFraude

String

Indicador de fraude

data.sócios.restriçõesDocumentais

Objeto

Restrições documentais

data.sócios.restriçõesDocumentais.restriçõesPendentes

Objeto

Restrições pendentes

data.sócios.restriçõesDocumentais.restriçõesPendentes.quantidade

String

Quantidade total

data.sócios.restriçõesDocumentais.restriçõesPendentes.última

String

Data do último registro

data.sócios.restriçõesDocumentais.restriçõesPendentes.valor

String

Valor

data.sócios.restriçõesDocumentais.chequesSemFundos

Objeto

Cheques sem fundos

data.sócios.restriçõesDocumentais.chequesSemFundos.quantidade

String

Quantidade total

data.sócios.restriçõesDocumentais.chequesSemFundos.última

String

Data do último registro

data.sócios.restriçõesDocumentais.chequesSemFundos.valor

String

Valor

data.sócios.restriçõesDocumentais.protestos

Objeto

Protestos

data.sócios.restriçõesDocumentais.protestos.quantidade

String

Quantidade total

data.sócios.restriçõesDocumentais.protestos.última

String

Data do último registro

data.sócios.restriçõesDocumentais.protestos.valor

String

Valor

data.sócios.restriçõesDocumentais.açõesJudiciais

Objeto

Ações judiciais

data.sócios.restriçõesDocumentais.açõesJudiciais.quantidade

String

Quantidade total

data.sócios.restriçõesDocumentais.açõesJudiciais.última

String

Data do último registro

data.sócios.restriçõesDocumentais.açõesJudiciais.valor

String

Valor

data.sócios.restriçõesDocumentais.falênciasERecuperaçõesJudiciais

Objeto

Falências e recuperações judiciais

data.sócios.restriçõesDocumentais.falênciasERecuperaçõesJudiciais.quantidade

String

Quantidade total

data.sócios.restriçõesDocumentais.falênciasERecuperaçõesJudiciais.última

String

Data do último registro

data.sócios.restriçõesDocumentais.falênciasERecuperaçõesJudiciais.valor

String

Valor

data.sócios.restriçõesDocumentais.consultas

Objeto

Consultas

data.sócios.restriçõesDocumentais.consultas.quantidade

String

Quantidade total

data.sócios.restriçõesDocumentais.consultas.última

String

Data do último registro

data.sócios.restriçõesDocumentais.consultas.valor

String

Valor

data.situaçãoDoConsumidor

Objeto

Situação do consumidor

data.situaçãoDoConsumidor.mensagem

String

Mensagem da situação do consumidor

Regra
Descrição

credit_score_available

A regra se tornará inválida se o score de crédito não estiver disponível.

credit_score_below

A regra se tornará inválida se o score de crédito estiver abaixo do valor definido.

credit_score_over

A regra se tornará inválida se o score de crédito estiver acima do valor definido.

credit_score_between

A regra se tornará inválida se o score de crédito estiver entre os valores definidos.

Atualizado