Financial

List of PGFN Debtors (PF94)

Returns whether the consulted CPF is enrolled in active debts with the PGFN.

Section: pfPgfnDebtors

Required parameter: cpf

Schema

Attribute	Type	Description
statusCode	String	Query status (details)
data	Object	Return data
data.message	String	Query result descriptive message
data.hasDebts	Boolean	Debt status (true/false)
data.debtValue	String	Amount owed to PGFN

Example

{
  "statusCode": "01",
  "data": {
    "message": "Consulta realizada com sucesso.",
    "hasDebts": false,
    "debtValue": "0"
  }
}

Validations Rules

Rule	Description
has_debts_on_pgfn	The rule will be invalid if there are debts with the PGFN.

Equity and Income Estimate (PF24)

Returns an estimate of the person's income and wealth calculated by different variables from available public queries.

Section: pfFinantialData

Required parameter: cpf

Optional parameter: birthDate This information is required in some sources to complete the execution of minors

Schema

Attribute	Type	Description
statusCode	String	Query status (details)
data	Object	Return data
data.totalAssets	String	Estimated total wealth of the individual
data.taxReturns	Array	List of objects with the history of income tax refunds
data.taxReturns[x].year	String	Year of tax return
data.taxReturns[x].status	String	Tax return status
data.taxReturns[x].bank	String	Bank used for tax return
data.taxReturns[x].captureDate	String	Date of capture
data.taxReturns[x].lastUpdateDate	String	Date of last update
data.incomeEstimates	Object	Estimated income
data.incomeEstimates.mte	String	Estimated income according to the MTE
data.incomeEstimates.ibge	String	Estimated income according to IBGE
data.incomeEstimates.companyOwnership	String	Estimated income even without formal work history
data.lastUpdateDate	String	Date of last update

Example

{
  "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"
  }
}

Validations Rules

Rule	Description
is_less_than_two_salaries	Checks if the estimated income is less than two (02) minimum wages.
is_between_two_and_four_salaries	Check if the estimated income is between two (02) and four (04) minimum wages.
is_more_than_four_salaries	Checks if the estimated income is above four (04) minimum wages
has_salary_information	Checks if information on estimated income has been found

General Table of Disabled Persons - Central Bank of Brazil (PF44)

Returns, if included in the General Table of Disabled Persons of the Central Bank of Brazil, information about the disqualification.

Section: pfBacenQgi

Mandatory parameters: cpf

Schema

Attribute	Type	Description
statusCode	String	Query status (details)
data	Object	Return data
data.message	String	Description with query status
data.disabledList	Array	List of objects with the disqualification data
data.disabledList[x].pas	String	PAS (Sanctioning Administrative Process)
data.disabledList[x].name	String	Name
data.disabledList[x].cpf	String	CPF
data.disabledList[x].penalty	String	Penalty
data.disabledList[x].publicationDate	String	Date of publication
data.disabledList[x].penaltyDeadline	String	Penalty deadline

Example

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

Validations Rules

Rule	Description
disabled_on_bacen	Checks if the CPF consulted is not authorized by the Central Bank.

CVM Associate (PF47)

Returns CPF information related to financial institutions

Section: pfAssociatedCvm

Required parameter: cpf

Schema

Attribute	Type	Description
statusCode	String	Query status (details)
data	Object	Return data
data.message	String	Descriptive with query status
data.associates	Array	Describes the data of the types of registration at the Comissão de Valores Mobiliarios
data.associates[x].name	String	Name of the individual
data.associates[x].type	String	Type of registration
data.associates[x].recordDate	String	Date of registration
data.associates[x].situation	String	Cadastro Situation
data.associates[x].directors	Array	List of objects that contain data about directors
data.associates[x].directors[x].name	String	Name of the company in which the CPF is a director
data.associates[x].directors[x].startDate	String	Beginning date of the position as director
data.associates[x].directors[x].instruction	String	Instruction of the director in the company

Example

{
  "statusCode": "01",
  "data": {
    "message": "Não foram encontrados participantes para esta consulta."
  }
}

Validations Rules

Rule	Description
has_no_participant_cvm	The rule will be invalid if the consulted CPF/CNPJ is not registered with the CVM.

Income Ibope (PF50)

Returns information about a person's house hold income / ibope income

Section: pfIbopeIncome

Required parameter: cpf

Schema

Attribute	Type	Description
statusCode	String	Query status (details)
data	Object	Return data
data.message	String	Descriptive with query situation
data.ibopeIncome	Float	ibope income value

Example

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

Validations Rules

Rule	Description
has_no_ibope_income	Check the Ibope income of a CPF.

Estimated Income (PF51)

Returns a person's estimated income information

Section: pfEstimatedIncome

Required parameter: cpf

Schema

Attribute	Type	Description
statusCode	String	Query status (details)
data	Object	Return data
data.message	String	Descriptive with query status
data.estimatedIncome	Float	Estimated income value

Example

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

Credit Information System (PF96)

Returns a person's credit information.

Section: pfCreditOperationScr

Required parameters: cpf, PF

Schema

Attribute	Type	Description
statusCode	String	Query status (details)
data	Object	Return data
data.message	String	Description with query status
data.clientCode	String	CPF
data.registrationDate	Date	Registration date
data.baseDate	Date	Base date for query
data.assumedCoobligation	Number	Co-obligation assumed in cession of credit by client
data.receivedCoobligation	Number	Co-obligation received in credit assignment
data.processedDocumentsPercentage	Number	Percentage of the 3040 documents expected for the base date and that have already been incorporated to the SCR database at the Central Bank, not considering the exempt financial institutions
data.processedVolumePercentage	Number	Percentage of the volume expected for the base date and which are already incorporated to the SCR database at the Central Bank, not considering the exempted financial institutions
data.totalOfInstituions	String	Number of financial institutions (FIs) where the client has operations
data.totalOfTransactions	String	Number of operations of the client in the SFN
data.totalDisagreementTransactions	String	Number of operations marked with a manifestation of disagreement
data.totalSubJudiceTransactions	String	Number of operations marked with sub judice
data.fullLiabilityDisagreement	String	Total responsibility of operations marked with manifestation of disagreement
data.fullLiabilitySubJudice	String	Total liability of operations under judgement
data.indirectVendorRisk	String	Indirect risk assumed by the client in vendor operations
data.operationSumaryList	Array	List containing summary of operations
data.operationSumaryList[x].modalityCategoryCode	String	Operation modality code
data.operationSumaryList[x].modalityCategoryDescription	String	Description of the operation modality code
data.operationSumaryList[x].modalitySubCategoryCode	String	Subcategory code
data.operationSumaryList[x].modalitySubCategoryDescription	String	Description of the subcategory indicator
data.operationSumaryList[x].listOfDebts	Array	Due date list
data.operationSumaryList[x].listOfDebts[x].expirationCode	String	Maturity indicator
data.operationSumaryList[x].listOfDebts[x].expirationDescription	String	Maturity indicator description
data.operationSumaryList[x].listOfDebts[x].value	String	Due date value

Example

{
  "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"
          }
        ]
      }
    ]
  }
}

Temporary Penalties at CVM (PF93)

Query the CVM's list of Temporary Penalties to see if the participant is temporarily prevented from operating in the capital market due to a decision in an Administrative Sanctioning Process

Section: pfPenaltiesOnCvm

Required parameters: name

Schema

Attribute	Type	Description
statusCode	String	Query status (details)
data	Object	Return data
data.message	String	Description with query status
data.listOfSetences	Array	List of members set/punished
data.listOfSetences[x].processNumber	String	Process Number
data.listOfSetences[x].name	String	Participant
data.listOfSetences[x].decisionType	String	Type of Decision
data.listOfSetences[x].judgementDate	String	Date of CVM Sentencing
data.listOfSetences[x].effectiveDate	String	Effective Date of Penalty
data.listOfSetences[x].timeOfWithdrawal	String	Removal Time

Example

{
  "statusCode": 0,
  "data": {
    "message": "",
    "listOfSetences": [
      {
        "processNumber": "",
        "name": "",
        "decisionType": "",
        "judgementDate": "",
        "effectiveDate": "",
        "timeOfWithdrawal": ""
      }
    ]
  }
}

Validations Rules

Rule	Description
has_penalties_on_cvm	The rule will be invalid if the CPF is temporarily barred from acting with the CVM.

Credit Score - NEW (PF87)

Returns the credit score of a consumer based on their behavior, the score will estimate the proability of default and how risky the profile is, related to credit

Section: pfCreditScore

Required parameter: cpf

Schema

Attribute	Type	Description
statusCode	String	Query status (details)
message	String	Descriptive with query status
data	Object	Return data
data.score	Integer	Consumer Score rating
data.scoreMessage	String	Context of recommendation for decision-making

Example

{
  "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.",
  }
}

Validations Rules

Rule	Description
credit_score_available	The rule will become invalid if the credit score is unavailable.
credit_score_below	The rule will become invalid if the credit score is below the defined value.
credit_score_over	The rule will become invalid if the credit score is above the defined value.
credit_score_between	The rule will become invalid if the credit score is between the defined values.

Credit Profile - NEW (PF88)

Return a comprehensive evaluation of an individual's financial health by returning their credit score and offering a detailed financial profile. Leveraging a wide range of data, including registered debts, inquiry history, protests, returns, and banking history, as well as supplementary data such as company affiliations and bankruptcy records, it delivers a predictive analysis of current and future payment capacity. This solution enables access to a reliable and comprehensive financial overview, making it ideal for credit decisions and risk analysis, offering clear insights to mitigate risks and maximize financial opportunities.

Data blocks will only be returned if information is available.

Section: pfCreditProfileDetails

Required parameter: cpf

Schema

Attribute	Type	Description
statusCode	String	Query status (details)
message	String	Descriptive with query status
data	Object	Return data
data.civilActionsSummary	Object	A block providing a consolidated view of civil action records
data.civilActionsSummary.quantity	String	Civil actions total quantity
data.civilActionsSummary.initialPeriod	String	Civil actions initial period
data.civilActionsSummary.finalPeriod	String	Civil actions final period
data.civilActionsList	Array	A list containing detailed information on each recorded civil action
data.civilActionsList[x].court	String	Court
data.civilActionsList[x].lawsuitNumber	String	Civil action number
data.civilActionsList[x].civilAction	String	Civil action title
data.civilActionsList[x].distributionDate	String	Civil action distribution date
data.civilActionsList[x].plaintiff	String	Civil action author
data.civilActionsList[x].amount	String	Amount
data.civilActionsList[x].location	String	Location
data.civilActionsList[x].state	String	State
data.civilActionsList[x].municipalityCode	String	City code
data.debtOccurrencesSummary	Object	A block providing a consolidated view of debt records
data.debtOccurrencesSummary.totalDebtor	String	Total debts as debtor
data.debtOccurrencesSummary.totalGuarantor	String	Total debts as guarantor
data.debtOccurrencesSummary.accumulatedAmount	String	Debts accumulated amount
data.debtOccurrencesSummary.firstDebtDate	String	First debt date
data.debtOccurrencesSummary.firstDebtAmount	String	First debt amount
data.debtOccurrencesSummary.largestDebtDate	String	Largest debt date
data.debtOccurrencesSummary.largestDebtAmount	String	Largest debt amount
data.debts	Array	A list containing detailed information on each debt.
data.debts[x].occurrenceType	String	Occurrence type
data.debts[x].contract	String	Debt contract number
data.debts[x].occurrenceDate	String	Debt occurrence date
data.debts[x].availabilityDate	String	Debt availability date
data.debts[x].currency	String	Currency type
data.debts[x].amount	String	Amount
data.debts[x].status	String	Debt status
data.debts[x].informer	String	Debt informer
data.debts[x].informedByConsultee	String	Was the debt informed by the consultee
data.debts[x].city	String	City
data.debts[x].state	String	State
data.debts[x].condition	String	Debt condition
data.debts[x].municipalityCondition	String	City condition code
data.previous90DaysInquiriesSummary	Object	A block providing a consolidated view of from previous 90 days records
data.previous90DaysInquiriesSummary.total	String	Total
data.previous90DaysInquiriesSummary.year	String	Year
data.previous90DaysInquiriesSummary.month	String	month
data.previousInquiries	Array	A list containing detailed information on each previous inquiry
data.previousInquiries[x].occurrenceType	String	Occurrence type
data.previousInquiries[x].date	String	Inquiry date
data.previousInquiries[x].amount	String	Amount
data.previousInquiries[x].currency	String	Currency type
data.previousInquiries[x].informer	String	Inquiry informer
data.previousInquiries[x].product	String	Inquiry product
data.additionalAnfo	Array	A list containing additional information
data.additionalAnfo[x].text	String	Additional information text
data.additionalAnfo[x].originState	String	Origin state
data.additionalAnfo[x].origin	String	Additional information origin
data.additionalAnfo[x].type	String	Type
data.protestedBillsSummary	Object	A block providing a consolidated view of protested bills records
data.protestedBillsSummary.total	String	Protested bills total quantity
data.protestedBillsSummary.initialPeriod	String	Protested bills initial period
data.protestedBillsSummary.finalPeriod	String	Protested bills final period
data.protestedBillsSummary.currency	String	Currency type
data.protestedBillsSummary.accumulatedValue	String	Protested bills accumulated value
data.protestedBills	Array	A list containing detailed information on each protested bill
data.protestedBills[x].occurrenceType	String	Occurrence type
data.protestedBills[x].notaryOffice	String	Notary office
data.protestedBills[x].occurrenceDate	String	Protested bill occurrence date
data.protestedBills[x].currency	String	Currency type
data.protestedBills[x].amount	String	Amount
data.protestedBills[x].city	String	City
data.protestedBills[x].state	String	State
data.cancelledCheckBook	Array	A list containing detailed information on each cancelled bank checkbook
data.cancelledCheckBook[x].occurrenceType	String	Occurrence type
data.cancelledCheckBook[x].documentType	String	Document type
data.cancelledCheckBook[x].documentNumber	String	Document number
data.cancelledCheckBook[x].bank	String	Bank
data.cancelledCheckBook[x].agency	String	Agency
data.cancelledCheckBook[x].currentAccount	String	Current account number
data.cancelledCheckBook[x].check	String	Bank check number
data.cancelledCheckBook[x].reasonCode	String	Alinea
data.cancelledCheckBook[x].occurrenceDate	String	Cancellation occurrence date
data.cancelledCheckBook[x].availabilityDate	String	Availability date
data.cancelledCheckBook[x].informer	String	Informer
data.cancelledCheckBook[x].indicator	String	Indicator
data.ccfReportedReturnsSummary	Object	A block providing a consolidated view of returns reported by CCF records
data.ccfReportedReturnsSummary.documentType	String	Document type
data.ccfReportedReturnsSummary.documentNumber	String	Document number
data.ccfReportedReturnsSummary.name	String	Name
data.ccfReportedReturnsSummary.totalNames	String	Total name
data.ccfReportedReturnsSummary.totalReturns	String	Total returns
data.ccfReportedReturnsSummary.reason12	String	Reason 12 - Bank check without funds - 2nd presentation
data.ccfReportedReturnsSummary.reason13	String	Reason 13 - Account closed
data.ccfReportedReturnsSummary.reason14	String	Reason 14 - Spurious practice
data.ccfReportedReturnsSummary.reason99	String	Reason 99 - Financial institution no longer in business
data.ccfReportedReturnsList	Array	A list containing detailed information on each returns reported by CCF
data.ccfReportedReturnsList[x].documentType	String	Document type
data.ccfReportedReturnsList[x].documentNumber	String	Document number
data.ccfReportedReturnsList[x].name	String	Name
data.ccfReportedReturnsList[x].bank	String	Bank
data.ccfReportedReturnsList[x].agency	String	Agency
data.ccfReportedReturnsList[x].reason12	String	Reason 12 - Bank check without funds - 2nd presentation
data.ccfReportedReturnsList[x].lastOccurrenceDate12	String	Last occurrence date - reason 12
data.ccfReportedReturnsList[x].reason13	String	Reason 13 - Account closed
data.ccfReportedReturnsList[x].lastOccurrenceDate13	String	Last occurrence date - reason 13
data.ccfReportedReturnsList[x].reason14	String	Reason 14 - Spurious practice
data.ccfReportedReturnsList[x].lastOccurrenceDate14	String	Last occurrence date - reason 14
data.ccfReportedReturnsList[x].reason99	String	Reason 99 - Financial institution no longer in business
data.ccfReportedReturnsList[x].lastOccurrenceDate99	String	Last occurrence date - reason 99
data.ccfReportedReturnsList[x].bankName	String	Bank name
data.previousCheckInquiriesSummary	Object	A block providing a consolidated view of previous bank check inquiries records
data.previousCheckInquiriesSummary.documentType	String	Document type
data.previousCheckInquiriesSummary.documentNumber	String	Document number
data.previousCheckInquiriesSummary.total	String	Previous bank check inquiries total quantity
data.previousCheckInquiriesSummary.amount	String	Amount
data.previousCheckInquiriesSummary.day	String	Day
data.previousCheckInquiriesSummary.dailyValue	String	Daily value
data.previousCheckInquiriesSummary.postdated	String	Postdated
data.previousCheckInquiriesSummary.postdatedValue	String	Postdated value
data.previousCheckInquiries	Array	A list containing detailed information on each previous bank check inquiry
data.previousCheckInquiries[x].documentType	String	Document type
data.previousCheckInquiries[x].documentNumber	String	Document number
data.previousCheckInquiries[x].type	String	Type
data.previousCheckInquiries[x].creditDate	String	Credit date
data.previousCheckInquiries[x].creditTime	String	Credit time
data.previousCheckInquiries[x].currency	String	Currency type
data.previousCheckInquiries[x].amount	String	Amount
data.previousCheckInquiries[x].informer	String	Informer
data.phoneConfirmation	Array	A list containing detailed information on each phone confirmation
data.phoneConfirmation[x].areaCode	String	Area code
data.phoneConfirmation[x].phoneNumber	String	Phone number
data.phoneConfirmation[x].documentType	String	Document type
data.phoneConfirmation[x].documentNumber	String	Document number
data.phoneConfirmation[x].name	String	Name
data.phoneConfirmation[x].neighborhood	String	Neighborhood
data.phoneConfirmation[x].postalCode	String	Postal code
data.phoneConfirmation[x].city	String	City
data.phoneConfirmation[x].state	String	State
data.bankBranchContactDetails	Array	A list containing detailed information on each bank branch contact
data.bankBranchContactDetails[x].bank	String	Bank
data.bankBranchContactDetails[x].bankName	String	Bank name
data.bankBranchContactDetails[x].agency	String	Agency
data.bankBranchContactDetails[x].branchName	String	Branch name
data.bankBranchContactDetails[x].address	String	Address
data.bankBranchContactDetails[x].neighborhood	String	Neighborhood
data.bankBranchContactDetails[x].postalCode	String	Postal code
data.bankBranchContactDetails[x].city	String	City
data.bankBranchContactDetails[x].state	String	State
data.bankBranchContactDetails[x].location	String	Location
data.bankBranchContactDetails[x].areaCode	String	Area code
data.bankBranchContactDetails[x].phoneNumber1	String	Phone number 1
data.bankBranchContactDetails[x].phoneNumber2	String	Phone number 2
data.bankBranchContactDetails[x].reserved	String	Reserved
data.postalCodeConfirmation	Object	A block providing a consolidated view of postal code confirmation
data.postalCodeConfirmation.postalCode	String	Postal code
data.postalCodeConfirmation.address	String	Address
data.postalCodeConfirmation.neighborhood	String	Neighborhood
data.postalCodeConfirmation.city	String	City
data.postalCodeConfirmation.state	String	State
data.documentName	Array	A list containing detailed information on each document
data.documentName[x].name	String	Name
data.documentName[x].birthDate	String	Birth date
data.documentName[x].document	String	document
data.documentName[x].documentType	String	Document type
data.documentName[x].documentNumber	String	Document number
data.checkAdditionalInformation	Array	A list containing detailed additional information about bank checks
data.checkAdditionalInformation[x].documentType	String	Document type
data.checkAdditionalInformation[x].documentNumber	String	Document number
data.checkAdditionalInformation[x].text	String	Additional information text
data.userReportedReturnsSummary	Object	Returns reported by the user
data.userReportedReturnsSummary.documentType	String	Document type
data.userReportedReturnsSummary.documentNumber	String	Document number
data.userReportedReturnsSummary.total	String	Total
data.userReportedReturnsSummary.firstReturnDate	String	First return date
data.userReportedReturnsSummary.lastReturnDate	String	Last return date
data.userReportedReturns	Array	A list containing detailed information on each return reported by the user
data.userReportedReturns[x].documentType	String	Document type
data.userReportedReturns[x].document	String	Document number
data.userReportedReturns[x].bank	String	Bank
data.userReportedReturns[x].agency	String	Agency
data.userReportedReturns[x].currentAccount	String	Current account number
data.userReportedReturns[x].initialCheck	String	Initial bank check
data.userReportedReturns[x].finalCheck	String	Final bank check
data.userReportedReturns[x].reason	String	Reason
data.userReportedReturns[x].reasonCode	String	Reason code
data.userReportedReturns[x].occurrenceDate	String	Occurrence date
data.userReportedReturns[x].registrationDate	String	Registration date
data.userReportedReturns[x].currency	String	Currency type
data.userReportedReturns[x].amount	String	Amount
data.userReportedReturns[x].reporterCode	String	Informer code
data.userReportedReturns[x].informer	String	Informer
data.userReportedReturns[x].city	String	City
data.userReportedReturns[x].state	String	State
data.checksCancelledReason21	Array	A list containing detailed information on each bank check cancelled for reason 21 - cancelled or revoked
data.checksCancelledReason21[x].documentType	String	Document type
data.checksCancelledReason21[x].documentNumber	String	Document number
data.checksCancelledReason21[x].bank	String	Bank
data.checksCancelledReason21[x].agency	String	Agency
data.checksCancelledReason21[x].currentAccount	String	Current account number
data.checksCancelledReason21[x].initialCheck	String	Initial bank check
data.checksCancelledReason21[x].finalCheck	String	Final bank check
data.checksCancelledReason21[x].reasonCode	String	Reason code
data.checksCancelledReason21[x].occurrenceDate	String	Occurrence date
data.checksCancelledReason21[x].availabilityDate	String	Availability date
data.checksCancelledReason21[x].currency	String	Currency type
data.checksCancelledReason21[x].amount	String	Amount
data.checksCancelledReason21[x].informer	String	Informer
data.reportedCheckHistory	Array	A list containing detailed information on each reported check
data.reportedCheckHistory[x].documentType	String	Document type
data.reportedCheckHistory[x].documentNumber	String	Document number
data.reportedCheckHistory[x].bank	String	Bank
data.reportedCheckHistory[x].agency	String	Agency
data.reportedCheckHistory[x].currentAccount	String	Current account number
data.reportedCheckHistory[x].check	String	Bank check number
data.reportedCheckHistory[x].inquiryDate	String	Inquiry date
data.reportedCheckHistory[x].inquiryTime	String	Inquiry time
data.reportedCheckHistory[x].network	String	Network
data.reportedCurrentAccountHistory	Array	A list containing detailed information on each reported current account
data.reportedCurrentAccountHistory[x].bank	String	Bank
data.reportedCurrentAccountHistory[x].agency	String	Agency
data.reportedCurrentAccountHistory[x].currentAccount	String	Current account number
data.reportedCurrentAccountHistory[x].documentType	String	Document type
data.reportedCurrentAccountHistory[x].documentNumber	String	Document number
data.reportedCurrentAccountHistory[x].inquiryDate	String	Inquiry date
data.reportedCurrentAccountHistory[x].inquiryTime	String	Inquiry time
data.participationsOfConsultedDocument	Array	A list containing detailed information on each participations of consulted document
data.participationsOfConsultedDocument[x].documentTypeA	String	Document type
data.participationsOfConsultedDocument[x].documentNumberA	String	Document number
data.participationsOfConsultedDocument[x].companyName	String	Company name
data.participationsOfConsultedDocument[x].currencyType	String	Currency type
data.participationsOfConsultedDocument[x].amount	String	Amount
data.participationsOfConsultedDocument[x].observation	String	Observation
data.participationsOfConsultedDocument[x].percentageValue	String	Percentage value
data.participationsOfConsultedDocument[x].entryDate	String	Entry date
data.participationsOfConsultedDocument[x].role	String	Role
data.participationsOfConsultedDocument[x].documentTypeB	String	Document type
data.participationsOfConsultedDocument[x].documentNumberB	String	Document number
data.participationsOfConsultedDocument[x].partnerType	String	Partner type
data.bankruptcyJudicialRecoveryRelationship	Array	A list containing detailed information on each bankruptcy judicial recovery relationship
data.bankruptcyJudicialRecoveryRelationship[x].documentType	String	Document type
data.bankruptcyJudicialRecoveryRelationship[x].documentNumber	String	Document number
data.bankruptcyJudicialRecoveryRelationship[x].companyName	String	Company name
data.bankruptcyJudicialRecoveryRelationship[x].occurrenceType	String	Occurrence type
data.bankruptcyJudicialRecoveryRelationship[x].notaryOffice	String	Notary office
data.bankruptcyJudicialRecoveryRelationship[x].occurrenceDate	String	Occurrence date
data.bankruptcyJudicialRecoveryRelationship[x].location	String	Location
data.bankruptcyJudicialRecoveryRelationship[x].state	String	State
data.bankruptcyJudicialRecoveryRelationship[x].municipalityCode	String	City code
data.identification	Object	data.Identification information
data.identification.document	String	Document
data.identification.name	String	Name
data.identification.motherName	String	Mother name
data.identification.dataOfBirth	String	Data of birth
data.identification.rgNumber	String	RG number
data.identification.issuingAgency	String	Issuing agency
data.identification.rgFederativeUnit	String	RG state origin
data.identification.rgIssueDate	String	RG issue date
data.identification.gender	String	Gender
data.identification.nacionalidade	String	Nationality
data.identification.maritalStatus	String	Marital status
data.identification.numberOfDependents	String	Number of dependants
data.identification.educationLevel	String	Education level
data.identification.revenueStatus	String	CPF status
data.identification.updateDate	String	Last update date
data.identification.cpfRegion	String	CPF origin region
data.identification.voterRegistration	String	Voter registration
data.identification.message	String	Identification observation message
data.location	Object	data.Location information
data.location.streetType	String	Street type
data.location.streetName	String	Street name
data.location.streetNumber	String	Street number
data.location.addressComplement	String	Address complement
data.location.neighborhood	String	Neighborhood
data.location.city	String	City
data.location.state	String	State
data.location.postalCode	String	Postal code
data.location.areaCode	String	Area code
data.location.phoneNumber	String	Phone number
data.scores	Array	Consumer data.Scores rating
data.scores[x].score	Integer	Score rating
data.scores[x].scoreDescription	String	Credit score or Income score
data.scores[x].probability	String	Probability
data.scores[x].numericalClassification	String	Numerical classification
data.scores[x].alphabeticalClassification	String	Alphabetical classification
data.scores[x].scoreMessage	String	Context of recommendation for decision-making
data.scores[x].presumedIncomeRange	String	Presumed income range. Present only on Income score
data.positiveControlPanel	Object	Scores indicators panel. A rating scale from 'A' to 'E' where 'A' is the highest and 'E' is the lowest rating
data.positiveControlPanel.positivePaymentBehaviorIndicators	Object	Positive payment behavior indicators
data.positiveControlPanel.positivePaymentBehaviorIndicators.lateInvoiceBehaviorScore	Object	Late invoice behavior score
data.positiveControlPanel.positivePaymentBehaviorIndicators.lateInvoiceBehaviorScore.score	String	Covers information on the payment status of credit cards loans and financing over the past six months
data.positiveControlPanel.positiveConsumptionBehaviorIndicators	Object	Positive payment behavior indicators
data.positiveControlPanel.positiveConsumptionBehaviorIndicators.recentContractBehaviorScore	Object	Late invoice behavior score
data.positiveControlPanel.positiveConsumptionBehaviorIndicators.recentContractBehaviorScore.score	String	Covers recent contract information on payments for credit cards loans and financing over the past six months
data.consumerStatus	Object	Consumer status
data.consumerStatus.message	String	Consumer status message

Example

{
    "code": "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",
          "state": "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",
          "state": "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",
        "year4": "2024",
        "month4": "07",
        "total4": "0000"
      },
      "additionalAnfo": [
        {
          "text": "CARTEIRA PROFIS PERDA / EXTRAVIO 01/08/2019 12/08/2019 09:57:57",
          "originState": "SP",
          "origin": "SSP",
          "type": "01"
        }
      ],
      "previousInquiries": [
        {
          "occurrenceType": "Crédito Pessoal",
          "date": "03/10/2024",
          "amount": "0,00",
          "currency": "R$",
          "informer": "CAF",
          "product": "S"
        },
        {
          "occurrenceType": "Cartão de Crédito",
          "date": "16/09/2024",
          "amount": "0,00",
          "currency": "R$",
          "informer": "BoaVista",
          "product": "S"
        }
      ],
      "protestedBillsSummary": {
        "total": "1",
        "initialPeriod": "17/02/2022",
        "finalPeriod": "17/02/2022",
        "currency": "R$",
        "accumulatedValue": "2.789,45"
      },
      "protestedBills": [
        {
          "occurrenceType": "Crédito Pessoal",
          "notaryOffice": "3",
          "occurrenceDate": "17/02/2022",
          "currency": "R$",
          "amount": "2.789,45",
          "city": "São Paulo",
          "state": "SP"
        }
      ],
      "phoneConfirmation": [
        {
          "areaCode": "011",
          "phoneNumber": "1137833742",
          "documentType": "CPF",
          "documentNumber": "74146649889",
          "name": "Guilherme Joaquim Mateus Cardoso",
          "neighborhood": "União de Vila Nova",
          "postalCode": "08071105",
          "city": "São Paulo",
          "state": "SP"
        }
      ],
      "bankBranchContactDetails": [
        {
          "bank": "Banco Itaú",
          "bankName": "Itaú",
          "agency": "0177",
          "branchName": "Itaú - Ag. 0177 - SP AV Liberdade",
          "address": "Avenia Liberdade, 87",
          "neighborhood": "Liberdade",
          "postalCode": "01503-000",
          "city": "São Paulo",
          "state": "SP",
          "areaCode": "011",
          "phoneNumber1": "40044828",
          "phoneNumber2": "08009704828"
        }
      ],
      "postalCodeConfirmation": {
        "postalCode": "08071105",
        "address": "Rua das Flores",
        "neighborhood": "União de Vila Nova",
        "city": "São Paulo",
        "state": "SP"
      },
      "documentName": [
        {
          "name": "Guilherme Joaquim Mateus Cardoso",
          "birthDate": "06/04/1986",
          "documentType": "CPF",
          "documentNumber": "74146649889"
        },
        {
          "name": "Guilherme Joaquim Mateus Cardoso",
          "birthDate": "06/04/1986",
          "documentType": "RG",
          "documentNumber": "183004164"
        },
        {
          "name": "Guilherme Joaquim Mateus Cardoso",
          "birthDate": "06/04/1986",
          "documentType": "CNH",
          "documentNumber": "86671530071"
        }
      ],
      "reportedCurrentAccountHistory": [
        {
          "bank": "Itaú",
          "agency": "0177",
          "currentAccount": "29414-1",
          "documentType": "RG",
          "documentNumber": "183004164",
          "inquiryDate": "10/11/2024",
          "inquiryTime": "14:00:00"
        }
      ],
      "participationsOfConsultedDocument": [
        {
          "documentTypeA": "CPF",
          "documentNumberA": "74146649889",
          "companyName": "Joaquim Buffet Ltda",
          "currencyType": "R$",
          "amount": "100,00",
          "observation": "N",
          "percentageValue": "50,00",
          "entryDate": "19/04/2019",
          "role": "SOCIO ADMINISTRADOR",
          "documentTypeB": "CNPJ",
          "documentNumberB": "13628777000147",
          "partnerType": "S"
        },
        {
          "documentTypeA": "CPF",
          "documentNumberA": "74146649889",
          "companyName": "Bruno e Samuel Telecom Ltda",
          "currencyType": "R$",
          "amount": "80,00",
          "observation": "N",
          "percentageValue": "33,00",
          "entryDate": "19/10/2022",
          "role": "SOCIO ADMINISTRADOR",
          "documentTypeB": "CNPJ",
          "documentNumberB": "14293465000192",
          "partnerType": "S"
        }
      ],
      "bankruptcyJudicialRecoveryRelationship": [
        {
          "documentType": "CNPJ",
          "documentNumber": "54036433000126",
          "companyName": "Joca Locações de Automóveis ME",
          "occurrenceType": "Outros",
          "notaryOffice": "0001",
          "occurrenceDate": "10/09/2019",
          "location": "Guarulhos",
          "state": "SP",
          "municipalityCode": "3518800"
        }
      ],
      "identification": {
        "document": "74146649889",
        "name": "Guilherme Joaquim Mateus Cardoso",
        "motherName": "Raquel Amanda Cardoso",
        "dataOfBirth": "06/04/1986",
        "rgNumber": "183004164",
        "issuingAgency": "SSP",
        "rgFederativeUnit": "SP",
        "rgIssueDate": "02/03/1999",
        "gender": "Masculino",
        "nacionalidade": "Brasileiro",
        "maritalStatus": "Casado",
        "numberOfDependents": "2",
        "educationLevel": "Mestrado Completo",
        "revenueStatus": "Regular",
        "updateDate": "31/10/2024",
        "cpfRegion": "SP",
        "voterRegistration": "776102840124"
      },
      "location": {
        "streetType": "R",
        "streetName": "Rua das Flores",
        "streetNumber": "707",
        "addressComplement": "504",
        "neighborhood": "União de Vila Nova",
        "city": "São Paulo",
        "state": "SP",
        "postalCode": "08071105",
        "areaCode1": "0011",
        "phoneNumber1": "1137833742",
        "areaCode2": "0011",
        "phoneNumber2": "11992681016"
      },
      "scores": [
        {
          "score": "802",
          "probability": "01300",
          "numericalClassification": "11",
          "alphabeticalClassification": "B",
          "scoreMessage": "É provável que 92% das pessoas com esse mesmo comportamento, paguem suas contas nos próximos 6 meses."
        },
        {
          "score": "10",
          "probability": "00000",
          "numericalClassification": "00",            
          "alphabeticalClassification": "F",
          "scoreMessage": "Renda estimada a partir de informações comportamentais e cadastrais do consumidor.",
          "presumedIncomeRange": "De R$ 9.001 até R$ 12.000"
        }
      ],
      "positiveControlPanel": {
        "positivePaymentBehaviorIndicators": {
          "lateInvoiceBehaviorScore": {
            "score": "A"
          }
        },
        "positiveConsumptionBehaviorIndicators": {
          "recentContractBehaviorScore": {
            "score": "B"
          }
        }
      },
      "consumerStatus": {
        "message": "CONSUMIDOR PARTICIPANTE DO CADASTRO POSITIVO COM INFORMAÇÃO"
      }
    }
    }

Validations Rules

Rule	Description
credit_score_available	The rule will become invalid if the credit score is unavailable.
credit_score_below	The rule will become invalid if the credit score is below the defined value.
credit_score_over	The rule will become invalid if the credit score is above the defined value.
credit_score_between	The rule will become invalid if the credit score is between the defined values.