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.
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).
Because 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.
POST
Request
Header Parameters
Content-Type
required
String
Must be 'application/json'
partner_code
required
String
Partner code
partner_token
required
String
Partner token
Body Parameters
@userdata.json
required
Object
End-user open finance data, it can be a JSON file or a JSON object
Curl
curl --location 'https://api-testing.klavi.ai/klaas/openbanking/v1/analytics' \
-H 'Content-Type: application/json' \
-H 'partner_code: 123xxx' \
-H 'partner_token: 2fd6cbcddeafd5ToRxbv8Q9UtfDMO' \
-d '@userdata.json'
curl --location 'https://api-testing.klavi.ai/klaas/openbanking/v1/analytics' \
-H 'Content-Type: application/json' \
-H 'partner_code: 123xxx' \
-H 'partner_token: 2fd6cbcddeafd5ToRxbv8Q9UtfDMO' \
-d '@userdata.json'
Responses
200
// For detailed information, please refer to the Response Body below
// For detailed information, please refer to the Response Body below
﻿
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": "[email protected]"
          }
        ]
      }
    }
  ]
}
{
  "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.
Updated 08 Oct 2024
Did this page help you?
Transactions Categorization
Release History