Products
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
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.
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
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
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
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
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
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
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 |
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
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 |
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) |
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 |
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") |
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 |
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
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
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 |
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
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 |
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
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
Checking account information retrieved for ownership authentication. No micro-deposits required. (e.g. e-wallet KYC)
Coming soon!
Credit card account information retrieved for ownership authentication (e.g. e-payment anti-fraud)
Coming soon!