Financeiro

Lista de Devedores da PGFN (PF94)

Retorna se o CPF consultado está inscrito em dívidas ativas junto à PGFN.

Seção: pfPgfnDebtors

Parâmetro obrigatório: cpf

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": "01",
  "data": {
    "message": "Consulta realizada com sucesso.",
    "hasDebts": false,
    "debtValue": "0"
  }
}

Regra

Descrição

has_debts_on_pgfn

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

Estimativa de Patrimônio e Renda (PF24)

Retorna uma estimativa da renda e do patrimônio da pessoa calculada por diferentes variáveis a partir de consultas públicas disponíveis.

Seção: pfFinantialData

Parâmetro obrigatório: cpf

Parâmetro opcional: birthDate Esta informação é exigida em algumas fontes para concluir a execução de menores de idade

Atributo

Tipo

Descrição

statusCode

String

Status da consulta (detalhes)

data

Objeto

Dados de retorno

data.totalAssets

String

Patrimônio total estimado do indivíduo

data.taxReturns

Array

Lista de objetos com o histórico de restituições do imposto de renda

data.taxReturns[x].year

String

Ano da declaração

data.taxReturns[x].status

String

Status da declaração

data.taxReturns[x].bank

String

Banco utilizado na declaração

data.taxReturns[x].captureDate

String

Data da captura

data.taxReturns[x].lastUpdateDate

String

Data da última atualização

data.incomeEstimates

Objeto

Renda estimada

data.incomeEstimates.mte

String

Renda estimada conforme o MTE

data.incomeEstimates.ibge

String

Renda estimada conforme o IBGE

data.incomeEstimates.companyOwnership

String

Renda estimada mesmo sem histórico de trabalho formal

data.lastUpdateDate

String

Data da última atualização

{
  "statusCode": "01",
  "data": {
    "totalAssets": "ABAIXO DE 100K",
    "taxReturns": [
      {
        "year": "2021",
        "status": "SUA DECLARACAO NAO CONSTA NA BASE DE DADOS DA RECEITA FEDERAL",
        "bank": "",
        "branch": "0000",
        "batch": "",
        "isVipBranch": "false",
        "captureDate": "2021-11-28T00:00:00Z",
        "creationDate": "2021-11-28T00:00:00Z",
        "lastUpdateDate": "2021-11-28T00:00:00Z"
      }
    ],
    "incomeEstimates": {
      "mte": "SEM INFORMACAO",
      "ibge": "SEM INFORMACAO",
      "companyOwnership": "SEM INFORMACAO"
    },
    "lastUpdateDate": "2022-10-22T00:00:00Z"
  }
}

Regra

Descrição

is_less_than_two_salaries

Verifica se a renda estimada é menor que dois (02) salários mínimos.

is_between_two_and_four_salaries

Verifica se a renda estimada está entre dois (02) e quatro (04) salários mínimos.

is_more_than_four_salaries

Verifica se a renda estimada está acima de quatro (04) salários mínimos.

has_salary_information

Verifica se foram encontradas informações sobre a renda estimada.

Quadro Geral de Inabilitados - Banco Central do Brasil (PF44)

Retorna, se constar no Quadro Geral de Inabilitados do Banco Central do Brasil, informações sobre a inabilitação.

Seção: pfBacenQgi

Parâmetros obrigatórios: cpf

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.disabledList

Array

Lista de objetos com os dados da inabilitação

data.disabledList[x].pas

String

PAS (Processo Administrativo Sancionador)

data.disabledList[x].name

String

Nome

data.disabledList[x].cpf

String

CPF

data.disabledList[x].penalty

String

Penalidade

data.disabledList[x].publicationDate

String

Data da publicação

data.disabledList[x].penaltyDeadline

String

Prazo da penalidade

{
  "statusCode": "01",
  "data": {
    "message": "O CPF não consta no quadro geral de inabilitados junto ao BACEN."
  }
}

Regra

Descrição

disabled_on_bacen

Verifica se o CPF consultado não está autorizado pelo Banco Central.

Associado à CVM (PF47)

Retorna informações de CPF relacionadas a instituições financeiras

Seção: pfAssociatedCvm

Parâmetro obrigatório: cpf

Atributo

Tipo

Descrição

statusCode

String

Status da consulta (detalhes)

data

Objeto

Dados de retorno

data.message

String

Descritivo com o status da consulta

data.associates

Array

Descreve os dados dos tipos de registro 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

Situação cadastral

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": "01",
  "data": {
    "message": "Não foram encontrados participantes para esta consulta."
  }
}

Regra

Descrição

has_no_participant_cvm

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

Renda Ibope (PF50)

Retorna informações sobre a renda domiciliar / renda Ibope de uma pessoa

Seção: pfIbopeIncome

Parâmetro obrigatório: cpf

Atributo

Tipo

Descrição

statusCode

String

Status da consulta (detalhes)

data

Objeto

Dados de retorno

data.message

String

Descritivo com a situação da consulta

data.ibopeIncome

Ponto flutuante

valor da renda Ibope

{
  "statusCode": "01",
  "data": {
    "message": "Consulta realizada com sucesso",
    "ibopeIncome": 0
  }
}

Regra

Descrição

has_no_ibope_income

Verifica a renda Ibope de um CPF.

Renda Estimada (PF51)

Retorna informações de renda estimada de uma pessoa

Seção: pfEstimatedIncome

Parâmetro obrigatório: cpf

Atributo

Tipo

Descrição

statusCode

String

Status da consulta (detalhes)

data

Objeto

Dados de retorno

data.message

String

Descritivo com o status da consulta

data.estimatedIncome

Ponto flutuante

Valor estimado de renda

{
  "statusCode": "01",
  "data": {
    "message": "Consulta realizada com sucesso",
    "estimatedIncome": 0000
  }
}

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

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

Seção: pfCreditOperationScr

Parâmetros obrigatórios: CPF, PF

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

CPF

data.registrationDate

Data

Data de registro

data.baseDate

Data

Data-base da 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 à base 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

{
  "statusCode": "01",
  "data": {
    "message": "Consulta realizada com sucesso",
    "clientCode": "0XX52XX90XX",
    "registrationDate": "2020-05-08",
    "baseDate": "2022-10",
    "assumedCoobligation": 0,
    "receivedCoobligation": 0,
    "processedVolumePercentage": 99.98,
    "totalOfTransactions": "3",
    "totalDisagreementTransactions": "0",
    "totalSubJudiceTransactions": "0",
    "fullLiabilityDisagreement": "0",
    "fullLiabilitySubJudice": "0",
    "indirectVendorRisk": "0.00",
    "operationSumaryList": [
      {
        "modalityCategoryCode": "13",
        "modalityCategoryDescription": "Outros créditos",
        "modalitySubCategoryCode": "XXXX",
        "modalitySubCategoryDescription": "cartão de crédito - compra à vista e parcelado lojista ",
        "listOfDebts": [
          {
            "expirationCode": "140",
            "expirationDescription": "Créditos a vencer de 91 a 180 dias",
            "value": "XX.94"
          },
          {
            "expirationCode": "150",
            "expirationDescription": "Créditos a vencer de 181 a 360 dias ",
            "value": "XX.37"
          },
          {
            "expirationCode": "110",
            "expirationDescription": "Créditos a vencer até 30 dias",
            "value": "XX.92"
          },
          {
            "expirationCode": "120",
            "expirationDescription": "Créditos a vencer de 31 a 60 dias",
            "value": "XX.54"
          },
          {
            "expirationCode": "130",
            "expirationDescription": "Créditos a vencer de 61 a 90 dias",
            "value": "XX.93"
          }
        ]
      }
    ]
  }
}

Penalidades Temporárias na CVM (PF93)

Consulta a lista de Penalidades Temporárias da CVM para verificar se o participante está temporariamente impedido de operar no mercado de capitais devido a uma decisão em um Processo Administrativo Sancionador

Seção: pfPenaltiesOnCvm

Parâmetros obrigatórios: 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.result

Objeto

Detalhes dos participantes penalizados

data.result.processNumber

String

Número do processo

data.result.name

String

Participante

data.result.decisionType

String

Tipo de decisão

data.result.judgementDate

String

Data da decisão da CVM

data.result.effectiveDate

String

Data de vigência da penalidade

data.result.timeOfWithdrawal

String

Tempo de afastamento

data.result.decisionLink

String

Link da decisão

{
  "statusCode": "01",
  "data": {
    "message": "Consulta realizada com sucesso.",
    "result": {
      "processNumber": "01/2005",
      "name": "MASSA FALIDA DO BANCO SANTOS S.A.",
      "decisionType": "Inabilitação",
      "judgementDate": "26/11/2008",
      "effectiveDate": "25/07/2014",
      "timeOfDeparture": "20 anos",
      "decisionLink": "http://conteudo.cvm.gov.br/sancionadores/sancionador/2008/20081126_0105.html"
    }
  }
}

Regra

Descrição

has_penalties_on_cvm

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

Score de Crédito - NOVO (PF87)

Retorna o score de crédito de um consumidor 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: pfCreditScore

Parâmetro obrigatório: cpf

Atributo

Tipo

Descrição

statusCode

String

Status da consulta (detalhes)

message

String

Descritivo com o 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

{
  "statusCode": "01",
  "message": "Consulta realizada com sucesso.",
  "data": {
    "score": 777,
    "scoreMessage":
      "É provável que 96% das pessoas com esse mesmo comportamento, paguem suas contas nos próximos 6 meses.",
  }
}

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 (PF88)

Retorna uma avaliação abrangente da saúde financeira de um indivíduo, fornecendo seu score de crédito e um perfil financeiro detalhado. Aproveitando uma ampla variedade de dados, incluindo dívidas registradas, histórico de consultas, protestos, retornos e histórico bancário, além de dados complementares como vínculos com empresas e registros de falência, entrega uma análise preditiva da capacidade de pagamento atual e futura. Esta solução permite acesso a uma visão financeira confiável e completa, sendo 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: pfCreditProfileDetails

Parâmetro obrigatório: cpf

Atributo

Tipo

Descrição

statusCode

String

Status da consulta (detalhes)

message

String

Descritivo com o status da consulta

data

Objeto

Dados de retorno

data.civilActionsSummary

Objeto

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

data.civilActionsSummary.quantity

String

Quantidade total de ações cíveis

data.civilActionsSummary.initialPeriod

String

Período inicial das ações cíveis

data.civilActionsSummary.finalPeriod

String

Período final das ações cíveis

data.civilActionsList

Array

Lista contendo informações detalhadas sobre cada ação cível registrada

data.civilActionsList[x].court

String

Tribunal

data.civilActionsList[x].lawsuitNumber

String

Número da ação cível

data.civilActionsList[x].civilAction

String

Título da ação cível

data.civilActionsList[x].distributionDate

String

Data de distribuição da ação cível

data.civilActionsList[x].plaintiff

String

Autor da ação cível

data.civilActionsList[x].amount

String

Valor

data.civilActionsList[x].location

String

Local

data.civilActionsList[x].state

String

Estado

data.civilActionsList[x].municipalityCode

String

Código do município

data.debtOccurrencesSummary

Objeto

Bloco que fornece uma visão consolidada dos registros de dívidas

data.debtOccurrencesSummary.totalDebtor

String

Total de dívidas como devedor

data.debtOccurrencesSummary.totalGuarantor

String

Total de dívidas como fiador

data.debtOccurrencesSummary.accumulatedAmount

String

Valor acumulado das dívidas

data.debtOccurrencesSummary.firstDebtDate

String

Data da primeira dívida

data.debtOccurrencesSummary.firstDebtAmount

String

Valor da primeira dívida

data.debtOccurrencesSummary.largestDebtDate

String

Data da maior dívida

data.debtOccurrencesSummary.largestDebtAmount

String

Valor da maior dívida

data.debts

Array

Lista contendo informações detalhadas sobre cada dívida.

data.debts[x].occurrenceType

String

Tipo de ocorrência

data.debts[x].contract

String

Número do contrato da dívida

data.debts[x].occurrenceDate

String

Data da ocorrência da dívida

data.debts[x].availabilityDate

String

Data de disponibilidade da dívida

data.debts[x].currency

String

Tipo de moeda

data.debts[x].amount

String

Valor

data.debts[x].status

String

Status da dívida

data.debts[x].informer

String

Informante da dívida

data.debts[x].informedByConsultee

String

A dívida foi informada pelo consultado

data.debts[x].city

String

Cidade

data.debts[x].state

String

Estado

data.debts[x].condition

String

Condição da dívida

data.debts[x].municipalityCondition

String

Código da condição do município

data.previous90DaysInquiriesSummary

Objeto

Bloco que fornece uma visão consolidada dos registros dos 90 dias anteriores

data.previous90DaysInquiriesSummary.total

String

Total

data.previous90DaysInquiriesSummary.year

String

Ano

data.previous90DaysInquiriesSummary.month

String

mês

data.previousInquiries

Array

Lista contendo informações detalhadas sobre cada consulta anterior

data.previousInquiries[x].occurrenceType

String

Tipo de ocorrência

data.previousInquiries[x].date

String

Data da consulta

data.previousInquiries[x].amount

String

Valor

data.previousInquiries[x].currency

String

Tipo de moeda

data.previousInquiries[x].informer

String

Informante da consulta

data.previousInquiries[x].product

String

Produto da consulta

data.additionalAnfo

Array

Lista contendo informações adicionais

data.additionalAnfo[x].text

String

Texto das informações adicionais

data.additionalAnfo[x].originState

String

Estado de origem

data.additionalAnfo[x].origin

String

Origem das informações adicionais

data.additionalAnfo[x].type

String

Tipo

data.protestedBillsSummary

Objeto

Bloco que fornece uma visão consolidada dos registros de títulos protestados

data.protestedBillsSummary.total

String

Quantidade total de títulos protestados

data.protestedBillsSummary.initialPeriod

String

Período inicial dos títulos protestados

data.protestedBillsSummary.finalPeriod

String

Período final dos títulos protestados

data.protestedBillsSummary.currency

String

Tipo de moeda

data.protestedBillsSummary.accumulatedValue

String

Valor acumulado dos títulos protestados

data.protestedBills

Array

Lista contendo informações detalhadas sobre cada título protestado

data.protestedBills[x].occurrenceType

String

Tipo de ocorrência

data.protestedBills[x].notaryOffice

String

Cartório

data.protestedBills[x].occurrenceDate

String

Data da ocorrência do título protestado

data.protestedBills[x].currency

String

Tipo de moeda

data.protestedBills[x].amount

String

Valor

data.protestedBills[x].city

String

Cidade

data.protestedBills[x].state

String

Estado

data.cancelledCheckBook

Array

Lista contendo informações detalhadas sobre cada talão de cheques cancelado

data.cancelledCheckBook[x].occurrenceType

String

Tipo de ocorrência

data.cancelledCheckBook[x].documentType

String

Tipo de documento

data.cancelledCheckBook[x].documentNumber

String

Número do documento

data.cancelledCheckBook[x].bank

String

Banco

data.cancelledCheckBook[x].agency

String

Órgão

data.cancelledCheckBook[x].currentAccount

String

Número da conta corrente

data.cancelledCheckBook[x].check

String

Número do cheque

data.cancelledCheckBook[x].reasonCode

String

Alínea

data.cancelledCheckBook[x].occurrenceDate

String

Data da ocorrência do cancelamento

data.cancelledCheckBook[x].availabilityDate

String

Data de disponibilidade

data.cancelledCheckBook[x].informer

String

Informante

data.cancelledCheckBook[x].indicator

String

Indicador

data.ccfReportedReturnsSummary

Objeto

Bloco que fornece uma visão consolidada dos retornos informados pelos registros da CCF

data.ccfReportedReturnsSummary.documentType

String

Tipo de documento

data.ccfReportedReturnsSummary.documentNumber

String

Número do documento

data.ccfReportedReturnsSummary.name

String

Nome

data.ccfReportedReturnsSummary.totalNames

String

Total de nomes

data.ccfReportedReturnsSummary.totalReturns

String

Total de retornos

data.ccfReportedReturnsSummary.reason12

String

Motivo 12 - cheque sem fundos - 2ª apresentação

data.ccfReportedReturnsSummary.reason13

String

Motivo 13 - conta encerrada

data.ccfReportedReturnsSummary.reason14

String

Motivo 14 - prática espúria

data.ccfReportedReturnsSummary.reason99

String

Motivo 99 - instituição financeira não mais em atividade

data.ccfReportedReturnsList

Array

Lista contendo informações detalhadas sobre cada retorno informado pela CCF

data.ccfReportedReturnsList[x].documentType

String

Tipo de documento

data.ccfReportedReturnsList[x].documentNumber

String

Número do documento

data.ccfReportedReturnsList[x].name

String

Nome

data.ccfReportedReturnsList[x].bank

String

Banco

data.ccfReportedReturnsList[x].agency

String

Órgão

data.ccfReportedReturnsList[x].reason12

String

Motivo 12 - cheque sem fundos - 2ª apresentação

data.ccfReportedReturnsList[x].lastOccurrenceDate12

String

Data da última ocorrência - motivo 12

data.ccfReportedReturnsList[x].reason13

String

Motivo 13 - conta encerrada

data.ccfReportedReturnsList[x].lastOccurrenceDate13

String

Data da última ocorrência - motivo 13

data.ccfReportedReturnsList[x].reason14

String

Motivo 14 - prática espúria

data.ccfReportedReturnsList[x].lastOccurrenceDate14

String

Data da última ocorrência - motivo 14

data.ccfReportedReturnsList[x].reason99

String

Motivo 99 - instituição financeira não mais em atividade

data.ccfReportedReturnsList[x].lastOccurrenceDate99

String

Data da última ocorrência - motivo 99

data.ccfReportedReturnsList[x].bankName

String

Nome do banco

data.previousCheckInquiriesSummary

Objeto

Um bloco que fornece uma visão consolidada dos registros de consultas bancárias anteriores

data.previousCheckInquiriesSummary.documentType

String

Tipo de documento

data.previousCheckInquiriesSummary.documentNumber

String

Número do documento

data.previousCheckInquiriesSummary.total

String

Quantidade total de consultas bancárias anteriores

data.previousCheckInquiriesSummary.amount

String

Valor

data.previousCheckInquiriesSummary.day

String

Dia

data.previousCheckInquiriesSummary.dailyValue

String

Valor diário

data.previousCheckInquiriesSummary.postdated

String

Pós-datada

data.previousCheckInquiriesSummary.postdatedValue

String

Valor pós-datado

data.previousCheckInquiries

Array

Uma lista contendo informações detalhadas sobre cada consulta bancária anterior

data.previousCheckInquiries[x].documentType

String

Tipo de documento

data.previousCheckInquiries[x].documentNumber

String

Número do documento

data.previousCheckInquiries[x].type

String

Tipo

data.previousCheckInquiries[x].creditDate

String

Data do crédito

data.previousCheckInquiries[x].creditTime

String

Hora do crédito

data.previousCheckInquiries[x].currency

String

Tipo de moeda

data.previousCheckInquiries[x].amount

String

Valor

data.previousCheckInquiries[x].informer

String

Informante

data.phoneConfirmation

Array

Uma lista contendo informações detalhadas sobre cada confirmação telefônica

data.phoneConfirmation[x].areaCode

String

Código de área

data.phoneConfirmation[x].phoneNumber

String

Número de telefone

data.phoneConfirmation[x].documentType

String

Tipo de documento

data.phoneConfirmation[x].documentNumber

String

Número do documento

data.phoneConfirmation[x].name

String

Nome

data.phoneConfirmation[x].neighborhood

String

Bairro

data.phoneConfirmation[x].postalCode

String

CEP

data.phoneConfirmation[x].city

String

Cidade

data.phoneConfirmation[x].state

String

Estado

data.bankBranchContactDetails

Array

Uma lista contendo informações detalhadas sobre cada contato de agência bancária

data.bankBranchContactDetails[x].bank

String

Banco

data.bankBranchContactDetails[x].bankName

String

Nome do banco

data.bankBranchContactDetails[x].agency

String

Órgão

data.bankBranchContactDetails[x].branchName

String

Nome da agência

data.bankBranchContactDetails[x].address

String

Endereço

data.bankBranchContactDetails[x].neighborhood

String

Bairro

data.bankBranchContactDetails[x].postalCode

String

CEP

data.bankBranchContactDetails[x].city

String

Cidade

data.bankBranchContactDetails[x].state

String

Estado

data.bankBranchContactDetails[x].location

String

Local

data.bankBranchContactDetails[x].areaCode

String

Código de área

data.bankBranchContactDetails[x].phoneNumber1

String

Número de telefone 1

data.bankBranchContactDetails[x].phoneNumber2

String

Número de telefone 2

data.bankBranchContactDetails[x].reserved

String

Reservado

data.postalCodeConfirmation

Objeto

Um bloco que fornece uma visão consolidada da confirmação do CEP

data.postalCodeConfirmation.postalCode

String

CEP

data.postalCodeConfirmation.address

String

Endereço

data.postalCodeConfirmation.neighborhood

String

Bairro

data.postalCodeConfirmation.city

String

Cidade

data.postalCodeConfirmation.state

String

Estado

data.documentName

Array

Uma lista contendo informações detalhadas sobre cada documento

data.documentName[x].name

String

Nome

data.documentName[x].birthDate

String

Data de nascimento

data.documentName[x].document

String

documento

data.documentName[x].documentType

String

Tipo de documento

data.documentName[x].documentNumber

String

Número do documento

data.checkAdditionalInformation

Array

Uma lista contendo informações adicionais detalhadas sobre cheques bancários

data.checkAdditionalInformation[x].documentType

String

Tipo de documento

data.checkAdditionalInformation[x].documentNumber

String

Número do documento

data.checkAdditionalInformation[x].text

String

Texto das informações adicionais

data.userReportedReturnsSummary

Objeto

Devoluções informadas pelo usuário

data.userReportedReturnsSummary.documentType

String

Tipo de documento

data.userReportedReturnsSummary.documentNumber

String

Número do documento

data.userReportedReturnsSummary.total

String

Total

data.userReportedReturnsSummary.firstReturnDate

String

Data da primeira devolução

data.userReportedReturnsSummary.lastReturnDate

String

Data da última devolução

data.userReportedReturns

Array

Uma lista contendo informações detalhadas sobre cada devolução informada pelo usuário

data.userReportedReturns[x].documentType

String

Tipo de documento

data.userReportedReturns[x].document

String

Número do documento

data.userReportedReturns[x].bank

String

Banco

data.userReportedReturns[x].agency

String

Órgão

data.userReportedReturns[x].currentAccount

String

Número da conta corrente

data.userReportedReturns[x].initialCheck

String

Cheque bancário inicial

data.userReportedReturns[x].finalCheck

String

Cheque bancário final

data.userReportedReturns[x].reason

String

Motivo

data.userReportedReturns[x].reasonCode

String

Código do motivo

data.userReportedReturns[x].occurrenceDate

String

Data da ocorrência

data.userReportedReturns[x].registrationDate

String

Data de registro

data.userReportedReturns[x].currency

String

Tipo de moeda

data.userReportedReturns[x].amount

String

Valor

data.userReportedReturns[x].reporterCode

String

Código do informante

data.userReportedReturns[x].informer

String

Informante

data.userReportedReturns[x].city

String

Cidade

data.userReportedReturns[x].state

String

Estado

data.checksCancelledReason21

Array

Uma lista contendo informações detalhadas sobre cada cheque bancário cancelado pelo motivo 21 - cancelado ou revogado

data.checksCancelledReason21[x].documentType

String

Tipo de documento

data.checksCancelledReason21[x].documentNumber

String

Número do documento

data.checksCancelledReason21[x].bank

String

Banco

data.checksCancelledReason21[x].agency

String

Órgão

data.checksCancelledReason21[x].currentAccount

String

Número da conta corrente

data.checksCancelledReason21[x].initialCheck

String

Cheque bancário inicial

data.checksCancelledReason21[x].finalCheck

String

Cheque bancário final

data.checksCancelledReason21[x].reasonCode

String

Código do motivo

data.checksCancelledReason21[x].occurrenceDate

String

Data da ocorrência

data.checksCancelledReason21[x].availabilityDate

String

Data de disponibilidade

data.checksCancelledReason21[x].currency

String

Tipo de moeda

data.checksCancelledReason21[x].amount

String

Valor

data.checksCancelledReason21[x].informer

String

Informante

data.reportedCheckHistory

Array

Uma lista contendo informações detalhadas sobre cada cheque informado

data.reportedCheckHistory[x].documentType

String

Tipo de documento

data.reportedCheckHistory[x].documentNumber

String

Número do documento

data.reportedCheckHistory[x].bank

String

Banco

data.reportedCheckHistory[x].agency

String

Órgão

data.reportedCheckHistory[x].currentAccount

String

Número da conta corrente

data.reportedCheckHistory[x].check

String

Número do cheque

data.reportedCheckHistory[x].inquiryDate

String

Data da consulta

data.reportedCheckHistory[x].inquiryTime

String

Hora da consulta

data.reportedCheckHistory[x].network

String

Rede

data.reportedCurrentAccountHistory

Array

Uma lista contendo informações detalhadas sobre cada conta corrente informada

data.reportedCurrentAccountHistory[x].bank

String

Banco

data.reportedCurrentAccountHistory[x].agency

String

Órgão

data.reportedCurrentAccountHistory[x].currentAccount

String

Número da conta corrente

data.reportedCurrentAccountHistory[x].documentType

String

Tipo de documento

data.reportedCurrentAccountHistory[x].documentNumber

String

Número do documento

data.reportedCurrentAccountHistory[x].inquiryDate

String

Data da consulta

data.reportedCurrentAccountHistory[x].inquiryTime

String

Hora da consulta

data.participationsOfConsultedDocument

Array

Uma lista contendo informações detalhadas sobre cada participação de documento consultado

data.participationsOfConsultedDocument[x].documentTypeA

String

Tipo de documento

data.participationsOfConsultedDocument[x].documentNumberA

String

Número do documento

data.participationsOfConsultedDocument[x].companyName

String

Nome da empresa

data.participationsOfConsultedDocument[x].currencyType

String

Tipo de moeda

data.participationsOfConsultedDocument[x].amount

String

Valor

data.participationsOfConsultedDocument[x].observation

String

Observação

data.participationsOfConsultedDocument[x].percentageValue

String

Valor percentual

data.participationsOfConsultedDocument[x].entryDate

String

Data de entrada

data.participationsOfConsultedDocument[x].role

String

Função

data.participationsOfConsultedDocument[x].documentTypeB

String

Tipo de documento

data.participationsOfConsultedDocument[x].documentNumberB

String

Número do documento

data.participationsOfConsultedDocument[x].partnerType

String

Tipo de parceiro

data.bankruptcyJudicialRecoveryRelationship

Array

Uma lista contendo informações detalhadas sobre cada relação de falência e recuperação judicial

data.bankruptcyJudicialRecoveryRelationship[x].documentType

String

Tipo de documento

data.bankruptcyJudicialRecoveryRelationship[x].documentNumber

String

Número do documento

data.bankruptcyJudicialRecoveryRelationship[x].companyName

String

Nome da empresa

data.bankruptcyJudicialRecoveryRelationship[x].occurrenceType

String

Tipo de ocorrência

data.bankruptcyJudicialRecoveryRelationship[x].notaryOffice

String

Cartório

data.bankruptcyJudicialRecoveryRelationship[x].occurrenceDate

String

Data da ocorrência

data.bankruptcyJudicialRecoveryRelationship[x].location

String

Local

data.bankruptcyJudicialRecoveryRelationship[x].state

String

Estado

data.bankruptcyJudicialRecoveryRelationship[x].municipalityCode

String

Código do município

data.identification

Objeto

data.Informações de identificação

data.identification.document

String

Documento

data.identification.name

String

Nome

data.identification.motherName

String

Nome da mãe

data.identification.dataOfBirth

String

Data de nascimento

data.identification.rgNumber

String

Número do RG

data.identification.issuingAgency

String

Órgão emissor

data.identification.rgFederativeUnit

String

Estado de origem do RG

data.identification.rgIssueDate

String

Data de emissão do RG

data.identification.gender

String

Gênero

data.identification.nacionalidade

String

Nacionalidade

data.identification.maritalStatus

String

Estado civil

data.identification.numberOfDependents

String

Número de dependentes

data.identification.educationLevel

String

Nível de escolaridade

data.identification.revenueStatus

String

Status do CPF

data.identification.updateDate

String

Última data de atualização

data.identification.cpfRegion

String

Região de origem do CPF

data.identification.voterRegistration

String

Título de eleitor

data.identification.message

String

Mensagem de observação da identificação

data.location

Objeto

data.Informações de localização

data.location.streetType

String

Tipo de logradouro

data.location.streetName

String

Nome do logradouro

data.location.streetNumber

String

Número do logradouro

data.location.addressComplement

String

Complemento do endereço

data.location.neighborhood

String

Bairro

data.location.city

String

Cidade

data.location.state

String

Estado

data.location.postalCode

String

CEP

data.location.areaCode

String

Código de área

data.location.phoneNumber

String

Número de telefone

data.scores

Array

Classificação de scores dos dados do consumidor

data.scores[x].score

Inteiro

Classificação da pontuação

data.scores[x].scoreDescription

String

Score de crédito ou score de renda

data.scores[x].probability

String

Probabilidade

data.scores[x].numericalClassification

String

Classificação numérica

data.scores[x].alphabeticalClassification

String

Classificação alfabética

data.scores[x].scoreMessage

String

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

data.scores[x].presumedIncomeRange

String

Faixa de renda presumida. Presente apenas no score de renda

data.positiveControlPanel

Objeto

Painel de indicadores de scores. Uma escala de classificação de 'A' a 'E', em que 'A' é a classificação mais alta e 'E' é a mais baixa

data.positiveControlPanel.positivePaymentBehaviorIndicators

Objeto

Indicadores de comportamento positivo de pagamento

data.positiveControlPanel.positivePaymentBehaviorIndicators.lateInvoiceBehaviorScore

Objeto

Pontuação de comportamento de fatura em atraso

data.positiveControlPanel.positivePaymentBehaviorIndicators.lateInvoiceBehaviorScore.score

String

Abrange informações sobre o status de pagamento de cartões de crédito, empréstimos e financiamentos nos últimos seis meses

data.positiveControlPanel.positiveConsumptionBehaviorIndicators

Objeto

Indicadores de comportamento positivo de pagamento

data.positiveControlPanel.positiveConsumptionBehaviorIndicators.recentContractBehaviorScore

Objeto

Pontuação de comportamento de fatura em atraso

data.positiveControlPanel.positiveConsumptionBehaviorIndicators.recentContractBehaviorScore.score

String

Abrange informações recentes de contratos sobre pagamentos de cartões de crédito, empréstimos e financiamentos nos últimos seis meses

data.situaçãoDoConsumidor

Objeto

Situação do consumidor

data.situaçãoDoConsumidor.mensagem

String

Mensagem da situação do consumidor

{
    "código": "01",
    "message": "Consulta realizada com sucesso.",
    "data": {
      "civilActionsSummary": {
        "quantity": "1",
        "initialPeriod": "20/01/2018",
        "finalPeriod": "06/10/2019"
      },
      "civilActionsList": [
        {
          "court": "2",
          "lawsuitNumber": "1234567891011",
          "civilAction": "Ação executiva Fazenda Federal",
          "distributionDate": "06/10/2018",
          "plaintiff": "Banco Itaú",
          "amount": "30.000,00",
          "location": "São Paulo",
          "estado": "SP",
          "municipalityCode": "3550308"
        }
      ],
      "debtOccurrencesSummary": {
        "totalDebtor": "1",
        "totalGuarantor": "0",
        "accumulatedAmount": "9.301,00",
        "firstDebtDate": "12/03/2023",
        "firstDebtAmount": "9.301,00",
        "largestDebtDate": "12/03/2023",
        "largestDebtAmount": "9.301,00"
      },
      "debts": [
        {
          "occurrenceType": "Crédito Direto",
          "contract": "12345678910",
          "occurrenceDate": "12/03/2023",
          "availabilityDate": "12/03/2023",
          "currency": "R$",
          "amount": "9.301,00",
          "status": "C",
          "informer": "Banco Itaú",
          "informedByConsultee": "S",
          "city": "SCPC São Paulo",
          "estado": "SP",
          "condition": "A",
          "municipalityCondition": "3550308"
        }
      ],
      "previous90DaysInquiriesSummary": {
        "total": "00011",
        "year1": "2024",
        "month1": "10",
        "total1": "0003",
        "year2": "2024",
        "month2": "09",
        "total2": "0005",
        "year3": "2024",
        "month3": "08",
        "total3": "0003"
        "ano4": "2024",
        "mês4": "07",
        "total4": "0000"
      },
      "anfoAdicional": [
        {
          "texto": "CARTEIRA PROFIS PERDA / EXTRAVIO 01/08/2019 12/08/2019 09:57:57",
          "estadoOrigem": "SP",
          "origem": "SSP",
          "tipo": "01"
        }
      ],
      "consultasAnteriores": [
        {
          "tipoDeOcorrência": "Crédito Pessoal",
          "data": "03/10/2024",
          "valor": "0,00",
          "currency": "R$",
          "informante": "CAF",
          "produto": "S"
        },
        {
          "tipoDeOcorrência": "Cartão de Crédito",
          "data": "16/09/2024",
          "valor": "0,00",
          "currency": "R$",
          "informante": "BoaVista",
          "produto": "S"
        }
      ],
      "resumoDeTítulosProtestados": {
        "total": "1",
        "períodoInicial": "17/02/2022",
        "períodoFinal": "17/02/2022",
        "currency": "R$",
        "valorAcumulado": "2.789,45"
      },
      "títulosProtestados": [
        {
          "tipoDeOcorrência": "Crédito Pessoal",
          "cartório": "3",
          "dataDaOcorrência": "17/02/2022",
          "currency": "R$",
          "valor": "2.789,45",
          "cidade": "São Paulo",
          "estado": "SP"
        }
      ],
      "confirmaçãoTelefone": [
        {
          "DDD": "011",
          "númeroDeTelefone": "1137833742",
          "tipoDocumento": "CPF",
          "númeroDoDocumento": "74146649889",
          "nome": "Guilherme Joaquim Mateus Cardoso",
          "bairro": "União de Vila Nova",
          "CEP": "08071105",
          "cidade": "São Paulo",
          "estado": "SP"
        }
      ],
      "detalhesContatoDaAgênciaBancária": [
        {
          "banco": "Banco Itaú",
          "nomeDoBanco": "Itaú",
          "agência": "0177",
          "nomeDaAgência": "Itaú - Ag. 0177 - SP AV Liberdade",
          "endereço": "Avenia Liberdade, 87",
          "bairro": "Liberdade",
          "CEP": "01503-000",
          "cidade": "São Paulo",
          "estado": "SP",
          "DDD": "011",
          "númeroDeTelefone1": "40044828",
          "númeroDeTelefone2": "08009704828"
        }
      ],
      "confirmaçãoDoCEP": {
        "CEP": "08071105",
        "endereço": "Rua das Flores",
        "bairro": "União de Vila Nova",
        "cidade": "São Paulo",
        "estado": "SP"
      },
      "nomeDoDocumento": [
        {
          "nome": "Guilherme Joaquim Mateus Cardoso",
          "dataDeNascimento": "06/04/1986",
          "tipoDocumento": "CPF",
          "númeroDoDocumento": "74146649889"
        },
        {
          "nome": "Guilherme Joaquim Mateus Cardoso",
          "dataDeNascimento": "06/04/1986",
          "tipoDeDocumento": "RG",
          "númeroDoDocumento": "183004164"
        },
        {
          "nome": "Guilherme Joaquim Mateus Cardoso",
          "dataDeNascimento": "06/04/1986",
          "tipoDeDocumento": "CNH",
          "númeroDoDocumento": "86671530071"
        }
      ],
      "históricoDaContaCorrenteInformada": [
        {
          "banco": "Itaú",
          "agência": "0177",
          "contaCorrente": "29414-1",
          "tipoDeDocumento": "RG",
          "númeroDoDocumento": "183004164",
          "dataDaConsulta": "10/11/2024",
          "horaDaConsulta": "14:00:00"
        }
      ],
      "participaçõesDoDocumentoConsultado": [
        {
          "tipoDeDocumentoA": "CPF",
          "númeroDoDocumentoA": "74146649889",
          "razãoSocial": "Joaquim Buffet Ltda",
          "tipoDeMoeda": "R$",
          "valor": "100,00",
          "observação": "N",
          "valorPercentual": "50,00",
          "dataDeEntrada": "19/04/2019",
          "função": "SOCIO ADMINISTRADOR",
          "tipoDeDocumentoB": "CNPJ",
          "númeroDoDocumentoB": "13628777000147",
          "tipoDeSócio": "S"
        },
        {
          "tipoDeDocumentoA": "CPF",
          "númeroDoDocumentoA": "74146649889",
          "razãoSocial": "Bruno e Samuel Telecom Ltda",
          "tipoDeMoeda": "R$",
          "valor": "80,00",
          "observação": "N",
          "valorPercentual": "33,00",
          "dataDeEntrada": "19/10/2022",
          "função": "SOCIO ADMINISTRADOR",
          "tipoDeDocumentoB": "CNPJ",
          "númeroDoDocumentoB": "14293465000192",
          "tipoDeSócio": "S"
        }
      ],
      "relaçãoDeFalênciaRecuperaçãoJudicial": [
        {
          "tipoDocumento": "CNPJ",
          "númeroDoDocumento": "54036433000126",
          "razãoSocial": "Joca Locações de Automóveis ME",
          "tipoDeOcorrência": "Outros",
          "cartório": "0001",
          "dataDaOcorrência": "10/09/2019",
          "localidade": "Guarulhos",
          "estado": "SP",
          "códigoDoMunicípio": "3518800"
        }
      ],
      "identificação": {
        "documento": "74146649889",
        "nome": "Guilherme Joaquim Mateus Cardoso",
        "nomeDaMãe": "Raquel Amanda Cardoso",
        "dataDeNascimento": "06/04/1986",
        "númeroDoRG": "183004164",
        "órgãoEmissor": "SSP",
        "UFdoRG": "SP",
        "dataDeEmissãoDoRG": "02/03/1999",
        "gênero": "Masculino",
        "nacionalidade": "Brasileiro",
        "estadoCivil": "Casado",
        "númeroDeDependentes": "2",
        "nívelDeEscolaridade": "Mestrado Completo",
        "statusDaRenda": "Regular",
        "dataDeAtualização": "31/10/2024",
        "regiãoDoCPF": "SP",
        "títuloDeEleitor": "776102840124"
      },
      "localização": {
        "tipoDeLogradouro": "R",
        "nomeDaRua": "Rua das Flores",
        "número": "707",
        "complementoDoEndereço": "504",
        "bairro": "União de Vila Nova",
        "cidade": "São Paulo",
        "estado": "SP",
        "CEP": "08071105",
        "DDD1": "0011",
        "númeroDeTelefone1": "1137833742",
        "DDD2": "0011",
        "númeroDeTelefone2": "11992681016"
      },
      "pontuações": [
        {
          "pontuação": "802",
          "probabilidade": "01300",
          "classificaçãoNumérica": "11",
          "classificaçãoAlfabética": "B",
          "mensagemDaPontuação": "É provável que 92% das pessoas com esse mesmo comportamento, paguem suas contas nos próximos 6 meses."
        },
        {
          "pontuação": "10",
          "probabilidade": "00000",
          "classificaçãoNumérica": "00",            
          "classificaçãoAlfabética": "F",
          "mensagemDaPontuação": "Renda estimada a partir de informações comportamentais e cadastrais do consumidor.",
          "faixaDeRendaPresumida": "De R$ 9.001 até R$ 12.000"
        }
      ],
      "painelDeControlePositivo": {
        "indicadoresDeComportamentoDePagamentoPositivo": {
          "pontuaçãoDeComportamentoDeFaturaEmAtraso": {
            "pontuação": "A"
          }
        },
        "indicadoresDeComportamentoDeConsumoPositivo": {
          "pontuaçãoDeComportamentoDeContratoRecente": {
            "pontuação": "B"
          }
        }
      },
      "statusConsumidor": {
        "mensagem": "CONSUMIDOR PARTICIPANTE DO CADASTRO POSITIVO COM INFORMAÇÃ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.

Atualizado há 1 ano