Institutional-level report

2 min

institution-data

Get institution level products by institutionCode and end-user's taxId. After the end user completes authorization on the bank side, the Klavi backend will send the event through webhook. Then, partners can request the report products based on the event through this endpoint.

GET

https://api-sandbox.klavi.ai/data/v1/business/institution-data

Query Parameters

taxIdstringrequired
Description
The CNPJ of the company, for Business Accounts only
institutionCodestringrequired
Description
Institution identity
linkIdstring
Description
linkId, it returned by the /links
consentIdsstring
Description
consentId list, it returned by the /consents
productstringrequired
Description
Product

Header Parameters

Authorizationstringrequired
Description
Bearer access token, it returned by the /auth API

curl

curl --location 'https://api-sandbox.klavi.ai/data/v1/business/institution-data?taxId=String&institutionCode=String&linkId=String&consentIds=String&product=String' \
--header 'Authorization: string' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'

200

{
    "code": 200,
    "message": "OK",
    "requestId": "112334",
    "productName": "pj_checking_account",
    "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",
                    "type": "PIX"
                }
            ]
        }
    ],
    "externalInfo": {
        "myTraceId": "yourtraceid-1",
        "myUUID": "youruuid-1"
    }
}

Parameter

product

product: institutional level products (can only be products within the product range selected by the partner during onboarding);