V1

pf categorized checking l3 { "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" } }, "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 docid\ pe09ib5xd1cjajljee9 c 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 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 suporte\@klavi ai mandatory only for payment transactions pj categorized checking l3 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