Klaas API

Open Finance Analytics

3min
this api can return all report product types defined by klavi for detailed information, please refer to products before integrating the api, you need to first communicate with klavi sales and implementation personnel to clarify the required report product types, and have the implementation personnel configure them you need to complete the development of webhook (for receiving reports) based on products in advance, and complete the configuration in the console provided by klavi request userdata json this userdata json format needs to be the same as the complete json format of a user provided in the poc process below we provide a demo version of this json data, for clients' reference userdata json { "accounts" \[ { "accountid" "92792126019929279212650822221989319252576", "brandname" "banco do brasil", "compecode" "001", "branchcode" "6272", "companycnpj" "21128159000166", "number" "94088392", "checkdigit" "4", "type" "conta deposito a vista", "balances" { "automaticallyinvestedamount" { "amount" "1000 0400", "currency" "brl" }, "availableamount" { "amount" "1000 0400", "currency" "brl" }, "blockedamount" { "amount" "1000 0400", "currency" "brl" } }, "overdraft limits" { "overdraftcontractedlimit" { "amount" "1000 0400", "currency" "brl" }, "overdraftusedlimit" { "amount" "1000 0400", "currency" "brl" }, "unarrangedoverdraftamount" { "amount" "1000 0400", "currency" "brl" } }, "transactions" \[ { "transactionid" "txprmu9uqtromwhzv2xsu1fuazjsmdl", "transactiondate" "2021 01 07", "creditdebittype" "debito", "transactionname" "transfcwar5txhcx5i9idbhml8082n8neo30m6lnng7anayijyrm00zbzpu8", "type" "pix", "transactionamount" { "amount" "1000 0400", "currency" "brl" }, "completedauthorisedpaymenttype" "transacao efetivada", "partiebranchcode" "6272", "partiecheckdigit" "4", "partiecompecode" "001", "partiepersontype" "pessoa natural", "partiecnpjcpf" "43908445778", "partienumber" "67890854360" } ] } ], "creditcardsaccounts" \[ { "creditcardaccountid" "xxztr3459087", "brandname" "banco do brasil", "companycnpj" "21128159000166", "name" "cartão universitário", "producttype" "outros", "productadditionalinfo" "string", "creditcardnetwork" "visa", "networkadditionalinfo" "aura card", "paymentmethod" \[ { "identificationnumber" "4453", "ismultiplecreditcard" true } ], "limits" \[ { "creditlinelimittype" "limite credito total", "identificationnumber" "4453", "linename" "credito a vista", "islimitflexible" true, "linenameadditionalinfo" "informações adicionais e complementares ", "consolidationtype" "consolidado", "availableamount" { "amount" "1000 0400", "currency" "brl" }, "limitamount" { "amount" "1000 0400", "currency" "brl" }, "usedamount" { "amount" "1000 0400", "currency" "brl" } } ], "bills" \[ { "billid" "3459087xxztr", "duedate" "2021 05 21", "isinstalment" false, "billtotalamount" { "amount" "1000 0400", "currency" "brl" }, "billminimumamount" { "amount" "1000 0400", "currency" "brl" }, "financecharges" \[ { "amount" "100000 0400", "currency" "brl", "type" "juros remuneratorios atraso pagamento fatura", "additionalinfo" "informações adicionais" } ], "payments" \[ { "paymentmode" "debito conta corrente", "valuetype" "valor pagamento fatura parcelado", "amount" "1000 0400", "currency" "brl", "paymentdate" "2021 05 21" } ] } ], "transactions" \[ { "billid" "mtu0otu1nji2ntk4otrmc2zhzdrmc2q1nmzkm", "transactionid" "txprmu9uqtromwhzv2xsu1fuazjsmdl", "transactiontype" "cashback", "creditdebittype" "debito", "transactiondate" "2021 05 21", "transactionname" "pgto", "brazilianamount" { "currency" "brl", "amount" "1000 0400" }, "amount" { "amount" "1000 0400", "currency" "brl" }, "billpostdate" "2021 05 21", "chargenumber" 12, "feetype" "anuidade", "paymenttype" "a vista", "othercreditstype" "credito rotativo", "identificationnumber" "4453", "chargeidentificator" "parcela 1", "feetypeadditionalinfo" "string", "transactionaladditionalinfo" "string", "othercreditsadditionalinfo" "string", "payeemcc" 5137 } ] } ], "personalcustomeridentification" \[ { "updatedatetime" "2021 05 21t08 30 00z", "personalid" "578 psd 71md6971kjh 2d414", "brandname" "organização a", "civilname" "juan kaique cláudio fernandes", "socialname" "jaqueline de freitas", "birthdate" "1989 03 23", "maritalstatuscode" "outro", "maritalstatusadditionalinfo" "amasiado", "sex" "feminino", "companiescnpj" \[ "01773247000103", "01773247000563" ], "documents" { "cpfnumber" "25872252137", "passport" { "number" "75253468744594820620", "country" "can", "expirationdate" "2021 05 21", "issuedate" "2021 05 21" } }, "otherdocuments" \[ { "type" "cnh", "typeadditionalinfo" "crea rj", "number" "15291908", "checkdigit" "p", "additionalinfo" "ssp/sp", "expirationdate" "2021 05 21" } ], "hasbraziliannationality" false, "nationality" \[ { "othernationalitiesinfo" "can", "documents" \[ { "type" "social sec", "number" "423929299", "expirationdate" "2021 05 21", "issuedate" "2021 05 21", "country" "brasil", "additionalinfo" "informações adicionais " } ] } ], "filiation" \[ { "type" "pai", "civilname" "marcelo cláudio fernandes", "socialname" "string" } ], "contacts" { "postaladdresses" \[ { "ismain" true, "address" "av naburo ykesaki, 1270", "additionalinfo" "fundos", "districtname" "centro", "townname" "marília", "ibgetowncode" "3550308", "countrysubdivision" "sp", "postcode" "17500001", "country" "brasil", "countrycode" "bra", "geographiccoordinates" { "latitude" " 23 5475000", "longitude" " 46 6361100" } } ], "phones" \[ { "ismain" true, "type" "fixo", "additionalinfo" "informações adicionais ", "countrycallingcode" "55", "areacode" "19", "number" "29875132", "phoneextension" "932" } ], "emails" \[ { "ismain" true, "email" "abcd\@br inter net" } ] } } ] } response please refer to products