Open Finance Analytics

{ "name" "analytics", "method" "post", "url" "https //api sandbox klavi ai/klaas/openbanking/v1/analytics", "description" "partners send users' open finance data through this api klavi backend systems will receive, clean, classify, process and calculate the data, and returns the analytics report to partners through asynchronous method (webhook) \nbecause there are many data processing processes, this api is asynchronous the submission process can be ended after the partner successfully submits the data when klavi completes the whole processing, it will return the analytics report to partners through the webhook ", "tab" "examples", "examples" { "languages" \[ { "id" "yww5o ajv2hzfttnvxqeq", "language" "curl", "code" "curl location 'https //api sandbox klavi ai/klaas/openbanking/v1/analytics' \\\\\n header 'accept application/json' \\\\\n header 'content type application/json' \\\\\n data @example json'", "customlabel" "" }, { "id" " m49i8lxtebi2py9l8vyc", "language" "nodejs", "code" "var request = require('request');\nvar options = {\n 'method' 'post',\n 'url' 'https //api sandbox klavi ai/klaas/openbanking/v1/analytics',\n 'headers' {\n 'accept' 'application/json',\n 'content type' 'application/json'\n },\n body json stringify({\n \\"connectionid\\" \\"string\\"\n })\n\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "customlabel" "" }, { "id" "nblqraz 0lb5wvf0q65as", "language" "javascript", "code" "var myheaders = new headers();\nmyheaders append(\\"accept\\", \\"application/json\\");\nmyheaders append(\\"content type\\", \\"application/json\\");\n\nvar raw = json stringify({\n \\"connectionid\\" \\"string\\"\n});\n\nvar requestoptions = {\n method 'post',\n headers myheaders,\n body raw,\n redirect 'follow'\n};\n\nfetch(\\"https //api sandbox klavi ai/klaas/openbanking/v1/analytics\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" }, { "id" "5l5bjxpmnellkofekwv4a", "language" "python", "code" "import requests\nimport json\n\nurl = \\"https //api sandbox klavi ai/klaas/openbanking/v1/analytics\\"\n\npayload = json dumps({\n \\"connectionid\\" \\"string\\"\n})\nheaders = {\n 'accept' 'application/json',\n 'content type' 'application/json'\n}\n\nresponse = requests request(\\"post\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" }, { "id" " iwcvm2oougg0vayhb96y", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"json\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //api sandbox klavi ai/klaas/openbanking/v1/analytics\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http post new(url)\nrequest\[\\"accept\\"] = \\"application/json\\"\nrequest\[\\"content type\\"] = \\"application/json\\"\nrequest body = json dump({\n \\"connectionid\\" \\"string\\"\n})\n\nresponse = https request(request)\nputs response read body\n", "customlabel" "" } ], "selectedlanguageid" " iwcvm2oougg0vayhb96y" }, "results" { "languages" \[ { "id" "jgejyrfj hzwnr5fp uzl", "language" "200", "customlabel" "", "code" "" } ], "selectedlanguageid" "jgejyrfj hzwnr5fp uzl" }, "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[ { "name" "authorization", "kind" "required", "type" "string", "description" "jwt bearer token", "" "required" } ], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" }, "hastryitout" false, "response" \[ { "name" "connectionid", "kind" "optional", "type" "string", "description" "connectionid" }, { "name" "userconsent", "kind" "optional", "type" "string", "description" "user consent for data access and usage (“yes” or “no”)", "children" \[] }, { "name" "reporttype", "kind" "optional", "type" "string", "description" "indicator of report type", "children" \[] }, { "name" "reportid", "kind" "optional", "type" "string", "description" "unique id for each report", "children" \[] }, { "name" "reportversion", "kind" "optional", "type" "string", "description" "version for each report", "children" \[] }, { "name" "risklabel", "kind" "optional", "type" "object", "description" "risk label", "children" \[ { "name" "accountinfo", "kind" "optional", "type" "object", "description" "", "children" \[ { "name" "bankname", "kind" "optional", "type" "string", "description" "bank name" }, { "name" "bacenname", "kind" "optional", "type" "string", "description" "institution name in central bank" }, { "name" "bacenid", "kind" "optional", "type" "string", "description" "institution id in central bank" }, { "name" "agencynumber", "kind" "optional", "type" "string", "description" "agency number" }, { "name" "accountnumber", "kind" "optional", "type" "string", "description" "account number of checking account" }, { "name" "holdername", "kind" "optional", "type" "string", "description" "name of account owner" } ] }, { "name" "labeldetails", "kind" "optional", "type" "object", "description" "laebel details", "children" \[ { "name" "labelcode", "kind" "optional", "type" "string", "description" "label code" }, { "name" "labelname", "kind" "optional", "type" "string", "description" "label name" }, { "name" "labelvalue", "kind" "optional", "type" "string", "description" "label value\nspecial note unable to calculate or no value represented by 999999" } ] } ] } ] } request example asynchronous response example { "code" 200, "msg" "ok", "queryparam" { "processfinishedtime" "2022 06 08 17 04 13", "processstarttime" "2022 04 26 15 38 06", "uuid" "d00411ba c533 11ec a6e7 1e003b01a495" }, "reporttime" "2022 06 08 17 04 13", "data" { "connectionid" "dxnfovjin1kbbngpgrjhu0zsupnht", "userconsent" "yes", "reportid" "f7757d5a e709 11ec 97fc 064bb0845", "reporttype" "b label", "reportversion" "v2", "risklabel" { "accountinfo" { "accountnumber" "1234 0", "agencynumber" "2345 2", "bacenid" "001", "bacenname" "banco do brasil s a ", "bankname" "banco do brasil", "holdername" "usuario anonimo" }, "labeldetails" \[ { "labelcode" "b001", "labelname" "klavi transactions gross inflows 0 30 v1(full month)", "labelvalue" 999999 }, { "labelcode" "b002", "labelname" "klavi transactions gross inflows 31 60 v1(full month)", "labelvalue" 0 }, { "labelcode" "b003", "labelname" "klavi transactions gross inflows 61 90 v1(full month)", "labelvalue" 3440 44 }, { "labelcode" "b004", "labelname" "klavi transactions recurring inflows 0 30 v1(full month)", "labelvalue" 999999 }, { "labelcode" "b005", "labelname" "klavi transactions recurring inflows 31 60 v1(full month)", "labelvalue" 0 }, { "labelcode" "b006", "labelname" "klavi transactions recurring inflows 61 90 v1(full month)", "labelvalue" 3440 44 }, { "labelcode" "b007", "labelname" "klavi transactions real income 0 30 v1(full month)", "labelvalue" 999999 }, { "labelcode" "b008", "labelname" "klavi transactions real income 31 60 v1(full month)", "labelvalue" 0 }, { "labelcode" "b009", "labelname" "klavi transactions real income 61 90 v1(full month)", "labelvalue" 3440 44 }, { "labelcode" "b010", "labelname" "klavi transactions salary 0 30 v1(full month)", "labelvalue" 999999 }, { "labelcode" "b011", "labelname" "klavi transactions salary 31 60 v1(full month)", "labelvalue" 0 }, { "labelcode" "b012", "labelname" "klavi transactions salary 61 90 v1(full month)", "labelvalue" 0 }, { "labelcode" "b013", "labelname" "klavi transactions salary payday v1(full month)", "labelvalue" 999999 }, { "labelcode" "b014", "labelname" "klavi transactions transaction count 0 30 v1", "labelvalue" 999999 }, { "labelcode" "b015", "labelname" "klavi transactions transaction count 31 60 v1", "labelvalue" 3 }, { "labelcode" "b016", "labelname" "klavi transactions transaction count 61 90 v1", "labelvalue" 7 }, { "labelcode" "b017", "labelname" "klavi transactions fired 0 30 v1", "labelvalue" 999999 }, { "labelcode" "b018", "labelname" "klavi transactions fired 31 60 v1", "labelvalue" 0 }, { "labelcode" "b019", "labelname" "klavi transactions fired 61 90 v1", "labelvalue" 0 }, { "labelcode" "b020", "labelname" "klavi transactions inss 0 30 v1", "labelvalue" 999999 }, { "labelcode" "b021", "labelname" "klavi transactions inss 31 60 v1", "labelvalue" 0 }, { "labelcode" "b022", "labelname" "klavi transactions inss 61 90 v1", "labelvalue" 0 }, { "labelcode" "b023", "labelname" "klavi transactions returned check 0 30 v1", "labelvalue" 999999 }, { "labelcode" "b024", "labelname" "klavi transactions returned check 31 60 v1", "labelvalue" 0 }, { "labelcode" "b025", "labelname" "klavi transactions returned check 61 90 v1", "labelvalue" 0 }, { "labelcode" "b026", "labelname" "klavi transactions overdraft usage fee 0 30 v1", "labelvalue" 999999 }, { "labelcode" "b027", "labelname" "klavi transactions overdraft usage fee 31 60 v1", "labelvalue" 0 }, { "labelcode" "b028", "labelname" "klavi transactions overdraft usage fee 61 90 v1", "labelvalue" 0 }, { "labelcode" "b029", "labelname" "klavi transactions overdraft excess fee 0 30 v1", "labelvalue" 999999 }, { "labelcode" "b030", "labelname" "klavi transactions overdraft excess fee 31 60 v1", "labelvalue" 0 }, { "labelcode" "b031", "labelname" "klavi transactions overdraft excess fee 61 90 v1", "labelvalue" 0 }, { "labelcode" "b032", "labelname" "klavi transactions balance 0 30 v1(full month)", "labelvalue" 110 53 }, { "labelcode" "b033", "labelname" "klavi transactions balance 31 60 v1(full month)", "labelvalue" 110 53 }, { "labelcode" "b034", "labelname" "klavi transactions balance 61 90 v1(full month)", "labelvalue" 281 02 }, { "labelcode" "b035", "labelname" "klavi transactions lowest balance 0 30 v1(full month)", "labelvalue" 110 53 }, { "labelcode" "b036", "labelname" "klavi transactions lowest balance 31 60 v1(full month)", "labelvalue" 110 53 }, { "labelcode" "b037", "labelname" "klavi transactions lowest balance 61 90 v1(full month)", "labelvalue" 281 02 }, { "labelcode" "b038", "labelname" "klavi transactions highest balance 0 30 v1(full month)", "labelvalue" 110 53 }, { "labelcode" "b039", "labelname" "klavi transactions highest balance 31 60 v1(full month)", "labelvalue" 281 02 }, { "labelcode" "b040", "labelname" "klavi transactions highest balance 61 90 v1(full month)", "labelvalue" 3225 82 }, { "labelcode" "b041", "labelname" "klavi transactions days using overdraft 0 30 v1", "labelvalue" 999999 }, { "labelcode" "b042", "labelname" "klavi transactions days using overdraft 31 60 v1", "labelvalue" 0 }, { "labelcode" "b043", "labelname" "klavi transactions days using overdraft 61 90 v1", "labelvalue" 0 }, { "labelcode" "b044", "labelname" "klavi transactions credit card interest 0 30 v1", "labelvalue" 999999 }, { "labelcode" "b045", "labelname" "klavi transactions credit card interest 31 60 v1", "labelvalue" 0 }, { "labelcode" "b046", "labelname" "klavi transactions credit card interest 61 90 v1", "labelvalue" 0 }, { "labelcode" "b047", "labelname" "klavi transactions has credit card 0 30 v1", "labelvalue" 999999 }, { "labelcode" "b048", "labelname" "klavi transactions has credit card 31 60 v1", "labelvalue" 999999 }, { "labelcode" "b049", "labelname" "klavi transactions has credit card 61 90 v1", "labelvalue" 999999 }, { "labelcode" "b050", "labelname" "klavi transactions card expenses 0 30 v1", "labelvalue" 999999 }, { "labelcode" "b051", "labelname" "klavi transactions card expenses 31 60 v1", "labelvalue" 999999 }, { "labelcode" "b052", "labelname" "klavi transactions card expenses 61 90 v1", "labelvalue" 999999 }, { "labelcode" "b053", "labelname" "klavi transactions withdraw\ 0 30 v1", "labelvalue" 999999 }, { "labelcode" "b054", "labelname" "klavi transactions withdraw\ 31 60 v1", "labelvalue" 0 }, { "labelcode" "b055", "labelname" "klavi transactions withdraw\ 61 90 v1", "labelvalue" 0 }, { "labelcode" "b056", "labelname" "klavi transactions financial expenses 0 30 v1", "labelvalue" 999999 }, { "labelcode" "b057", "labelname" "klavi transactions financial expenses 31 60 v1", "labelvalue" 5 }, { "labelcode" "b058", "labelname" "klavi transactions financial expenses 61 90 v1", "labelvalue" 5 }, { "labelcode" "b059", "labelname" "klavi transactions loan outflows 0 30 v1", "labelvalue" 999999 }, { "labelcode" "b060", "labelname" "klavi transactions loan outflows 31 60 v1", "labelvalue" 0 }, { "labelcode" "b061", "labelname" "klavi transactions loan outflows 61 90 v1", "labelvalue" 0 }, { "labelcode" "b062", "labelname" "klavi transactions loan inflows 0 30 v1", "labelvalue" 999999 }, { "labelcode" "b063", "labelname" "klavi transactions loan inflows 31 60 v1", "labelvalue" 0 }, { "labelcode" "b064", "labelname" "klavi transactions loan inflows 61 90 v1", "labelvalue" 0 }, { "labelcode" "b065", "labelname" "klavi transactions cash flow\ 0 30 v1", "labelvalue" 999999 }, { "labelcode" "b066", "labelname" "klavi transactions cash flow\ 31 60 v1", "labelvalue" 170 49 }, { "labelcode" "b067", "labelname" "klavi transactions cash flow\ 61 90 v1", "labelvalue" 340 41 }, { "labelcode" "b068", "labelname" "klavi transactions gross outflows 0 30 v1(full month)", "labelvalue" 999999 }, { "labelcode" "b069", "labelname" "klavi transactions gross outflows 31 60 v1(full month)", "labelvalue" 170 49 }, { "labelcode" "b070", "labelname" "klavi transactions gross outflows 61 90 v1(full month)", "labelvalue" 1276 39 }, { "labelcode" "b071", "labelname" "klavi transactions recurring outflows 0 30 v1(full month)", "labelvalue" 999999 }, { "labelcode" "b072", "labelname" "klavi transactions recurring outflows 31 60 v1(full month)", "labelvalue" 170 49 }, { "labelcode" "b073", "labelname" "klavi transactions recurring outflows 61 90 v1(full month)", "labelvalue" 1276 39 }, { "labelcode" "b074", "labelname" "klavi transactions credit card highest limit 0 30 v1", "labelvalue" 999999 }, { "labelcode" "b075", "labelname" "klavi transactions credit card highest limit 31 60 v1", "labelvalue" 999999 }, { "labelcode" "b076", "labelname" "klavi transactions credit card highest limit 61 90 v1", "labelvalue" 999999 }, { "labelcode" "b077", "labelname" "klavi transactions credit card lowest limit 0 30 v1", "labelvalue" 999999 }, { "labelcode" "b078", "labelname" "klavi transactions credit card lowest limit 31 60 v1", "labelvalue" 999999 }, { "labelcode" "b079", "labelname" "klavi transactions credit card lowest limit 61 90 v1", "labelvalue" 999999 }, { "labelcode" "b080", "labelname" "klavi transactions overdraft highest limit 0 30 v1", "labelvalue" 999999 }, { "labelcode" "b081", "labelname" "klavi transactions overdraft highest limit 31 60 v1", "labelvalue" 999999 }, { "labelcode" "b082", "labelname" "klavi transactions overdraft highest limit 61 90 v1", "labelvalue" 999999 }, { "labelcode" "b083", "labelname" "klavi transactions overdraft lowest limit 0 30 v1", "labelvalue" 999999 }, { "labelcode" "b084", "labelname" "klavi user accounts email v1", "labelvalue" "b och 0\@ho il c " }, { "labelcode" "b085", "labelname" "klavi user accounts count v1", "labelvalue" 1 }, { "labelcode" "b086", "labelname" "klavi user accounts cpf v1", "labelvalue" "38047680838" }, { "labelcode" "b087", "labelname" "klavi user accounts fullname v1", "labelvalue" "filipe bruno chan" }, { "labelcode" "b088", "labelname" "klavi user accounts bank v1", "labelvalue" "001" }, { "labelcode" "b089", "labelname" "klavi user accounts agency v1", "labelvalue" "7074 2" }, { "labelcode" "b090", "labelname" "klavi user accounts accountnumber v1", "labelvalue" "5228" }, { "labelcode" "b091", "labelname" "klavi user accounts accountdigit v1", "labelvalue" "0" }, { "labelcode" "b092", "labelname" "klavi transactions reference date v1", "labelvalue" "2022 04 26" }, { "labelcode" "b093", "labelname" "klavi user type v1", "labelvalue" 999999 }, { "labelcode" "b094", "labelname" "klavi user days since first connection v1", "labelvalue" 43 }, { "labelcode" "b095", "labelname" "klavi transactions has car v1", "labelvalue" 0 }, { "labelcode" "b096", "labelname" "klavi transactions ipva payment 0 30 v1", "labelvalue" 999999 }, { "labelcode" "b097", "labelname" "klavi transactions ipva payment 31 60 v1", "labelvalue" 0 }, { "labelcode" "b098", "labelname" "klavi transactions ipva payment 61 90 v1", "labelvalue" 0 }, { "labelcode" "b099", "labelname" "klavi transactions fuel expenses 0 30 v1", "labelvalue" 999999 }, { "labelcode" "b100", "labelname" "klavi transactions fuel expenses 31 60 v1", "labelvalue" 0 }, { "labelcode" "b101", "labelname" "klavi transactions fuel expenses 61 90 v1", "labelvalue" 0 }, { "labelcode" "b102", "labelname" "klavi transactions fuel expenses count 0 30 v1", "labelvalue" 999999 }, { "labelcode" "b103", "labelname" "klavi transactions fuel expenses count 31 60 v1", "labelvalue" 0 }, { "labelcode" "b104", "labelname" "klavi transactions fuel expenses count 61 90 v1", "labelvalue" 0 }, { "labelcode" "b105", "labelname" "klavi transactions insurance income 0 30 v1", "labelvalue" 0 }, { "labelcode" "b106", "labelname" "klavi transactions insurance income 31 60 v1", "labelvalue" 0 }, { "labelcode" "b107", "labelname" "klavi transactions insurance income 61 90 v1", "labelvalue" 0 }, { "labelcode" "b108", "labelname" "klavi transactions insurance expenses 0 30 v1", "labelvalue" 999999 }, { "labelcode" "b109", "labelname" "klavi transactions insurance expenses 31 60 v1", "labelvalue" 0 }, { "labelcode" "b110", "labelname" "klavi transactions insurance expenses 61 90 v1", "labelvalue" 0 }, { "labelcode" "b111", "labelname" "klavi transactions connected credit cards count v1", "labelvalue" 999999 }, { "labelcode" "b112", "labelname" "klavi transactions cards number v1", "labelvalue" 999999 }, { "labelcode" "b113", "labelname" "klavi transactions card payment 0 30 v1", "labelvalue" 999999 }, { "labelcode" "b114", "labelname" "klavi transactions card payment 31 60 v1", "labelvalue" 999999 }, { "labelcode" "b115", "labelname" "klavi transactions card payment 61 90 v1", "labelvalue" 999999 }, { "labelcode" "b116", "labelname" "klavi transactions card payment cheking account 0 30 v1", "labelvalue" 999999 }, { "labelcode" "b117", "labelname" "klavi transactions card payment cheking account 31 60 v1", "labelvalue" 25 5 }, { "labelcode" "b118", "labelname" "klavi transactions card payment cheking account 61 90 v1", "labelvalue" 439 8 }, { "labelcode" "b119", "labelname" "klavi transactions credit card interest 0 30 v1", "labelvalue" 999999 }, { "labelcode" "b120", "labelname" "klavi transactions credit card interest 31 60 v1", "labelvalue" 0 }, { "labelcode" "b121", "labelname" "klavi transactions credit card interest 61 90 v1", "labelvalue" 0 }, { "labelcode" "b122", "labelname" "klavi transactions invoice installment 0 30 v1", "labelvalue" 999999 }, { "labelcode" "b123", "labelname" "klavi transactions invoice installment 31 60 v1", "labelvalue" 999999 }, { "labelcode" "b124", "labelname" "klavi transactions invoice installment 61 90 v1", "labelvalue" 999999 }, { "labelcode" "b125", "labelname" "klavi transactions investment application 0 30 v1", "labelvalue" 999999 }, { "labelcode" "b126", "labelname" "klavi transactions investment application 31 60 v1", "labelvalue" 0 }, { "labelcode" "b127", "labelname" "klavi transactions investment application 61 90 v1", "labelvalue" 0 }, { "labelcode" "b128", "labelname" "klavi transactions investment rescue 0 30 v1", "labelvalue" 999999 }, { "labelcode" "b129", "labelname" "klavi transactions investment rescue 31 60 v1", "labelvalue" 0 }, { "labelcode" "b130", "labelname" "klavi transactions investment rescue 61 90 v1", "labelvalue" 0 }, { "labelcode" "b131", "labelname" "klavi transactions independent brokers investment application 0 30 v1", "labelvalue" 0 }, { "labelcode" "b132", "labelname" "klavi transactions independent brokers investment application 31 60 v1", "labelvalue" 0 }, { "labelcode" "b133", "labelname" "klavi transactions independent brokers investment application 61 90 v1", "labelvalue" 0 }, { "labelcode" "b134", "labelname" "klavi transactions independent brokers investment rescue 0 30 v1", "labelvalue" 0 }, { "labelcode" "b135", "labelname" "klavi transactions independent brokers investment rescue 31 60 v1", "labelvalue" 0 }, { "labelcode" "b136", "labelname" "klavi transactions independent brokers investment rescue 61 90 v1", "labelvalue" 0 }, { "labelcode" "b137", "labelname" "klavi transactions cdb balance v1", "labelvalue" 0 }, { "labelcode" "b138", "labelname" "klavi transactions funds balance v1", "labelvalue" 0 }, { "labelcode" "b139", "labelname" "klavi transactions savings balance v1", "labelvalue" 0 }, { "labelcode" "b140", "labelname" "klavi transactions private pension balance v1", "labelvalue" 0 }, { "labelcode" "b141", "labelname" "klavi transactions international iof 0 30 v1", "labelvalue" 999999 }, { "labelcode" "b142", "labelname" "klavi transactions international iof 31 60 v1", "labelvalue" 0 }, { "labelcode" "b143", "labelname" "klavi transactions international iof 61 90 v1", "labelvalue" 0 }, { "labelcode" "b144", "labelname" "klavi transactions international iof count 0 30 v1", "labelvalue" 999999 }, { "labelcode" "b145", "labelname" "klavi transactions international iof count 31 60 v1", "labelvalue" 0 }, { "labelcode" "b146", "labelname" "klavi transactions international iof count 61 90 v1", "labelvalue" 0 }, { "labelcode" "b147", "labelname" "klavi transactions real estate financing 0 30 v1", "labelvalue" 999999 }, { "labelcode" "b148", "labelname" "klavi transactions real estate financing 31 60 v1", "labelvalue" 0 }, { "labelcode" "b149", "labelname" "klavi transactions real estate financing 61 90 v1", "labelvalue" 0 } ] } } }