--- title: Products slug: ki/LlDr-products description: Learn about the various types of reports available in the Klavi API, including personal banking, investment, corporate banking, gig economy, and Know Your Customer (KYC). This document outlines a standardized JSON structure for data reports and provides e docTags: createdAt: 2022-03-28T08:23:53.000Z --- To serve different business purposes, Klavi API data is organized in JSON reports and it can be identified through the report\_type: **Personal banking** *** - Category\_checking - Category\_creditcard - Income - Liabilities - Financial\_insight - Score\_k1 (beta) - FGTS **** **Investment** *** - Investment **** **Corporate banking** *** - Corporate\_checking **** **Gig economy** *** - Gig\_economy **** **KYC** *** - Identity - Balance - Auth\_account (coming soon) - Auth\_creditcard (coming soon) **** **Common structure in all data report** ```json { "code":200, "msg":"ok", "report_time":"2019-12-23 06:10:43", "data":{ "enquiry_cpf":"12345678901", "user_consent":"Yes", "allow_autoupdate":"Yes", "connection_key":"gPuKXrCJU0kUDQO65J4k", "connection_id":"f45c899f-11eb-231f-97c4-4b2c16484587", "institution_id":"001", "report_type":"category_checking", "report_id":"4b2c1648-231f-11eb-97c4-f45c899f4587", "report_version":"V1", "report specification":[] } } ``` Apart from the common structure, the report specification is different for each report type and you can find full information of the data points as below. ## Category\_checking *** This report contains transaction data in the checking account for up to 6 months, including data points of account info, transaction date, description, amount, balance and category. | **Name** | **Type** | **Description** | | ---------------------- | ---------- | ---------------------------------------------------------------------- | | enquiry\_cpf | string | CPF provided by user or by partner for enquiry (via request parameter) | | user\_consent | string | User consent for data access and usage (“Yes” or “No”) | | allow\_autoupdate | string | Configuration of auto update for the account (“Yes” or “No”) | | connection\_key | string | Unique key for a specific bank connection of the certain use | | connection\_id | string | Unique ID for a specific connection | | institution\_id | string | Institution ID in Central Bank | | report\_type | string | Indicator of report type | | report\_id | string | Unique ID for each report | | report\_version | string | Version code of the report | | **Category\_checking** | **object** | Account object, multiple items allowed | | bank\_name | string | Bank name | | bacen\_name | string | Institution name in Central Bank | | bacen\_id | string | Institution ID in Central Bank | | bank\_branch | string | Agency number | | account | string | Checking account number | | operation\_code | string | Operation type of the account | | cpf\_verified | string | CPF on record with the Institution | | holder\_name | string | Name of account holder | | balance | number | Account balance at report time | | **transactionDetail** | **object** | Transaction details under the account | | trans\_date | string | Transaction date | | trans\_amount | number | Transaction amount | | trans\_description | string | Transaction description | | balance | number | Post-transaction balance | | category | string | Transaction category | **Example responses** ```json { "code":200, "msg":"ok", "report_time":"2019-12-23 06:10:43", "data":{ "enquiry_cpf":"12345678901", "user_consent":"Yes", "allow_autoupdate":"Yes", "connection_key":"gPuKXrCJU0kUDQO65J4k", "connection_id":"f45c899f-11eb-231f-97c4-4b2c16484587", "institution_id":"033", "report_type":"category_checking", "report_id":"4b2c1648-231f-11eb-97c4-f45c899f4587", "report_version":"V1", "Category_checking":[ { "bank_name":"Santander", "bacen_name":"BANCO SANTANDER (BRASIL) S.A.", "bacen_id":"033", "bank_branch":"1234", "account":"12.345678.9", "operation_code":"001", "cpf_verified":"12345678901", "holder_name":"Usuaro anonimo", "balance":18.75, "TransactionDetail":[ { "trans_date":"2019-12-23", "trans_amount":-150.05, "trans_description":"PREST EMPRESTIMOS/FINANCIAMENTOS AYMORE", "balance":18.75, "category":"Empréstimo" }, { "trans_date":"2019-12-20", "trans_amount":150, "trans_description":"TED MESMA TITULARIDADE CIP 237-3750-0000001234567", "balance":168.8, "category":"Transferência" } ] } ] } } ``` ## Category\_creditcard *** This report contains transaction data in the credit card account for up to 6 months, including data points of account info, credit limit, transaction date, description, amount and category. | **Name** | **Type** | **Description** | | ------------------------ | ---------- | --------------------------------------------------------------------------------------------------------------------------- | | enquiry\_cpf | string | CPF provided by user or by partner (via request parameter) | | user\_consent | string | User consent for data access and usage (“Yes” or “No”) | | allow\_autoupdate | string | Configuration of auto update for the account (“Yes” or “No”) | | connection\_key | string | Unique key for a specific bank connection of the certain user | | connection\_id | string | Unique ID for a specific connection | | institution\_id | string | Institution ID in Central Bank | | report\_type | string | Indicator of report type | | report\_id | string | Unique ID for each report | | report\_version | string | Version code of the report | | **Category\_creditcard** | **Object** | Account object, multiple items allowed | | bank\_name | string | Bank name | | bacen\_name | string | Institution name in Central Bank | | bacen\_id | string | Institution ID in Central Bank | | card\_last4num | string | Last 4 digits of card number | | cpf\_verified | string | CPF on record with the Institution | | holder\_name | string | Name of card holder | | card\_type | string | Credit card type | | credit\_limit | number | Total credit limit (display “999999” if is\_vip=1) | | available\_limit | number | Available credit limit (display “999999” if is\_vip=1) | | agency\_number | string | Agency number of internet banking | | bank\_account | string | Account number of internet banking | | is\_active | number | If credit card is active (0\:No, 1\:Yes) | | is\_vip | number | If credit card limit is flexible (0\:No, 1\:Yes) | | **openStatement** | **object** | Open bill statement | | bill\_amount | number | Bill amount | | due\_date | string | Expected payment due date | | billing\_date | string | Expected bill close date | | bill\_month | string | Bill month | | **transactionDetail** | **object** | Transaction details in open statement | | trans\_date | string | Transaction date | | trans\_amount | number | Transaction amount | | trans\_currency | string | Currency type (USD: US$, BRL: R$) | | trans\_description | string | Transaction description | | category | string | Transaction category | | payment\_type | string | Transaction installment type, "A\_PRAZO" for installments, "A\_VISTA" for non-installments | | charge\_identificator | string | The current installment number of the transaction, as in "PARCELA\_x". For non-installment transactions, it is "PARCELA\_0" | | charge\_number​ | number | The total installment number of the transaction. For non-installment transactions, it is "0" | | **closedStatement** | **object** | Closed bill statements | | billing\_date | string | Bill close date | | bill\_month | string | Bill month | | bill\_amount | number | Bill amount | | minimum\_payment | number | Minimum payment amount | | payment\_amount | number | Amount of bill payment | | payment\_date | string | Date of bill payment | | **transactionDetail** | **object** | Transaction details in open statement | | trans\_date | string | Transaction date | | trans\_amount | number | Transaction amount | | trans\_currency | string | Currency type (USD: US$, BRL: R$) | | trans\_description | string | Transaction description | | category | string | Transaction category | | payment\_type | string | Transaction installment type, "A\_PRAZO" for installments, "A\_VISTA" for non-installments | | charge\_identificator | string | The current installment number of the transaction, as in "PARCELA\_x". For non-installment transactions, it is "PARCELA\_0" | | charge\_number​ | number | The total installment number of the transaction. For non-installment transactions, it is "0" | **Example responses** ```json { "code":200, "msg":"ok", "report_time":"2020-02-08 03:49:38", "data":{ "enquiry_cpf":"12345678901", "user_consent":"Yes", "allow_autoupdate":"Yes", "connection_key":"gPuKXrCJU0kUDQO65J4k", "connection_id":"f45c899f-11eb-231f-97c4-4b2c16484587", "institution_id":"341", "report_type":"category_creditcard", "report_id":"4b2c1648-231f-11eb-97c4-f45c899f4590", "report_version":"V1", "Category_creditcard":[ { "bank_name":"Itaú", "bacen_name":"ITAÚ UNIBANCO S.A.", "bacen_id":"341", "card_last4num":"1234", "cpf_verified":"12345678901", "holder_name":"Usuario anonimo", "card_type":"Itaucard Multiplo 2.0", "credit_limit":3300, "available_limit":3217.8, "agency_number":"1234", "bank_account":"12345-6", "is_active":1, "is_vip":0, "OpenStatement":{ "bill_amount":82.2, "due_date":"2020-03-06", "billing_date":"2020-02-24", "bill_month":"mar/20", "TransactionDetail":[ { "trans_date":"2020-02-06", "trans_amount":120.55, "trans_currency":"BRL", "trans_description":"PAGAMENTO EFETUADO", "category":"Pagamento de cartão", "payment_type":"A_VISTA", "charge_identificator":"PARCELA_0", "charge_number":0 }, { "trans_date":"2020-02-02", "trans_amount":-19.9, "trans_currency":"BRL", "trans_description":"Perfumaria Sunny", "category":"Cuidados pessoais", "payment_type":"A_VISTA", "charge_identificator":"PARCELA_0", "charge_number":0 }, { "trans_date":"2020-01-25", "trans_amount":-62.3, "trans_currency":"BRL", "trans_description":"Mc Donalds Mac", "category":"Bares / Restaurantes", "payment_type":"A_VISTA", "charge_identificator":"PARCELA_0", "charge_number":0 } ] }, "ClosedStatement":[ { "billing_date":"2020-01-27", "bill_month":"fev/20", "bill_amount":120.55, "minimum_payment":12, "payment_date":"2020-02-06", "payment_amount":120.55, "TransactionDetail":[ { "trans_date":"2020-01-22", "trans_amount":-34, "trans_currency":"BRL", "trans_description":"Comercial Pirituba", "category":"Compras", "payment_type":"A_VISTA", "charge_identificator":"PARCELA_0", "charge_number":0 }, { "trans_date":"2020-01-22", "trans_amount":-86.55, "trans_currency":"BRL", "trans_description":"OTICAS CAROL 01/10", "category":"Compras", "payment_type":"A_PRAZO", "charge_identificator":"PARCELA_1", "charge_number":10 } ] } ] }, { "bank_name":"Itaú", "bacen_name":"ITAÚ UNIBANCO S.A.", "bacen_id":"341", "card_last_4_num":"5678", "cpf_verified":"12345678901", "holder_name":"Usuario anonimo", "card_type":"Itaucard Mastercard International", "credit_limit":2000, "available_limit":1886.55, "account":"12345-6", "is_active":1, "OpenStatement":{ "bill_amount":113.45, "due_date":"2020-03-06", "billing_date":"2020-02-27", "bill_month":"mar/20", "TransactionDetail":[ { "trans_date":"2020-02-06", "trans_amount":42.53, "trans_currency":"BRL", "trans_description":"PAGAMENTO EFETUADO", "category":"Pagamento de cartão", "payment_type":"A_VISTA", "charge_identificator":"PARCELA_0", "charge_number":0 }, { "trans_date":"2020-02-04", "trans_amount":-33.6, "trans_currency":"BRL", "trans_description":"Casa de paes", "category":"Bares / Restaurantes", "payment_type":"A_VISTA", "charge_identificator":"PARCELA_0", "charge_number":0 }, { "trans_date":"2020-02-03", "trans_amount":-72.9, "trans_currency":"BRL", "trans_description":"Mercadopago *natur", "category":"Compras", "payment_type":"A_VISTA", "charge_identificator":"PARCELA_0", "charge_number":0 }, { "trans_date":"2020-01-30", "trans_amount":-6.95, "trans_currency":"BRL", "trans_description":"Uberbr Uber Trip Help.", "category":"Táxi / App", "payment_type":"A_VISTA", "charge_identificator":"PARCELA_0", "charge_number":0 } ] }, "ClosedStatement":[ { "billing_date":"2020-01-27", "bill_month":"fev/20", "bill_amount":42.53, "minimum_payment":0, "payment_date":"2020-02-06", "payment_amount":42.53, "TransactionDetail":[ { "trans_date":"2020-01-27", "trans_amount":-30.63, "trans_currency":"BRL", "trans_description":"Multa Por Atraso", "category":"Outros serviços financeiros", "payment_type":"A_VISTA", "charge_identificator":"PARCELA_0", "charge_number":0 }, { "trans_date":"2019-12-28", "trans_amount":-11.9, "trans_currency":"BRL", "trans_description":"Casa de paes", "category":"Bares / Restaurantes", "payment_type":"A_VISTA", "charge_identificator":"PARCELA_0", "charge_number":0 } ] } ] } ] } } ``` ## Income *** This consolidated report covers different income streams, such as regular salary and pension. | **Name** | **Type** | **Description** | | ------------------------------ | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | enquiry\_cpf | string | CPF provided by user or by partner for enquiry (via request parameter) | | user\_consent | string | User consent for data access and usage (“Yes” or “No”) | | allow\_autoupdate | string | Configuration of auto update for the account (“Yes” or “No”) | | connection\_key | string | Unique key for a specific bank connection of the certain use | | connection\_id | string | Unique ID for a specific connection | | institution\_id | string | Institution ID in Central Bank | | report\_type | string | Indicator of report type | | report\_id | string | Unique ID for each report | | report\_version | string | Version code of the report | | **income** | **object** | Income details in last 180 days (if available) | | bank\_name | string | Bank name | | bacen\_name | string | Institution name in Central Bank | | bacen\_id | string | Institution ID in Central Bank | | agency\_number | string | Agency number | | account\_number | string | Checking account number | | cpf\_verified | string | CPF on record with the Institution | | account\_holder | string | Name of account holder | | days\_covered | number | Extent of data covered for the checking account | | number\_of\_income\_streams | number | Number of income streams in the days covered | | total\_income\_last\_30\_days | number | Total income in last 30 days, sum of all income streams (up to the days covered if less data available) | | total\_income\_last\_60\_days | number | Total income in last 60 days, sum of all income streams (up to the days covered if less data available) | | total\_income\_last\_90\_days | number | Total income in last 90 days, sum of all income streams (up to the days covered if less data available) | | total\_income\_last\_180\_days | number | Total income in last 180 days, sum of all income streams (up to the days covered if less data available) | | **incomeStream** | **object** | Detail of a specific income stream in last 180 days (if available) | | income\_stream\_type | string | Income stream type, can be one of the followings: Regular salary / Bonus / Business income / Retirement pension / Sponsorship pension / Government support / Other recurrent income / Investment redemption / Investment dividend | | **incomeDay** | **Object** | Day of receiving income (applicable to Regular salary, Retirement pension, Sponsorship pension, Government support only) | | 1st\_income\_day | string | 1st income receiving day (applicable to Regular salary, Retirement pension, Sponsorship pension, Government support only) | | 2nd\_income\_day | string | 2nd income receiving day (applicable to Regular salary, Retirement pension, Sponsorship pension, Government support only) | | **incomeTransactions** | **object** | Details of income transactions per income stream | | trans\_date | string | Transaction date | | trans\_amount | number | Transaction amount | | trans\_description | string | Transaction description | **Example responses** ```json { "code": 200, "msg": "ok", "report_time": "2022-03-03 10:18:41", "data": { "enquiry_cpf": "01234567890", "user_consent": "Yes", "allow_autoupdate": "Yes", "connection_key": "a37286b568e543caa4ab6ca8d7867cee", "connection_id": "lrgekhgNXao8yPXgdjlMbrYgb9kxrKAo", "institution_id": "341", "report_type": "income", "report_id": "71f2f906-9af4-11ec-be80-0aac1b96a2d0", "report_version": "V1.1", "Income": [ { "account_holder": "JOHN DOE", "account_number": "12345-8", "agency_number": "8341", "bacen_id": "341", "bacen_name": "ITAÚ UNIBANCO S.A.", "bank_name": "Itaú", "cpf_verified": "01234567890", "days_covered": 180, "number_of_income_streams": 1, "total_income_last_180_days": 30113, "total_income_last_30_days": 5115, "total_income_last_60_days": 11609, "total_income_last_90_days": 13671, "incomeStream": [ { "incomeDay": { "1st_income_day": "3", "2nd_income_day": "20" }, "incomeTransactions": [ { "trans_amount": 1016, "trans_date": "2022-02-18", "trans_description": "PAGTO SALARIO " } ], "income_stream_type": "Regular salary" } ] }, { "account_holder": "JOHN DOE", "account_number": "23456-3", "agency_number": "8341", "bacen_id": "341", "bacen_name": "ITAÚ UNIBANCO S.A.", "bank_name": "Itaú", "cpf_verified": "01234567890", "days_covered": 180, "number_of_income_streams": 1, "total_income_last_180_days": 30113, "total_income_last_30_days": 5115, "total_income_last_60_days": 11609, "total_income_last_90_days": 13671, "incomeStream": [ { "incomeDay": { "1st_income_day": "10", "2nd_income_day": "" }, "incomeTransactions": [ { "trans_amount": 1016, "trans_date": "2022-01-10", "trans_description": "PAGTO SALARIO " } ], "income_stream_type": "Regular salary" } ] } ] } } ``` ## Liabilities *** This consolidated report covers different liabilities streams, such as credit card bill and mortgage. | **Name** | **Type** | **Description** | | ----------------------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------- | | enquiry\_cpf | string | CPF provided by user or by partner for enquiry (via request parameter) | | user\_consent | string | User consent for data access and usage (“Yes” or “No”) | | allow\_autoupdate | string | Configuration of auto update for the account (“Yes” or “No”) | | connection\_key | string | Unique key for a specific bank connection of the certain user | | connection\_id | string | Unique ID for a specific connection | | institution\_id | string | Institution ID in Central Bank | | report\_type | string | Indicator of report type | | report\_id | string | Unique ID for each report | | report\_version | string | Version code of the report | | **liabilities** | **object** | Liabilities details in last 180 days (if available) | | bank\_name | string | Bank name | | bacen\_name | string | Institution name in Central Bank | | bacen\_id | string | Institution ID in Central Bank | | agency\_number | string | Agency number | | account\_number | string | Checking account number | | cpf\_verified | string | CPF on record with the Institution | | account\_holder | string | Name of account holder | | days\_covered | number | Extent of data covered for the checking account | | number\_of\_liability\_streams | number | Number of liability streams in the days covered | | total\_liabilities\_last\_30\_days | number | Total liabilities in last 30 days, sum of all liability streams (up to the days covered if less data available) | | total\_liabilities\_last\_60\_days | number | Total liabilities in last 60 days, sum of all liability streams (up to the days covered if less data available) | | total\_liabilities\_last\_90\_days | number | Total liabilities in last 90 days, sum of all liability streams (up to the days covered if less data available) | | total\_liabilities\_last\_180\_days | number | Total liabilities in last 180 days, sum of all liability streams (up to the days covered if less data available) | | **liabilityStream** | **object** | Detail of a specific liability stream in last 180 days (if available) | | liability\_stream\_type | string | Liability stream type, can be one of the followings: Credit card / Mortgage / Student loan / Bank loan / Other recurrent transfer | | **liabilityTransactions** | **object** | Details of liability transactions per liability stream | | trans\_date | string | Transaction date | | trans\_amount | number | Transaction amount | | trans\_description | string | Transaction description | **Example responses** ```json { "code": 200, "msg": "ok", "report_time": "2022-03-03 12:52:13", "data": { "enquiry_cpf":"12345678901", "user_consent":"Yes", "allow_autoupdate":"Yes", "connection_key":"gPuKXrCJU0kUDQO65J4k", "connection_id":"f45c899f-11eb-231f-97c4-4b2c16484587", "institution_id":"033", "report_type":"liabilities", "report_id":"4b2c1648-231f-11eb-97c4-f45c899f4592", "report_version":"V1.1", "Liabilities": [ { "account_holder": "JOHN DOE", "account_number": "01.12345.4", "agency_number": "1076", "bacen_id": "033", "bacen_name": "BANCO SANTANDER (BRASIL) S.A.", "bank_name": "Santander", "cpf_verified": "01234567890", "days_covered": 180, "number_of_liability_streams": 1, "total_liabilities_last_180_days": 17.25, "total_liabilities_last_30_days": 0, "total_liabilities_last_60_days": 0, "total_liabilities_last_90_days": 0, "liabilityStream": [ { "liability_stream_type": "Credit card", "liabilityTransactions": [ { "trans_date": "2021-11-22", "trans_amount": -17.25, "trans_description": "CARTAO CX" } ] } ] }, { "account_holder": "JOHN DOE", "account_number": "01.23456.2", "agency_number": "1076", "bacen_id": "033", "bacen_name": "BANCO SANTANDER (BRASIL) S.A.", "bank_name": "Santander", "cpf_verified": "01234567890", "days_covered": 180, "number_of_liability_streams": 1, "total_liabilities_last_180_days": 37.25, "total_liabilities_last_30_days": 0, "total_liabilities_last_60_days": 0, "total_liabilities_last_90_days": 37.25, "liabilityStream": [ { "liability_stream_type": "Credit card", "liabilityTransactions": [ { "trans_date": "2021-12-22", "trans_amount": -37.25, "trans_description": "CARTAO CX" } ] } ] } ] } } ``` ## Financial\_insight *** This consolidated report covers cash flow analysis, credit analysis (e.g. overdraft, pre-approved loan), credit card spending analysis, and other financial intelligences such as IPVA, IPTU. | **Name** | **Type** | **Description** | | ------------------------------------ | ---------- | ----------------------------------------------------------------------------------------------------- | | enquiry\_cpf | string | CPF provided by user or by partner for enquiry (via request parameter) | | user\_consent | string | User consent for data access and usage (“Yes” or “No”) | | allow\_autoupdate | string | Configuration of auto update for the account (“Yes” or “No”) | | connection\_key | string | Unique key for a specific bank connection of the certain user | | connection\_id | string | Unique ID for a specific connection | | institution\_id | string | Institution ID in Central Bank | | report\_type | string | Indicator of report type | | report\_id | string | Unique ID for each report | | report\_version | string | Version code of the report | | **cashflowAnalysis** | **object** | Cashflow analysis in last 180 days (if available) | | bank\_name | string | Bank name | | bacen\_name | string | Institution name in Central Bank | | bacen\_id | string | Institution ID in Central Bank | | agency\_number | string | Agency number | | account\_number | string | Checking account number | | cpf\_verified | string | CPF on record with the Institution | | account\_holder | string | Name of account holder | | days\_covered | number | Extent of data covered for the checking account | | checking\_account\_balance | number | Balance of the checking account | | avg\_daily\_balance\_last\_30\_days | number | Average day-end balance in last 30 days (up to the days covered if less data available) | | avg\_daily\_balance\_last\_60\_days | number | Average day-end balance in last 60 days (up to the days covered if less data available) | | avg\_daily\_balance\_last\_90\_days | number | Average day-end balance in last 90 days (up to the days covered if less data available) | | avg\_daily\_balance\_last\_180\_days | number | Average day-end balance in last 180 days (up to the days covered if less data available) | | inflow\_last\_30\_days | number | Total cash inflow in last 30 days (up to the days covered if less data available) | | inflow\_last\_60\_days | number | Total cash inflow in last 60 days (up to the days covered if less data available) | | inflow\_last\_90\_days | number | Total cash inflow in last 90 days (up to the days covered if less data available) | | inflow\_last\_180\_days | number | Total cash inflow in last 180 days (up to the days covered if less data available) | | outflow\_last\_30\_days | number | Total cash outflow in last 30 days (up to the days covered if less data available) | | outflow\_last\_60\_days | number | Total cash outflow in last 60 days (up to the days covered if less data available) | | outflow\_last\_90\_days | number | Total cash outflow in last 90 days (up to the days covered if less data available) | | outflow\_last\_180\_days | number | Total cash outflow in last 180 days (up to the days covered if less data available) | | savings\_account\_balance | number | Balance of the savings account (if not available, display "-1") | | **creditAnalysis** | **object** | Credit analysis of the account | | bank\_name | string | Bank name | | bacen\_name | string | Institution name in Central Bank | | bacen\_id | string | Institution ID in Central Bank | | account\_number | string | Checking account number | | overdraft\_limit | number | Overdraft limit associated with the checking account (if not available, display "-1") | | preapproved\_loan | number | Pre-approved loan amount associated with the checking account (if not available, display "-1") | | **creditcardSpending** | **object** | Credit card spending analysis in last 180 days (if available) | | bank\_name | string | Bank name | | bacen\_name | string | Institution name in Central Bank | | bacen\_id | string | Institution ID in Central Bank | | card\_holder | string | Name of card holder | | card\_last\_4\_digit | string | Last 4 digit of the associated credit card | | card\_type | string | Card type of the associated credit card | | credit\_limit | number | Credit limit of the associated credit card | | closed\_bills\_covered | number | Number of closed bills covered for the credit card account | | open\_bill\_balance | number | Balance of the open bill of the credit card account | | last\_closed\_bill | number | Amount of the last closed credit card bill | | avg\_last\_3\_closed\_bills | number | Average amount of the last 3 closed credit card bills (up to the days covered if less data available) | | days\_covered | number | Extent of data covered for the credit card account | | has\_late\_payment | string | Has late payment of the associated credit card in the days covered ("Yes" or "No") | | pay\_bills\_in\_installment | string | Pay bills in installment for the associated credit card in the days covered ("Yes" or "No") | | **financialProfile** | **object** | Financial profile specifications in last 180 days (if available) | | bank\_name | string | Bank name | | bacen\_name | string | Institution name in Central Bank | | bacen\_id | string | Institution ID in Central Bank | | account\_number | string | Checking account number | | days\_covered | number | Extent of data covered for the checking account | | has\_severance | string | Has severance transaction in the days covered ("Yes" or "No") | | has\_inss | string | Has INSS transaction in the days covered ("Yes" or "No") | | has\_returned\_cheque | string | Has returned cheque in the days covered ("Yes" or "No") | | has\_ipva\_payment | string | Has IPVA transaction in the days covered ("Yes" or "No") | | has\_iptu\_payment | string | Has IPTU transaction in the days covered ("Yes" or "No") | | overdraft\_interest | number | Overdraft interest paid in the days covered | | additional\_overdraft\_interest | number | Additional overdraft interest paid in the days covered | | atm\_withdrawal | number | ATM withdrawal amount in the days covered | | iof | number | IOF paid in the days covered | **Example responses** ```json { "code": 200, "msg": "ok", "report_time": "2022-03-03 09:45:54", "data": { "enquiry_cpf":"12345678901", "user_consent":"Yes", "allow_autoupdate":"No", "connection_key":"gPuKXrCJU0kUDQO65J4k", "connection_id":"f45c899f-11eb-231f-97c4-4b2c16484587", "institution_id":"341", "report_type":"financial_insight", "report_id":"4b2c1648-231f-11eb-97c4-f45c899f4593", "report_version": "V1.1", "financial_insight": [ { "bacen_id": "033", "bacen_name": "BANCO SANTANDER (BRASIL) S.A.", "bank_name": "Santander", "agency_number": "1076", "account_number": "01.01234.4", "cpf_verified": "01234567890", "account_holder": "JOHN DOE", "days_covered": 0, "cashflowAnalysis": [ { "checking_account_balance": 0, "avg_daily_balance_last_180_days": -1, "avg_daily_balance_last_30_days": -1, "avg_daily_balance_last_60_days": -1, "avg_daily_balance_last_90_days": -1, "inflow_last_180_days": -1, "inflow_last_30_days": -1, "inflow_last_60_days": -1, "inflow_last_90_days": -1, "outflow_last_180_days": -1, "outflow_last_30_days": -1, "outflow_last_60_days": -1, "outflow_last_90_days": -1, "saving_account_balance": -1 } ], "creditAnalysis": [ { "overdraft_limit": 0, "preapproved_loan": 0 } ], "creditcardSpending": [ { "card_holder": "JOHN DOE", "card_last_4_digit": "1096", "card_type": "SANTANDER SX MASTER", "credit_limit": 0.01, "closed_bills_covered": 6, "open_bill_balance": 0, "last_closed_bill": -205.48, "avg_last_3_closed_bills": -205.48, "days_covered": 180, "has_late_payment": "No", "pay_bills_in_installment": "No" } ], "financialProfile": [ { "additional_overdraft_interest": 0, "atm_withdrawal": 0, "has_inss": "No", "has_iptu_payment": "No", "has_ipva_payment": "No", "has_returned_cheque": "No", "has_severance": "No", "iof": 0, "overdraft_interest": 0 } ] }, { "bacen_id": "033", "bacen_name": "BANCO SANTANDER (BRASIL) S.A.", "bank_name": "Santander", "agency_number": "1076", "account_number": "01.12345.2", "cpf_verified": "01234567890", "account_holder": "JOHN DOE", "days_covered": 0, "cashflowAnalysis": [ { "checking_account_balance": 0, "avg_daily_balance_last_180_days": -1, "avg_daily_balance_last_30_days": -1, "avg_daily_balance_last_60_days": -1, "avg_daily_balance_last_90_days": -1, "inflow_last_180_days": -1, "inflow_last_30_days": -1, "inflow_last_60_days": -1, "inflow_last_90_days": -1, "outflow_last_180_days": -1, "outflow_last_30_days": -1, "outflow_last_60_days": -1, "outflow_last_90_days": -1, "saving_account_balance": -1 } ], "creditAnalysis": [ { "overdraft_limit": 0, "preapproved_loan": 0 } ], "creditcardSpending": null, "financialProfile": [ { "additional_overdraft_interest": 0, "atm_withdrawal": 0, "has_inss": "No", "has_iptu_payment": "No", "has_ipva_payment": "No", "has_returned_cheque": "No", "has_severance": "No", "iof": 0, "overdraft_interest": 0 } ] } ] } } ``` ## Score\_k1 *** Based on bank transaction data, this credit score predicts the possibility of credit card payment default. Could be used as a reference score for risk assessment. | **Name** | **Type** | **Description** | | ----------------- | -------- | ---------------------------------------------------------------------- | | enquiry\_cpf | string | CPF provided by user or by partner for enquiry (via request parameter) | | user\_consent | string | User consent for data access and usage (“Yes” or “No”) | | allow\_autoupdate | string | Configuration of auto update for the account (“Yes” or “No”) | | connection\_key | string | Unique key for a specific bank connection of the certain user | | connection\_id | string | Unique ID for a specific connection | | institution\_id | string | Institution ID in Central Bank | | report\_type | string | Indicator of report type | | report\_id | string | Unique ID for each report | | report\_version | string | Version code of the report | | accountInfo | object | Account information | | bank\_name | string | Bank name | | bacen\_name | string | Institution name in Central Bank | | bacen\_id | string | Institution ID in Central Bank | | agency\_number | string | Agency number | | account\_number | string | Account number of checking account | | cpf\_verified | string | CPF on record with the Institution | | holder\_name | string | Name of account owner | | scoreDetail | object | Score detail | | score\_k1 | number | Klavi Score\_k1 of the user | | version | string | Score version | **Example responses** ```json { "code":200, "msg":"ok", "report_time":"2020-07-03 22:21:51", "report_id":"4b2c1648-231f-11eb-97c4-f45c899f4596", "data":{ "enquiry_cpf":"12345678901", "user_consent":"Yes", "allow_autoupdate":"No", "connection_key":"gPuKXrCJU0kUDQO65J4k", "connection_id":"f45c899f-11eb-231f-97c4-4b2c16484587", "institution_id":"341", "report_type":"score_k1", "report_id":"4b2c1648-231f-11eb-97c4-f45c899f4593", "report_version": "V1", "score_info": { "account_info": { "bank_name": "Itaú", "bacen_name":"ITAÚ UNIBANCO S.A.", "bacen_id":"341", "agency_number": "1234", "holder_name": "Usuario anonimo", "cpf_verified": "12345678901", "account_number": "1234-5" }, "score_detail": { "score_k1": 615, "version": "v1.0" } } } } ``` ## FGTS *** FGTS account data | **Name** | **Type** | **Description** | | ---------------------------------- | ---------- | ------------------------------------------------------------- | | enquiry\_cpf | string | CPF provided by user or by partner (via request parameter) | | user\_consent | string | User consent for data access and usage (“Yes” or “No”) | | allow\_autoupdate | string | Configuration of auto update for the account (“Yes” or “No”) | | connection\_key | string | Unique key for a specific bank connection of the certain user | | connection\_id | string | Unique ID for a specific connection | | institution\_id | string | Institution ID in Central Bank | | report\_type | string | Indicator of report type | | report\_id | string | Unique ID for each report | | report\_version | string | Version code of the report | | **personalInfo** | **Object** | Personal information | | cpf\_verified | string | CPF on record with the Institution | | holder\_name | string | Name on record with the Institution | | address | string | Street of the correspondence address | | city | string | City of the correspondence address | | state | string | State of the correspondence address | | country | string | Country of the correspondence address | | post\_code | string | Postcode of the correspondence address | | latest\_withdraw\_type | string | The type of user's latest withdrawal | | has\_birthday\_withdrawal | string | Whether user has birthday withdrawal | | latest\_birthday\_withdrawal\_date | string | The date user's latest birthday withdrawal | | e-mail | string | Email address on record with the Institution | | **withdrawalDetail** | **object** | Withdrawal record details | | withdrawal\_date | string | The date of withdrawal | | withdrawal\_description | string | The description of withdrawal | | withdrawal\_amount | string | The amount of withdrawal | | **bankAccount** | **object** | The bank account info for withdrawal | | bank\_name | string | Bank name | | agency\_number | string | Agency number | | account\_number | string | Account number | | account\_type | string | Account type | | **accountInfo** | **Object** | The FGTS account info | | pis\_pasep | string | The number of PIS\_PASEP | | company\_name | string | The name of the company | | company\_cnpj | string | The CNPJ number of the campany | | work\_permit | string | The work permit number | | account\_type | string | The type of the account | | category | string | The category of the account | | fgts\_account | string | The FGTS account number | | admission\_date | string | The admission date of the account | | movement\_code | string | The movement code of the account | | operation\_date | string | The operation date of the account | | interest\_rate | number | The interest rate of the account | | amount\_for\_termination | number | The termination amount | | balance | number | The account balance | | **transactionDetail** | **object** | Transaction details | | trans\_date | string | Transaction date | | trans\_description | string | Transaction description | | trans\_amount | number | Transaction amount | | trans\_balance | number | Post-transaction balance | | **exceptionalWithdrawal** | **object** | The exceptional withdrawal info | | available\_for\_exc\_withdrawal | number | The available amount | | excpected\_payment\_date | string | The payment date | | **exceptionalWithdrawalBank** | **object** | The bank info for exceptional withdrawal | | bank\_name | string | Bank name | | agency\_number | string | Agency number | | account\_number | string | Account number | | account\_type | string | Account type | **Example responses** ```json { "code": 200, "data": { "enquiry_cpf": "12345678901", "report_version": "V1", "connection_key": "1786a4508v3443ea86f5e16bc0cd3eeb", "connection_id": "LzW7vfYsanVsjdv1ELKlCPBoCZFGFsUy", "report_id": "d1fd2ba2-f9a7-4326-95f4-f922985901d1", "user_consent": "Yes", "allow_autoupdate": "Yes", "institution_id": "", "report_type": "FGTS", "FGTS_info": { "personalInfo": { "cpf_verified": "12345678901", "holder_name": "John Doe", "address": "", "city": "", "state": "", "country": "", "post_code": "", "latest_withdrawal_type": "", "has_birthday_withdrawal": 0, "latest_birthday_withdrawal_date": "", "e-mail": "john@mail.com", "withdrawalDetail": [ { "withdrawal_date": "2019-10-25", "withdrawal_description": "SAQUE JAM - COD 50", "withdrawal_amount": -6149 }, { "withdrawal_date": "2019-10-25", "withdrawal_description": "SAQUE DEP - COD 50", "withdrawal_amount": -43851 }, { "withdrawal_date": "2020-07-06", "withdrawal_description": "SAQUE DEP - COD 19E", "withdrawal_amount": -100675 }, { "withdrawal_date": "2020-07-06", "withdrawal_description": "SAQUE JAM - COD 19E", "withdrawal_amount": -3825 } ] }, "bankAccount": { "bank_name": "NU PAGAMENTOS S.A.", "agency_number": "0001", "account_number": "123456789", "account_type": "Conta Pagamento" }, "accountInfo": [ { "pis_pasep": "123.45678.36-3", "company_name": "TECNOLOGIA PARA FINANCAS PE", "company_cnpj": "12345678000101", "work_permit": "1234567-8808", "account_type": "OPTANTE", "category": "01", "fgts_account": "1234567890123/1173-BH", "admission_date": "05/10/2022", "movement_code": "", "operation_date": "05/10/2022", "interest_rate": 0.03, "amount_for_termination": 57317, "balance": 57317, "transactionDetail": [ { "trans_date": "2023-02-10", "trans_description": "CREDITO DE JAM 0,004552", "trans_amount": 2.59, "trans_balance": 573.16 }, { "trans_date": "2023-01-10", "trans_description": "CREDITO DE JAM 0,004543", "trans_amount": 2.58, "trans_balance": 570.58 }, { "trans_date": "2022-12-10", "trans_description": "CREDITO DE JAM 0,003976", "trans_amount": 1, "trans_balance": 253 }, { "trans_date": "2022-12-07", "trans_description": "115-DEPOSITO NOVEMBRO 2022", "trans_amount": 315, "trans_balance": 568 }, { "trans_date": "2022-11-07", "trans_description": "115-DEPOSITO OUTUBRO 2022", "trans_amount": 252, "trans_balance": 252 } ] } ], "exceptionalWithdrawal": { "available_for_exc_withdrawal": 1000, "excpected_payment_date": "" }, "exceptionalWithdrawalBank": { "bank_name": "", "agency_number": "", "account_number": "", "account_type": "" } } }, "msg": "ok", "report_time": "2023-02-05 12:12:34", "query_param": {} } ``` ## Investment *** Investment account data, including account info and product portfolio details. | **Name** | **Type** | **Description** | | ------------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------ | | enquiry\_cpf | string | CPF provided by user or by partner (via request parameter) | | user\_consent | string | User consent for data access and usage (“Yes” or “No”) | | allow\_autoupdate | string | Configuration of auto update for the account (“Yes” or “No”) | | connection\_key | string | Unique key for a specific bank connection of the certain user | | connection\_id | string | Unique ID for a specific connection | | institution\_id | string | Institution ID in Central Bank | | report\_type | string | Indicator of report type | | report\_id | string | Unique ID for each report | | report\_version | string | Version code of the report | | **personalInfo** | **Object** | Personal information | | cpf\_verified | string | CPF on record with the Institution | | name | string | Name on record with the Institution | | birthday | string | Birthday on record with the Institution | | cellphone | string | Cellphone on record with the Institution | | home\_phone | string | Home phone on record with the Institution | | email | string | Email address on record with the Institution | | id\_type | string | ID type on record with the Institution | | id\_number | string | ID number on record with the Institution | | gender | string | Gender on record with the Institution | | fathers\_name | string | Father name on record with the Institution | | marital\_status | string | Marital status on record with the Institution | | spouse\_name | string | Spouse name on record with the Institution | | profession | string | Profession on record with the Institution | | title | string | Title on record with the Institution | | company | string | Company on record with the Institution | | **correspondenceAddress** | **Object** | Correspondence address on record with the Institution | | post\_code | string | Postcode of the correspondence address | | address | string | Street of the correspondence address | | address\_number | string | Street number of the correspondence address | | neighborhood | string | Neighborhood of the correspondence address | | complement | string | Complement of the correspondence address | | city | string | City of the correspondence address | | state | string | State of the correspondence address | | country | string | Country of the correspondence address | | suitability | string | Investment style or result of suitability assessment | | **accountInfo** | **object** | Account information | | institution | string | Name of the Institution | | bacen\_name | string | Institution name in Central Bank | | bacen\_id | string | Institution ID in Central Bank | | agency | string | Agency | | account\_number | string | Account number | | total\_balance | number | Total balance (account balance + investment balance + savings balance) | | account\_balance | number | Account balance | | investment\_balance | number | Balance of all investments | | savings\_balance | number | Balance of savings account (if applicable) | | **investmentDetail** | **object** | Details of investment product | | **investmentType** | **object** | Investment type related information | | investment\_type | string | Specific investment type | | investment\_type\_balance | number | Balance of a specific investment type | | **productInfo** | **object** | Investment product details subject to different product type (Fixed income / Variable income / Direct Treasury and Government Bonds) | ### productInfo for Fixed Income style investment product | **Name** | **Type** | **Description** | | --------------- | ---------- | ------------------------------------------------ | | **productInfo** | **object** | Details of Fixed Income style investment product | | product\_type | string | Specific product type | | product\_id | string | Name of the investment product | | bank\_issuer | string | Bank issuer | | fund\_type | string | Fund type | | index | string | Index | | index\_rate | string | Index rate | | spread | string | Spread (prefixed interest only) | | issue\_date | date | Issue date | | due\_date | date | Due date | | liquidity\_date | date | Liquidity date | | custody | string | Custody | | ISIN | string | ISIN | | balance | number | Balance of the product | ### productInfo for Variable Income style investment product | **Name** | **Type** | **Description** | | --------------- | ---------- | --------------------------------------------------- | | **productInfo** | **object** | Details of Variable Income style investment product | | product\_type | string | Specific product type | | product\_id | string | Name of the investment product | | balance | number | Balance of the product | | quantity | number | Current quantity of the product | | profitability | number | Current profitability of the product | | average\_price | number | Average purchase price of the product | | position | number | Position holding (1="Yes", 0="No") | ### productInfo for Direct Treasury and Government Bonds style investment product | **Name** | **Type** | **Description** | | --------------- | ---------- | ------------------------------------------------------------------------ | | **productInfo** | **object** | Details of Direct Treasury and Government Bonds style investment product | | product\_type | string | Specific product type | | product\_id | string | Name of the investment product | | balance | number | Balance of the product | | due\_date | date | Due date | ### productInfo for IPO booking style investment product | **Name** | **Type** | **Description** | | ---------------------- | ---------- | --------------------------------------------------------------------- | | **productInfo** | **object** | Details of the investment product | | product\_type | string | Specific investment product type (IPO Booking) | | product\_code | string | Code of the product | | ipo\_company | string | Company name of this IPO | | ipo\_available\_period | date | Available period date of this IPO | | ipo\_type | string | Type of this IPO | | ipo\_offer | string | Offer institution of this IPO | | ipo\_broker | string | Institution of the broker where users book this IPO | | quantity | number | Quantity of this IPO booking | | price | number | Price of this IPO booking | | applied\_amount | number | Amount of this IPO booking | | product\_isin | string | ISIN (International Securities Identification Number) of this product | | book\_method | string | Book methods of this IPO | | booked\_quantity | number | Successfully booked quantity of this IPO | | booked\_amount | number | Successfully booked amount of this IPO | **Example responses** ```json { "code":200, "msg":"ok", "report_time":"2020-07-15 18:36:55", "data":{ "enquiry_cpf":"12345678901", "user_consent":"Yes", "allow_autoupdate":"Yes", "connection_key":"gPuKXrCJU0kUDQO65J4k", "connection_id":"f45c899f-11eb-231f-97c4-4b2c16484587", "institution_id":"102", "report_type":"investment", "report_id":"4b2c1648-231f-11eb-97c4-f45c899f4594", "report_version":"V1", "investmentInfo":{ "personalInfo":{ "cpf_verified":"12345678901", "name":"Usuario anonimo", "birthday":"1990-01-01 00:00:00", "cellphone":"(11) 987654321", "home_phone":"(11) 987654321", "email":"tester@test.com", "id_type":"CH", "id_number":"01010101010", "gender":"Masculino", "fathers_name":"Joao Silva", "marital_status":"SOLTEIRO(A)", "spouse_name":"n/a", "profession":"IT", "title":"CTO", "company":"Company", "correspondenceAddress":{ "postcode":"00000000", "address":"Rua Brasil", "address_number":"66", "neighborhood":"Neighborhood", "complement":"n/a", "city":"SAO PAULO", "state":"SP", "country":"BR" }, "suitability":"Agressivo" }, "accountInfo":{ "institution":"XP", "bacen_name":"XP INVESTIMENTOS CORRETORA DE CÂMBIO,TÍTULOS E VALORES MOBILIÁRIOS S/A", "bacen_id":"102", "agency":"0001", "account_number":"1234567", "total_balance":20275.35, "account_balance":3000.47, "investment_balance":17274.88, "savings_balance":0 }, "investmentDetail":[ { "investment_type":"Renda Fixa Privada", "investment_type_balance":13909.4, "productInfo":[ { "product_type":"Inflação", "product_id":"CDB Fibra - JUL/2021", "bank_issuer":"BANCO FIBRA SA", "fund_type":"CERTIFICADO DE DEPÓSITO BANCÁRIO", "index":"IPC-A", "index_rate":"+ 6.65%", "spread":"", "issue_date":"2017-07-14 00:00:00", "due_date":"2021-07-14 00:00:00", "liquidity_date":"2021-07-14 00:00:00", "custody":"CETIP", "ISIN":"-", "balance":13909.4 } ] }, { "investment_type":"Renda Variável", "investment_type_balance":2757.29, "productInfo":[ { "product_type":"Ações", "product_id":"ITUB4", "balance":2757.29, "quantity":100, "profitability":0.1305, "average_price":24.39, "postition":1 } ] }, { "investment_type":"Fundos de Investimentos", "investment_type_balance":512.79, "productInfo":[ { "product_type":"Renda variável", "product_id":"Trend Ibovespa Balanceado FIM", "balance":512.79, "quantity":467.95, "profitability":0.0124, "average_price":1.07, "position":1 } ] }, { "investment_type":"Tesouro direto e Títulos Públicos", "investment_type_balance":95.4, "productInfo":[ { "product_type":"Tesouro Direto", "product_id":"Tesouro IPCA+ 2035", "due_date":"2035-05-15 00:00:00", "balance":95.4 } ] } ] } } } ``` ```json { "code":200, "msg":"ok", "report_time":"2020-07-15 18:36:55", "data":{ "allow_autoupdate":"Yes", "connection_id": "f45c899f-11eb-231f-97c4-4b2c16484587", "connection_key":"gPuKXrCJU0kUDQO65J4k", "enquiry_cpf":"12345678909", "institution_id": "102", "report_id": "4b2c1648-231f-11eb-97c4-f45c899f4587", "report_type":"investment_advance", "report_version": "V1", "user_consent": "Yes", "investmentInfo":{ "personalInfo":{ "cpf_verified":"12345678909", "name":"Usuario anonimo", "birthday":"1990-01-01 00:00:00", "cellphone":"(11) 987654321", "home_phone":"(11) 987654321", "email":"tester@test.com", "id_type":"CH", "id_number":"01010101010", "gender":"Masculino", "fathers_name":"Joao Silva", "marital_status":"SOLTEIRO(A)", "spouse_name":"n/a", "profession":"IT", "title":"CTO", "company":"Company", "correspondenceAddress":{ "postcode":"00000000", "address":"Rua Brasil", "address_number":"66", "neighborhood":"Neighborhood", "complement":"n/a", "city":"SAO PAULO", "state":"SP", "country":"BR" }, "suitability":"Agressivo" }, "accountInfo":{ "institution":"XP", "bacen_name": "XP INVESTIMENTOS CORRETORA DE CÂMBIO,TÍTULOS E VALORES MOBILIÁRIOS S/A", "bacen_id": "102", "agency":"0001", "account_number":"1234567", "total_balance":47168.3, "account_balance":3000.47, "investment_balance":44167.83, "savings_balance": 0 }, "investmentDetail":[ { "investment_type":"Renda Fixa Privada", "investment_type_balance":37897.75, "productInfo":null }, { "investment_type":"Renda Variável", "investment_type_balance":2757.29, "productInfo":[ { "product_type":"Ações", "product_id":"ITUB4", "balance":2757.29, "quantity":100, "profitability":0.1305, "average_price":24.39, "position": 0, "productTransaction":[ { "negotiate_date":"2020-04-09 00:00:00", "trade_type":"Buy", "market_type": "VISTA", "due_date":"2021-04-09", "applied_amount":4878, "price":24.39, "quantity":200, "cnpj":"n/a" }, { "negotiate_date":"2020-04-09 00:00:00", "trade_type":"Sell", "market_type": "VISTA", "due_date":"2021-04-09", "applied_amount":2441, "price":24.41, "quantity":100, "cnpj":"n/a" } ], "productSubscription": null } ] }, { "investment_type":"Fundos de Investimentos", "investment_type_balance":512.79, "productInfo":[ { "product_type":"Renda variável", "product_id":"Trend Ibovespa Balanceado FIM", "balance":512.79, "quantity":467.95, "profitability":0.0124, "average_price":1.07, "position": 1, "productTransaction":[ { "negotiate_date":"2020-06-17 00:00:00", "trade_type":"Buy", "market_type": "n/a", "due_date":"2021-06-17", "applied_amount":500, "price":1.07, "quantity":467.95, "cnpj":"12345678901234" } ], "productSubscription": [ { "trade_type": 2, "status": "Direitos de Subscrição - Não Exercido", "subscription_right": "XPIE", "subscription_underlying": "XPIE12 - XP INFRA II FDO DE INV PART IE", "subscription_period_begin": "", "subscription_period_end": "", "request_date": "2020-08-31", "settlement_date": "2020-08-31", "request_amount": 0, "request_quantity": 0, "price": 0, "quantity": 0, "applied_amount": 0 }, { "trade_type": 1, "status": "Direito de Subscrição", "subscription_right": "XPIE", "subscription_underlying": "XPIE12 - XP INFRA II FDO DE INV PART IE", "subscription_period_begin": "", "subscription_period_end": "", "request_date": "2020-08-19", "settlement_date": "2020-08-19", "request_amount": 0, "request_quantity": 82, "price": 0, "quantity": 0, "applied_amount": 0 } ] } ] } ] } } } ``` ```json { "code":200, "msg":"ok", "report_time":"2020-07-15 18:36:55", "data":{ "allow_autoupdate":"Yes", "connection_id": "f45c899f-11eb-231f-97c4-4b2c16484587", "connection_key":"gPuKXrCJU0kUDQO65J4k", "enquiry_cpf":"12345678909", "institution_id": "102", "report_id": "4b2c1648-231f-11eb-97c4-f45c899f4587", "report_type":"investment_transaction", "report_version": "V1", "user_consent": "Yes", "investmentInfo":{ "personalInfo":{ "cpf_verified":"12345678909", "name":"Usuario anonimo", "birthday":"1990-01-01 00:00:00", "cellphone":"(11) 987654321", "home_phone":"(11) 987654321", "email":"tester@test.com", "id_type":"CH", "id_number":"01010101010", "gender":"Masculino", "fathers_name":"Joao Silva", "marital_status":"SOLTEIRO(A)", "spouse_name":"n/a", "profession":"IT", "title":"CTO", "company":"Company", "correspondenceAddress":{ "postcode":"00000000", "address":"Rua Brasil", "address_number":"66", "neighborhood":"Neighborhood", "complement":"n/a", "city":"SAO PAULO", "state":"SP", "country":"BR" }, "suitability":"Agressivo" }, "accountInfo":{ "institution":"XP", "bacen_name": "XP INVESTIMENTOS CORRETORA DE CÂMBIO,TÍTULOS E VALORES MOBILIÁRIOS S/A", "bacen_id": "102", "agency":"0001", "account_number":"1234567", "total_balance":47168.3, "account_balance":3000.47, "investment_balance":44167.83, "savings_balance": 0 }, "investmentDetail":[ { "investment_type":"Renda Fixa Privada", "investment_type_balance":37897.75, "productInfo":null }, { "investment_type":"Renda Variável", "investment_type_balance":2757.29, "productInfo":[ { "product_type":"Ações", "product_id":"ITUB4", "balance":2757.29, "quantity":100, "profitability":0.1305, "average_price":24.39, "position": 0, "productTransaction":[ { "negotiate_date":"2020-04-09 00:00:00", "trade_type":"Buy", "market_type": "VISTA", "due_date":"2021-04-09", "applied_amount":4878, "price":24.39, "quantity":200, "cnpj":"n/a" }, { "negotiate_date":"2020-04-09 00:00:00", "trade_type":"Sell", "market_type": "VISTA", "due_date":"2021-04-09", "applied_amount":2441, "price":24.41, "quantity":100, "cnpj":"n/a" } ], "productSubscription": null } ] }, { "investment_type":"Fundos de Investimentos", "investment_type_balance":512.79, "productInfo":[ { "product_type":"Renda variável", "product_id":"Trend Ibovespa Balanceado FIM", "balance":512.79, "quantity":467.95, "profitability":0.0124, "average_price":1.07, "position": 1, "productTransaction":[ { "negotiate_date":"2020-06-17 00:00:00", "trade_type":"Buy", "market_type": "n/a", "due_date":"2021-06-17", "applied_amount":500, "price":1.07, "quantity":467.95, "cnpj":"12345678901234" } ] } ] } ] } } } ``` ```json { "code":200, "msg":"ok", "report_time":"2020-07-15 18:36:55", "data":{ "allow_autoupdate":"Yes", "connection_id": "f45c899f-11eb-231f-97c4-4b2c16484587", "connection_key":"gPuKXrCJU0kUDQO65J4k", "enquiry_cpf":"12345678909", "institution_id": "102", "report_id": "4b2c1648-231f-11eb-97c4-f45c899f4587", "report_type":"investment_pdf", "report_version": "V1.1", "user_consent": "Yes", "investmentInfo":{ "personalInfo":{ "cpf_verified":"12345678909", "name":"Usuario anonimo", "birthday":"1990-01-01 00:00:00", "cellphone":"(54)99999-1234", "home_phone":"n/a", "email":"tester@test.com", "id_type":"Registro Geral", "id_number":"2012345678", "gender":"Masculino", "fathers_name":"Mike DOE", "marital_status":"Solteiro(a)", "spouse_name":"n/a", "profession":"Empresario", "title":"n/a", "company":"Company", "suitability":"AGRESSIVO", "correspondenceAddress":{ "postcode":"00000-000", "address":"Rua Brasil", "address_number":"1234", "neighborhood":"Neighborhood", "complement":"123", "city":"Passo Fundo", "state":"RS", "country":"n/a" } }, "accountInfo":{ "institution":"XP", "bacen_name":"XP INVESTIMENTOS CORRETORA DE CÂMBIO,TÍTULOS E VALORES MOBILIÁRIOS S/A", "bacen_id":"0001", "agency":"102", "account_number":"1234567", "total_balance": 47168.3, "account_balance": 3000.47, "investment_balance": 44167.83, "savings_balance": 0 }, "pdfList":[ { "investment_type":"Renda Fixa Privada", "url_list":[ "https://yourdata.s3.sa-east-1.amazonaws.com/pdf/Z42AIF7ivuyxfIcfzbl3sS5hp3qqhCbZ/Z42AIF7ivuyxfIcfzbl3sS5hp3qqhCbZ_1640255297663/NotaNegociacao_448791_20210914.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIYUEIO4QVRBYUQRQ%2F20211223%2Fsa-east-1%2Fs3%2Faws4_request&X-Amz-Date=20211223T103116Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=2a76898df60b93404d5d30b9d9aaa05b56ec5442888ec39993200af183b78da0", "https://yourdata.s3.sa-east-1.amazonaws.com/pdf/Z42AIF7ivuyxfIcfzbl3sS5hp3qqhCbZ/Z42AIF7ivuyxfIcfzbl3sS5hp3qqhCbZ_1640255297663/NotaNegociacao_448791_20211028.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIYUEIO4QVRBYUQRQ%2F20211223%2Fsa-east-1%2Fs3%2Faws4_request&X-Amz-Date=20211223T103116Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=f0d51eb119ccf04d963ed5a0ac2406ca40289633ae886f2622ae31536d80536e" ] }, { "investment_type":"Fundos de Investimentos", "url_list":[ "https://yourdata.s3.sa-east-1.amazonaws.com/pdf/Z42AIF7ivuyxfIcfzbl3sS5hp3qqhCbZ/Z42AIF7ivuyxfIcfzbl3sS5hp3qqhCbZ_1640255297663/NotaNegociacao_448791_20190926.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIYUEIO4QVRBYUQRQ%2F20211223%2Fsa-east-1%2Fs3%2Faws4_request&X-Amz-Date=20211223T103116Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=8e935d35518d7ba9de2ff1024ca6b984c02b627b4e161441dc18f94b52ced6b3", "https://yourdata.s3.sa-east-1.amazonaws.com/pdf/Z42AIF7ivuyxfIcfzbl3sS5hp3qqhCbZ/Z42AIF7ivuyxfIcfzbl3sS5hp3qqhCbZ_1640255297663/NotaNegociacao_448791_20210422.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIYUEIO4QVRBYUQRQ%2F20211223%2Fsa-east-1%2Fs3%2Faws4_request&X-Amz-Date=20211223T103116Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=7084f4984e1863039e444ae0e8a760f7a8128c263c585886a7142af0f7522f99" ] }, { "investment_type":"Renda Variável", "url_list":[ "https://yourdata.s3.sa-east-1.amazonaws.com/pdf/Z42AIF7ivuyxfIcfzbl3sS5hp3qqhCbZ/Z42AIF7ivuyxfIcfzbl3sS5hp3qqhCbZ_1640255297663/NotaNegociacao_448791_20191004.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIYUEIO4QVRBYUQRQ%2F20211223%2Fsa-east-1%2Fs3%2Faws4_request&X-Amz-Date=20211223T103116Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=284fed5adf45a5d5c0417399496b747e68dc4de71bfb121d2b82c89d60b64a88", "https://yourdata.s3.sa-east-1.amazonaws.com/pdf/Z42AIF7ivuyxfIcfzbl3sS5hp3qqhCbZ/Z42AIF7ivuyxfIcfzbl3sS5hp3qqhCbZ_1640255297663/NotaNegociacao_448791_20210629.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIYUEIO4QVRBYUQRQ%2F20211223%2Fsa-east-1%2Fs3%2Faws4_request&X-Amz-Date=20211223T103116Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=d6f0549900bac1e92ea9e07962c3621add03ac0d24010a1a166435c6e8857495" ] } ] } } } ``` ## Corporate\_checking *** Corporate account data, including account balance, monthly summary and transactions. | **Name** | **Type** | **Description** | | ---------------------------------- | ---------- | -------------------------------------------------------------------- | | operator\_number | string | Operator number of the account | | user\_consent | string | User consent for data access and usage (“Yes” or “No”) | | allow\_autoupdate | string | Configuration of auto update for the account (“Yes” or “No”) | | connection\_key | string | Unique key for a specific bank connection of the certain user | | connection\_id | string | Unique ID for a specific connection | | institution\_id | string | Institution ID in Central Bank | | report\_type | string | Indicator of report type | | report\_id | string | Unique ID for each report | | report\_version | string | Version code of the report | | **accountInfo** | **Object** | Account information | | cnpj\_verified | string | CNPJ on record with the Institution | | institution | string | Name of the Institution | | bacen\_name | string | Institution name in Central Bank | | bacen\_id | string | Institution ID in Central Bank | | branch | string | Branch | | account\_number | string | Account number | | operation\_code | string | Operation type of the account | | company\_name | string | Company name | | balance | number | Current balance | | overdraft\_limit | number | Overdraft limit | | overdraft\_interest\_rate\_monthly | string | Monthly overdraft interest rate (CET, display "-1" if not available) | | overdraft\_interest\_rate\_yearly | string | Yearly overdraft interest rate (CET, display "-1" if not available) | | **openStatement** | **object** | Open statement | | statement\_month | string | Statement month | | Inflow\_total | number | Total inflow in the statement month | | Inflow\_deposit\_receivables | number | Deposit and receivables inflow in the statement month | | Inflow\_transfer\_doc\_ted | number | Transfer, DOC and TED inflow in the statement month | | Inflow\_others | number | Other inflow in the statement month | | Outflow\_total | number | Total outflow in the statement month | | Outflow\_debit\_card | number | Debit card payments in the statement month | | Outflow\_transfer\_doc\_ted | number | Transfer, DOC and TED outflow in the statement month | | Outflow\_atm\_cash\_out | number | ATM cash out in the statement month | | Outflow\_others | number | Other outflow in the statement month | | **transactionDetail** | **object** | Transaction details in open statement | | trans\_date | string | Transaction date | | trans\_amount | number | Transaction amount | | trans\_description | string | Transaction description | | **closedStatement** | **object** | Closed statement | | statement\_month | string | Statement month | | Inflow\_total | number | Total inflow in the statement month | | Inflow\_deposit\_receivables | number | Deposit and receivables inflow in the statement month | | Inflow\_transfer\_doc\_ted | number | Transfer, DOC and TED inflow in the statement month | | Inflow\_others | number | Other inflow in the statement month | | Outflow\_total | number | Total outflow in the statement month | | Outflow\_debit\_card | number | Debit card payments in the statement month | | Outflow\_transfer\_doc\_ted | number | Transfer, DOC and TED outflow in the statement month | | Outflow\_atm\_cash\_out | number | ATM cash out in the statement month | | Outflow\_others | number | Other outflow in the statement month | | **transactionDetail** | **object** | Transaction details in open statement | | trans\_date | string | Transaction date | | trans\_amount | number | Transaction amount | | trans\_description | string | Transaction description | **Example responses** ```json { "code":200, "msg":"ok", "report_time":"2020-07-07 09:57:34", "data":{ "operator_number":"123456789", "user_consent":"Yes", "allow_autoupdate":"Yes", "connection_key":"gPuKXrCJU0kUDQO65J4k", "connection_id":"f45c899f-11eb-231f-97c4-4b2c16484587", "institution_id":"341", "report_type":"corporate_checking", "report_id":"4b2c1648-231f-11eb-97c4-f45c899f4595", "report_version":"V1", "Corporate_checking":{ "AccountInfo":[ { "cnpj_verified":"12.345.678/0001-23", "institution":"Itaú Empresas", "bacen_name":"ITAÚ UNIBANCO S.A.", "bacen_id":"341", "branch":"1234", "account_number":"12345-6", "operation_code":"001", "company_name":"Empresa anonimo", "balance":66666, "overdraft_limit":9250, "overdraft_interest_rate_monthly":"8.19%", "overdraft_interest_rate_yearly":"160.58%" } ], "openStatement":{ "statement_month":"2020-07", "inflow_total":780, "inflow_deposit_receivables":0, "inflow_transfer_doc_ted":780, "inflow_others":0, "outflow_total":-890, "Outflow_debit_card":0, "outflow_atm_cash_out":0, "outflow_transfer_doc_ted":0, "outflow_others":-890, "transactionDetail":[ { "trans_date":"2020-07-05", "trans_amount":-890, "trans_description":"TAR CONTA CERTA 06/20" }, { "trans_date":"2020-07-04", "trans_amount":780, "trans_description":"TED 077.0001Empresa anonimo" } ] }, "closedStatement":[ { "statement_month":"2020-06", "inflow_total":1875, "inflow_deposit_receivables":0, "inflow_transfer_doc_ted":1875, "inflow_others":0, "outflow_total":-1640, "Outflow_debit_card":0, "outflow_atm_cash_out":0, "outflow_transfer_doc_ted":0, "outflow_others":-1640, "transactionDetail":[ { "trans_date":"2020-06-20", "trans_amount":1875, "trans_description":"TED 077.0001Empresa anonimo" }, { "trans_date":"2020-06-20", "trans_amount":-1640, "trans_description":"INT DARF123456789012" } ] }, { "statement_month":"2020-05", "inflow_total":1600, "inflow_deposit_receivables":0, "inflow_transfer_doc_ted":1600, "inflow_others":0, "outflow_total":-1450, "Outflow_debit_card":0, "outflow_atm_cash_out":0, "outflow_transfer_doc_ted":0, "outflow_others":-1450, "transactionDetail":[ { "trans_date":"2020-05-27", "trans_amount":1600, "trans_description":"TED 077.0001Empresa anonimo" }, { "trans_date":"2020-05-12", "trans_amount":-1400, "trans_description":"INT DARF123456789021" }, { "trans_date":"2020-05-03", "trans_amount":-50, "trans_description":"TAR CONTA CERTA 04/15" } ] } ] } } } ``` ## Gig\_economy *** Transaction data in the account for up to 6 months, including data points of account info, transaction date, description, amount, and balance. | **Name** | **Type** | **Description** | | ------------------------- | ---------- | ---------------------------------------------------------------------- | | enquiry\_cpf | string | CPF provided by user or by partner for enquiry (via request parameter) | | user\_consent | string | User consent for data access and usage (“Yes” or “No”) | | allow\_autoupdate | string | Configuration of auto update for the account (“Yes” or “No”) | | connection\_key | string | Unique key for a specific bank connection of the certain user | | connection\_id | string | Unique ID for a specific connection | | institution\_id | string | Institution ID in Central Bank | | report\_type | string | Indicator of report type | | report\_id | string | Unique ID for each report | | report\_version | string | Version code of the report | | **personalInfo** | **object** | Personal Information | | cpf\_verified | string | CPF on record with the Institution | | holder\_name | string | Holder's name | | telephone | string | Telephone number | | email | string | Email address | | address | string | Address | | city | string | City | | state | string | State | | country | string | Country | | post\_code | string | Post\_code | | **vehicleInfo** | **object** | Vehicle information | | vehicle\_year | string | Year of the vehicle | | vehicle\_brand | string | Vehicle brand | | vehicle\_model | string | Vehicle model | | vehicle\_plate | string | Vehicle plate | | **accountInfo** | **object** | Account information | | institution | string | Institution | | is\_active | string | If the account is active ("Yes" or "No") | | current\_rating | number | Drivers current rating | | balance | number | Account balance | | **bankInfo** | **object** | Information of binding bank | | binding\_bank | string | Binding bank | | binding\_bank\_account | string | Account of binding bank | | **openStatement** | **object** | Open statement | | statement\_month | string | Statement month | | total\_account\_income | number | Total income of the account | | total\_income\_adjustment | number | Total income adjustment (include fee adjustment and extra earning) | | total\_trip\_fees | number | Total trip fees (include cash trip and non-cash trip) | | **transactionDetail** | **object** | Transaction details in open statement | | trans\_date | string | Transaction date | | trans\_description | string | Transaction description | | trans\_category | string | Transaction category | | trans\_amount | number | Transaction amount | | trip\_fees | number | Total fees of the trip | | trip\_cash\_received | number | Cash received for the trip | | **closedStatement** | **object** | Closed statement | | statement\_month | string | Statement month | | total\_account\_income | number | Total income of the account | | total\_income\_adjustment | number | Total income adjustment (include fee adjustment and extra earning) | | total\_trip\_fees | number | Total trip fees (include cash trip and non-cash trip) | | **transactionDetail** | **object** | Transaction details in closed statement | | trans\_date | string | Transaction date | | trans\_description | string | Transaction description | | trans\_category | string | Transaction category | | trans\_amount | number | Transaction amount | | trip\_fees | number | Total fees of the trip | | trip\_cash\_received | number | Cash received for the trip | **Example responses** ```json { "code":200, "msg":"ok", "report_time":"2021-03-07 09:57:34", "data":{ "enquiry_cpf":"12345678901", "user_consent":"Yes", "allow_autoupdate":"Yes", "connection_key":"gPuKXrCJU0kUDQO65J4k", "connection_id":"f45c899f-11eb-231f-97c4-4b2c16484587", "institution_id":"", "report_type":"gig_economy", "report_id":"4b2c1648-231f-11eb-97c4-f45c899f4595", "report_version":"V1", "gig_economy":{ "personalInfo":{ "cpf_verified":"12345678901", "holder_name":"Usuario anonimo", "telephone":"+5511987654321", "email":"tester@test.com", "address":"Rua Brasil 66", "city":"SAO PAULO", "state":"SP", "country":"Brazil", "post_code":"00000-000", "vehicleInfo":{ "vehicle_year":"2019", "vehicle_brand":"Renault", "vehicle_model":"Kwid", "vehicle_plate":"ABC1234" } }, "accountInfo":{ "institution":"uber", "is_active":"ACTIVE", "current_rating":0, "balance":14.14, "bankInfo":{ "binding_bank":"ITAU", "binding_bank_account":"XXXXXXX12" } }, "openStatement":{ "statement_month":"202003", "total_account_income":16.14, "total_income_adjustment":2, "total_trip_fees":22.9, "transactionDetail":[ { "trans_date":"2021-03-06", "trans_description":"Ganhos extras", "trans_category":"Income adjustment", "trans_amount":2, "trip_fees":0, "trip_cash_received":0 }, { "trans_date":"2021-03-05", "trans_description":"VIP", "trans_category":"Non-cash trip", "trans_amount":15.02, "trip_fees":15.02, "trip_cash_received":0 }, { "trans_date":"2021-03-02", "trans_description":"UberX", "trans_category":"Cash trip", "trans_amount":-0.88, "trip_fees":7.88, "trip_cash_received":8.76 } ] }, "closedStatement":[ { "statement_month":"202002", "total_account_income":15.14, "total_income_adjustment":0, "total_trip_fees":23.9, "transactionDetail":[ { "trans_date":"2021-02-07", "trans_description":"Transferência semanal", "trans_category":"Transfer_out", "trans_amount":-15.14, "trip_fees":0, "trip_cash_received":0 }, { "trans_date":"2021-02-06", "trans_description":"UberX", "trans_category":"Non-cash trip", "trans_amount":16.02, "trip_fees":16.02, "trip_cash_received":0 }, { "trans_date":"2021-02-02", "trans_description":"UberX", "trans_category":"Cash trip", "trans_amount":-0.88, "trip_fees":7.88, "trip_cash_received":8.76 } ] } ] } } } ``` ## Identity *** Identity information on record with the bank. Reduce fraud by comparing user-submitted data to validate identity. | **Name** | **Type** | **Description** | | --------------------------- | ---------- | ---------------------------------------------------------------------- | | enquiry\_cpf | string | CPF provided by user or by partner for enquiry (via request parameter) | | user\_consent | string | User consent for data access and usage (“Yes” or “No”) | | allow\_autoupdate | string | Configuration of auto update for the account (“Yes” or “No”) | | connection\_key | string | Unique key for a specific bank connection of the certain user | | connection\_id | string | Unique ID for a specific connection | | institution\_id | string | Institution ID in Central Bank | | report\_type | string | Indicator of report type | | report\_id | string | Unique ID for each report | | report\_version | string | Version code of the report | | **identity** | **object** | Identity information of for verification | | bank\_name | string | Bank name | | bacen\_name | string | Institution name in Central Bank | | bacen\_id | string | Institution ID in Central Bank | | agency\_number | string | Agency number | | account\_number | string | Account number of checking account | | cpf\_verified | string | CPF on record with the Institution | | name | string | Name on record with the Institution | | cellphone | string | Cellphone on record with the Institution | | email | string | Email address on record with the Institution | | **correspondence\_address** | **object** | Correspondence address on record with the Institution | | post\_code | string | Postcode of the correspondence address | | address | string | Street of the correspondence address | | address\_number | string | Street number of the correspondence address | | neighborhood | string | Neighborhood of the correspondence address | | complement | string | Complement of the correspondence address | | city | string | City of the correspondence address | | state | string | State of the correspondence address | | country | string | Country of the correspondence address | **Example responses** ```json { "code":200, "msg":"ok", "report_time":"2020-07-03 22:21:51", "data":{ "enquiry_cpf":"12345678901", "user_consent":"Yes", "allow_autoupdate":"No", "connection_key":"gPuKXrCJU0kUDQO65J4k", "connection_id":"f45c899f-11eb-231f-97c4-4b2c16484587", "institution_id":"237", "report_type":"identity", "report_id":"4b2c1648-231f-11eb-97c4-f45c899f4596", "report_version":"V1", "identity":{ "bank_name":"Bradesco", "bacen_name":"Banco Bradesco S.A.", "bacen_id":"237", "agency_number":"1234", "account_number":"1234-5", "cpf_verified":"12345678901", "name":"Usuario anonimo", "cellphone":"11987654321", "email":"tester@test.com", "correspondenceAddress":{ "postcode":"00000000", "address":"Rua Brasil", "address_number":"66", "neighborhood":"Neighborhood", "complement":"n/a", "city":"SAO PAULO", "state":"SAO PAULO", "country":"BRASIL" } } } } ``` ## Balance *** Real time balance check to prevent non-sufficient funds fees. | **Name** | **Type** | **Description** | | ------------------ | ---------- | ------------------------------------------------------------------------------------------ | | enquiry\_cpf | string | CPF provided by user or by partner for enquiry (via request parameter) | | user\_consent | string | User consent for data access and usage (“Yes” or “No”) | | connection\_key | string | Unique key for a specific bank connection of the certain user | | connection\_id | string | Unique ID for a specific connection | | institution\_id | string | Institution ID in Central Bank | | allow\_autoupdate | string | Configuration of auto update for the account (“Yes” or “No”) | | report\_type | string | Indicator of report type | | report\_id | string | Unique ID for each report | | report\_version | string | Version code of the report | | **accountBalance** | **object** | Real time balance of the specific account | | bank\_name | string | Bank name | | bacen\_name | string | Institution name in Central Bank | | bacen\_id | string | Institution ID in Central Bank | | agency\_number | string | Agency number | | account\_type | string | Indicator of account type ("checking", "creditcard" or "savings") | | account\_number | string | Account number of checking or savings account; Last 4 digit of credit card number | | cpf\_verified | string | CPF on record with the Institution | | account\_holder | string | Name of account holder | | current\_balance | number | Current balance of checking or savings account; Current bill amount of credit card account | | available\_limit | number | Available credit limit (for credit card account only, display "-1" if not available) | | total\_limit | number | Total credit limit (for credit card account only, display "-1" if not available) | **Example responses** ```json { "code":200, "msg":"ok", "report_time":"2020-07-03 22:21:51", "data":{ "enquiry_cpf":"12345678901", "user_consent":"Yes", "allow_autoupdate":"No", "connection_key":"gPuKXrCJU0kUDQO65J4k", "connection_id":"f45c899f-11eb-231f-97c4-4b2c16484587", "institution_id":"237", "report_type":"balance", "report_id":"4b2c1648-231f-11eb-97c4-f45c899f4597", "report_version":"V1", "accountBalance":[ { "bank_name":"Bradesco", "bacen_name":"Banco Bradesco S.A.", "bacen_id":"237", "agency_number":"1234", "account_type":"checking", "account_number":"1234-5", "cpf_verified":"12345678901", "account_holder":"Usuario anonimo", "current_balance":100, "available_limit":-1, "total_limit":-1 }, { "bank_name":"Bradesco", "bacen_name":"Banco Bradesco S.A.", "bacen_id":"237", "agency_number":"1234", "account_type":"creditcard", "account_number":"1234", "cpf_verified":"12345678901", "account_holder":"Usuario anonimo", "current_balance":3512.46, "available_limit":2987.55, "total_limit":6500 }, { "bank_name":"Bradesco", "bacen_name":"Banco Bradesco S.A.", "bacen_id":"237", "agency_number":"1234", "account_type":"savings", "account_number":"5432-1", "cpf_verified":"12345678901", "account_holder":"Usuario anonimo", "current_balance":7659.47, "available_limit":-1, "total_limit":-1 } ] } } ``` ## Auth\_account *** Checking account information retrieved for ownership authentication. No micro-deposits required. (e.g. e-wallet KYC) Coming soon! ## Auth\_creditcard *** Credit card account information retrieved for ownership authentication (e.g. e-payment anti-fraud) Coming soon!