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

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	Array	Estimated income
data.incomeEstimates[x].mte	String	Estimated income according to the MTE
data.incomeEstimates[x].ibge	String	Estimated income according to IBGE
data.incomeEstimates[x].bigData	String	Estimated income according to BigData Corp
data.incomeEstimates[x].companyOwnership	String	Estimated income even without formal work history

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.