V1

2 min

{
    "code": 200,
    "message": "OK",
    "requestId": "112334",
    "productName": "pf_categorized_checking_l3",
    "productVersion": "V1",
    "productReportId": "4b2c1648-231f-11eb-97c4-f45c899f4587", 
    "productReportTime": "2019-12-23T06:10:43",
    "enquiryCpf":"12345678909",
    "links": [
        {
            "linkId": "gPuKXrCJU05J4k",
            "institutionCode": "033",
            "consents": [
                {
                    "consentId": "f55c899f-11eb-231f-97c4-4b2c16484587",
                    "permissions": {
                        "REGISTRATION_ALL": {
                            "permissionsGranted": true,
                            "accountIds": [
                                "123456"
                            ]
                        }
                    }
                }
            ]
        }
    ],
    "checkingAccounts": [
        {
            "brandName": "Organização A",
            "bacenName": "Organização A",
            "compeCode": "001",
            "companyCnpj":"50685362006773",
            "branchCode": "6272",
            "number": "94088392",
            "checkDigit": "4",
            "subtype": "INDIVIDUAL",
            "civilName": "Mike",
            "balances": {
                "availableAmount": {
                    "amount": "1000.0400",
                    "currency": "BRL"
                },
                "blockedAmount": {
                    "amount": "1000.0400",
                    "currency": "BRL"
                },
                "automaticallyInvestedAmount": {
                    "amount": "1000.0400",
                    "currency": "BRL"
                }
            },
            "reservedBalances": [
                {
                    "reservedName": "Carro",
                    "reservedIdentification": "a1234567-12b8-90ab-12cd-abc12345e012",
                    "availableAmount": [
                        {
                            "amount": "0.0000",
                            "currency": "BRL",
                            "remuneration": {
                                "preFixedRate": "",
                                "postFixedIndexerPercentage": "1.000000",
                                "rateType": "EXPONENCIAL",
                                "indexer": "CDI",
                                "calculation": "DIAS_UTEIS",
                                "ratePeriodicity": "ANUAL",
                                "indexerAdditionalInfo": ""
                            }
                        }
                    ]
                }
            ],
            "transactionDetails": [
                {
                    "transactionDate": "2021-01-07",
                    "transactionDateTime": "2016-01-29T12:29:03.374Z",
                    "transactionId": "TXpRMU9UQTROMWhZV2xSU1FUazJSMDl",
                    "completedAuthorisedPaymentType": "TRANSACAO_EFETIVADA",
                    "creditDebitType": "DEBITO",
                    "transactionAmount": {
                        "amount": "1000.0400",
                        "currency": "BRL"
                    },
                    "transactionName": "TRANSFCWAR5TXHCX5I9IDBHML8082N8NEO30M6LNNG7ANAYIJYRM00ZBZPU8",
                    "partieCnpjCpf": "12345678909",
                    "partiePersonType": "PESSOA_NATURAL",
                    "partieCompeCode": "001",
                    "partieBranchCode": "6272",
                    "partieNumber": "67890854360",
                    "partieCheckDigit": "4",
                    "postTransactionBalance": "100.00",
                    "type": "PIX",
                    "category": "Renda",
                    "subcategory": "Renda ativa",
                    "thirdCategory": "Salário",
                    "fAll": 1,
                    "fAllMonth": 0,
                    "fAllCMonth": 1,
                    "settlementType": "PIX"
                }
            ]
        }
    ],
    "externalInfo": {
        "myTraceId": "yourtraceid-1",
        "myUUID": "youruuid-1"
    }
}

Just add category , subcategory , thirdCategory, fAll, fAllMonth, fAllCmonth, settlementType key in transactions array key base on V1.

Data point	Data type	Description
code*	number	Return code. Check here for more details
message*	string	Return message
requestId*	string	Unique ID for request
productName*	string	Product report name
productVersion*	string	Version of the product report
productReportId*	string	Unique ID for each product report
productReportTime*	string	Date and time for product report
enquiryCpf*	string	CPF provided by user or by partner (via request parameter)
links*	object	List of objects with the links used to create the report
linkId*	string	Unique ID for the link
institutionCode*	string	Institution ID. Check here for more details
consents*	object	List of objects with the consents of the link used to generate the report
consentId*	string	Unique ID for the consent
permissions*	object
REGISTRATION_ALL	object
permissionsGranted	boolean	Permission granted ("true" or "false")
accountIds	list	List of Unique account ID
checkingAccounts	object	Account object, multiple items allowed
brandName*	string	Brand Name reported by the participant in Open Finance
bacenName*	string	Institution name in Central Bank
compeCode*	string	Institution id in Central Bank
companyCnpj*	string	CNPJ number of the institution responsible for registering the account
branchCode	string	Agency number
number*	string	Account number
checkDigit*	string	Check digit from the account number
subtype*	string	Account sub-type: INDIVIDUAL CONJUNTA_SIMPLES CONJUNTA_SOLIDARIA
civilName*	string	Name of account owner
balances*	object	Account balances at report time
availableAmount*	object	Account available balance at report time
amount*	string	Amount related to the object
currency*	string	Currency related to the object
blockedAmount*	object	Account blocked balance at report time
amount*	string	Amount related to the object
currency*	string	Currency related to the object
automaticallyInvestedAmount*	object	Available balance with automatic application at report time - corresponds to the sum of the available balance plus the amount obtained from the automatic application
amount*	string	Amount related to the object
currency*	string	Currency related to the object
reservedBalances	object	Reserved balances in "Caixinhas"/"Reserva"
reservedName	string	Name provided by user to the reserved balance
reservedIdentification	string	Reserved balances ID
availableAmount	list	Available amount at "Caixinhas"/"Reserva"
amount	string	Amount related to the object
currency	string	Currency related to the object
remuneration	object	Remuneration applied to "Caixinhas"/"Reserva"
preFixedRate	string	Fixed remuneration rate for the reserved balance
postFixedIndexerPercentage	string	Percentage of the floating-rate index for the reserved balance
rateType	string	Remuneration rate type. LINEAR EXPONENCIAL
indexer	string	Index used as a reference for the reserve remuneration: [CDI, DI, TR, IPCA, IGP_M, IGP_DI, INPC, BCP, TLC, SELIC, PRE_FIXADO, OUTROS]
calculation	string	Calculation basis (business days or calendar days) DIAS_UTEIS DIAS_CORRIDOS
ratePeriodicity	string	Remuneration rate frequency (monthly, annual, daily, semiannual) MENSAL ANUAL DIARIO SEMESTRAL
indexerAdditionalInfo	string	Additional Information from indexer
transactionDetails*	object	Transaction details under the account
transactionDate	string	Transaction date
transactionDateTime*	string	Transaction date time
transactionId*	string	Transaction id
completedAuthorisedPaymentType*	string	Transaction indicator: TRANSACAO_EFETIVADA LANCAMENTO_FUTURO TRANSACAO_PROCESSANDO
creditDebitType*	string	Transaction credit or debit type: CREDITO DEBITO
transactionAmount*	object	Transaction amount
amount*	number	Amount related to the object
currency*	string	Currency related to the object
transactionName*	string	Transaction description
partieCnpjCpf**	string	Receiver or Sender CNPJ or CPF
partiePersonType	string	Receiver or Sender person type identificator PESSOA_NATURAL PESSOA_JURIDICA
partieCompeCode	string	Receiver or Sender bacenId
partieBranchCode	string	Receiver or Sender bank agency number
partieNumber	string	Receiver or Sender bank account number
partieCheckDigit	string	Receiver or Sender bank account check digit
postTransactionBalance*	number	Balance in the account after the current transaction
type*	string	Transaction type directly from OF TED PIX TRANSFERENCIA_MESMA_INSTITUICAO BOLETO CONVENIO_ARRECADACAO PACOTE_TARIFA_SERVICOS TARIFA_SERVICOS_AVULSOS FOLHA_PAGAMENTO DEPOSITO SAQUE, CARTAO ENCARGOS_JUROS_CHEQUE_ESPECIAL RENDIMENTO_APLIC_FINANCEIRA PORTABILIDADE_SALARIO RESGATE_APLIC_FINANCEIRA OPERACAO_CREDITO OUTROS
category*	string	Transaction category
subcategory*	string	Transaction subcategory
thirdCategory*	string	Transaction thirdcategory
fAll*	number	Frequent transaction throughout the period (the same transaction should appear more than 6 times (>=6), independently of month/days) 0: Not frequent transaction 1: Frequent transaction
fAllMonth*	number	Frequent transaction with repetition per month (the same transaction should appear more than 6 times (>=6) but the transaction should appear at least one time per month (it doesn’t need to be consecutive)) 0: Not frequent transaction 1: Frequent transaction
fAllCMonth*	number	Frequent transaction with repetition per month (the same transaction should appear more than 6 times (>=6) but the transaction should appear at least one time per month (it needs to be consecutive - but doesn’t matter the time interval)) 0: Not frequent transaction 1: Frequent transaction
settlementType	string	Type of payment using klavi's intelligence PIX Pagamento com cartão de débito Pagamento de Boleto Débito Automático Débito na conta

All Data points with (*) are mandatory if return code is 200. If it was not returned, please contact [email protected]

**mandatory only for payment transactions

The JSON scheme is similar to the pf_categorized_checking_l3, and the productName key is pj_categorized_checking_l3.

{
    "code": 200,
    "message": "OK",
    "requestId": "112334",
    "productName": "pj_categorized_checking_l3",
    "productVersion": "V1",
    "productReportId": "4b2c1648-231f-11eb-97c4-f45c899f4587",
    "productReportTime": "2019-12-23T06:10:43",
    "enquiryCpf":"12345678909",
    "links": [
        {
            "linkId": "gPuKXrCJU05J4k",
            "institutionCode": "033",
            "consents": [
                {
                    "consentId": "f55c899f-11eb-231f-97c4-4b2c16484587",
                    "permissions": {
                        "REGISTRATION_ALL": {
                            "permissionsGranted": true,
                            "accountIds": [
                                "123456"
                            ]
                        }
                    }
                }
            ]
        }
    ],
    "checkingAccounts": [
        {
            "brandName": "Organização A",
            "bacenName": "Organização A",
            "compeCode": "001",
            "companyCnpj":"50685362006773",
            "branchCode": "6272",
            "number": "94088392",
            "checkDigit": "4",
            "companyName": "Luiza e Benjamin Assessoria Jurídica Ltda",
            "tradeName": "Mundo da Eletronica",
            "cnpjNumber":"50685362006773",
            "civilName": "Mike",
            "balances": {
                "availableAmount": {
                    "amount": "1000.0400",
                    "currency": "BRL"
                },
                "blockedAmount": {
                    "amount": "1000.0400",
                    "currency": "BRL"
                },
                "automaticallyInvestedAmount": {
                    "amount": "1000.0400",
                    "currency": "BRL"
                }
            },
            "transactionDetails": [
                {
                    "transactionDate": "2021-01-07",
                    "transactionDateTime": "2016-01-29T12:29:03.374Z",
                    "transactionId": "TXpRMU9UQTROMWhZV2xSU1FUazJSMDl",
                    "completedAuthorisedPaymentType": "TRANSACAO_EFETIVADA",
                    "creditDebitType": "DEBITO",
                    "transactionAmount": {
                        "amount": "1000.0400",
                        "currency": "BRL"
                    },
                    "transactionName": "TRANSFCWAR5TXHCX5I9IDBHML8082N8NEO30M6LNNG7ANAYIJYRM00ZBZPU8",
                    "partieCnpjCpf": "12345678909",
                    "partiePersonType": "PESSOA_NATURAL",
                    "partieCompeCode": "001",
                    "partieBranchCode": "6272",
                    "partieNumber": "67890854360",
                    "partieCheckDigit": "4",
                    "postTransactionBalance": "100.00",
                    "type": "PIX",
                    "category": "Renda",
                    "subcategory": "Renda ativa",
                    "thirdCategory": "Salário",
                    "fAll": 1,
                    "fAllMonth": 0,
                    "fAllCMonth": 1,
                    "settlementType": "PIX"
                }
            ]
        }
    ],
    "externalInfo": {
        "myTraceId": "yourtraceid-1",
        "myUUID": "youruuid-1"
    }
}

Data point	Data type	Description
code*	number	Return code. Check here for more details
message*	string	Return message
requestId*	string	Unique ID for request
productName*	string	Product report name
productVersion*	string	Version of the product report
productReportId*	string	Unique ID for each product report
productReportTime*	string	Date and time for product report
enquiryCpf*	string	CPF provided by user or by partner (via request parameter)
links*	object	List of objects with the links used to create the report
linkId*	string	Unique ID for the link
institutionCode*	string	Institution ID. Check here for more details
consents*	object	List of objects with the consents of the link used to generate the report
consentId*	string	Unique ID for the consent
permissions*	object
REGISTRATION_ALL	object
permissionsGranted	boolean	Permission granted ("true" or "false")
accountIds	list	List of Unique account ID
checkingAccounts	object	Account object, multiple items allowed
brandName*	string	Brand Name reported by the participant in Open Finance
bacenName*	string	Institution name in Central Bank
compeCode*	string	Institution id in Central Bank
companyCnpj*	string	CNPJ number of the institution responsible for registering the account
branchCode	string	Agency number
number*	string	Account number
checkDigit*	string	Check digit from the account number
companyName	string	Corportate/Business name of the company
tradeName	string	Trade name of the company
cnpjNumber	string	CNPJ number from the consulted company
civilName*	string	Name of account owner
balances*	object	Account balances at report time
availableAmount*	object	Account available balance at report time
amount*	string	Amount related to the object
currency*	string	Currency related to the object
blockedAmount*	object	Account blocked balance at report time
amount*	string	Amount related to the object
currency*	string	Currency related to the object
automaticallyInvestedAmount*	object	Available balance with automatic application at report time - corresponds to the sum of the available balance plus the amount obtained from the automatic application
amount*	string	Amount related to the object
currency*	string	Currency related to the object
transactionDetails*	object	Transaction details under the account
transactionDate	string	Transaction date
transactionDateTime*	string	Transaction date time
transactionId*	string	Transaction id
completedAuthorisedPaymentType*	string	Transaction indicator: TRANSACAO_EFETIVADA LANCAMENTO_FUTURO TRANSACAO_PROCESSANDO
creditDebitType*	string	Transaction credit or debit type: CREDITO DEBITO
transactionAmount*	object	Transaction amount
amount*	number	Amount related to the object
currency*	string	Currency related to the object
transactionName*	string	Transaction description
partieCnpjCpf**	string	Receiver or Sender CNPJ or CPF
partiePersonType	string	Receiver or Sender person type identificator PESSOA_NATURAL PESSOA_JURIDICA
partieCompeCode	string	Receiver or Sender bacenId
partieBranchCode	string	Receiver or Sender bank agency number
partieNumber	string	Receiver or Sender bank account number
partieCheckDigit	string	Receiver or Sender bank account check digit
postTransactionBalance*	number	Balance in the account after the current transaction
type*	string	Transaction type directly from OF TED PIX TRANSFERENCIA_MESMA_INSTITUICAO BOLETO CONVENIO_ARRECADACAO PACOTE_TARIFA_SERVICOS TARIFA_SERVICOS_AVULSOS FOLHA_PAGAMENTO DEPOSITO SAQUE, CARTAO ENCARGOS_JUROS_CHEQUE_ESPECIAL RENDIMENTO_APLIC_FINANCEIRA PORTABILIDADE_SALARIO RESGATE_APLIC_FINANCEIRA OPERACAO_CREDITO OUTROS
category*	string	Transaction category
subcategory*	string	Transaction subcategory
thirdCategory*	string	Transaction thirdcategory
fAll*	number	Frequent transaction throughout the period (the same transaction should appear more than 6 times (>=6), independently of month/days) 0: Not frequent transaction 1: Frequent transaction
fAllMonth*	number	Frequent transaction with repetition per month (the same transaction should appear more than 6 times (>=6) but the transaction should appear at least one time per month (it doesn’t need to be consecutive)) 0: Not frequent transaction 1: Frequent transaction
fAllCMonth*	number	Frequent transaction with repetition per month (the same transaction should appear more than 6 times (>=6) but the transaction should appear at least one time per month (it needs to be consecutive - but doesn’t matter the time interval)) 0: Not frequent transaction 1: Frequent transaction
settlementType	string	Type of payment using klavi's intelligence PIX Pagamento com cartão de débito Pagamento de Boleto Débito Automático Débito na conta

For detailed schemes in the product, please refer to the official documentation of Open Finance Brazil.

V1

pf_categorized_checking_l3

pj_categorized_checking_l3

﻿