An institution is an entity that Belvo can access information from. It can be a:

• bank institution, such as Nubank Brazil.
• fiscal institution, such as the Servicio de Administración Tributaria (SAT) in Mexico.
• employment institutions, such as Instituto Mexicano del Seguro Social (IMSS) in Mexico or Instituto Nacional do Seguro Social (INSS) in Brazil.

A Link is a set of credentials associated to an end-user's access to an institution. You will need to register a Link before accessing information from that specific end-user, such as account or transaction details.

We recommend using the Belvo Hosted Widget to manage the connection process.

A consent is a permission given by the end user to access their financial data in the Open Finance Network in Brazil.

An owner represents the person who has access to a Link and is the owner of all the accounts inside the Link.

You can use this endpoint in order to get useful information about your client, such as:

• their full name
• key contact information
• information about the ID document they used when opening the account

An account is the representation of a bank account inside a financial institution. A user can have one or more accounts in an institution.

For example, one user (or link) can have a checking account, several credit cards, and a loan account.

Querying for a user's account information is useful as you can get information regarding:

• what types of accounts the user has.
• the balance for each account (savings, checking, credit card, loan, and so on).
• detailed information regarding their credit card spending.
• the current situation of any loans they may have.

A balance is the amount of money available in a given bank account (checking or savings) at a given time.

A transaction contains the detailed information of each movement inside an account. For example, a purchase at a store or a restaurant.

A bill refers to the credit card bill a user receives for a given account.

Our employments resource for Brazil lets you get a comprehensive view of your user's current employment history and salary information.

For each user, we return the:

• work history (including occupations and employer data)
• historical and current salary information (per employer)

At the moment, the employments resource is available for:

• 🇧🇷 Brazil (INSS)

Our employment records resource for Mexico lets you get a comprehensive view of your user’s current social security contributions and employment history.

With Belvo's employment records resource for Mexico, you can access information about your user's current social security contributions and employment history. For the each user, we return the:

• personal data
• work history
• historical and current daily base salary
• and more!

At the moment, the employment records resource is available for:

• 🇲🇽 Mexico (IMSS)
• 🇲🇽 Mexico (ISSSTE)

The Current Employments resource provides real-time access to the current employment status of individuals in Mexico. This resource offers detailed information about whether an individual is currently employed or unemployed, along with their active employment records.

Use the Incomes endpoint to gather insights on an account's income sources for the past 365 days. The endpoint is particularly useful when you want to verify a person's income.

📘 Info

The incomes resource is only available for Checking and Savings accounts associated with banking links.

Belvo's Recurring Expenses API allows you to identify a user's regular payments for subscription services, such as Netflix or gym memberships, as well as utility payments, such as electricity or phone bills. We return information for up to 365 days.

📘 Info

The recurring expenses resource is only available for Checking, Savings and Credit Card accounts associated with banking links.

A payment institution is an entity that Belvo can access information from. You can see a complete list of institutions available for payments by making a List request to this endpoint.

A customer is the payer that's going to push funds into your bank account. You need to create a customer in order to receive inflow payments to your organization's bank account.

To receive inflow payments to your organization's bank account, you must register the bank accounts (individual and business) using Belvo's Payments API.

• Individual bank accounts must be created for each payer (your customer).
• Business bank accounts need to be created for the beneficiary of the payment (your organization).

A payment intent is a single point of access to create payments using any payment method offered by Belvo.

A payment intent captures all payment information (such as the amount to be charged, the description of the payment, the provider, and so on) and guides your customers through the payment flow.

Note: For institutions that require the username_type in the form_fields array, you must send through this value in your PATCH request.

A Payment Authorization is the consent that your user gives you to charge (debit money from) their accounts. You need to perform one Payment Authorization per ‘contract’ (for example, if your company does both electricity and water but they are billed separately, then you will create two separate Payment Authorizations).

Once the user confirms the authorization, you will need to listen for a a PAYMENT_AUTHORIZATION webhook with the status set to AUTHORIZED. Once you receive this webhook, the authorization process is complete, and you will be able to charge your user.

Use the Biometric Pix Widget Token requests to create a access token for Biometric Payments.

Each time you receive an inflow payment from your customer, a transaction is created in the Belvo database.

You can use the Payment Transactions resource in order to get useful information about a transaction as well as the specific charge associated with it.