URL
Need help?
Reach new audiences and convert more users by easily and safely connecting to their financial data, understanding their behavior and enabling instant payments with open finance. Through our API, you can access:
Belvo is an open banking API for Latin America that allows companies to access banking and fiscal information in a secure as well as agile way.
Through our API, you can access:
You can also use our API to make payments in:
If you woud like the response documentation in Excel or CSV form, please download them from our public GitHub Reposiitory: Belvo Open Finance Data Dictionaries.
Our EXCEL and CSV files are additionally localized into Spanish and Portuguese (Brazil).
Available for:
Use our Sandbox environment to build your integration. We offer dummy data that mimics that of real-world use cases, which means you can test out all the endpoints, use the widget, and implement webhooks - just as you would with real-world data!
All you need to get started with the Sandbox environment is to get your API keys. We really recommend that you start creating your integration in this environment.
Available for:
After you have tested your integration in the Sandbox environment and are ready to go live, you'll need to request access to our Production environment. After you request access, our Sales Team will get in contact with you to schedule a meeting just to ensure your needs are met, and then you'll just need to go through a certification process with one of our engineers to make sure that your integration is running optimally. To prepare for the certification meeting, just follow our Integration checklist.
Once your integration is certified, all you'll need to do is:
sandbox.belvo.com to api.belvo.com.We use the following HTTP status code in the response depending on the success or failure:
| Status Code | Description |
|---|---|
200 | ✅ Success - The content is available in the response body. |
201 | ✅ Success - The content was created successfully on Belvo. |
204 | ✅ Success - No content to return. |
400 | ❌ Bad Request Error - Request returned an error, detail in the content. |
401 | ❌ Unauthorized - The Belvo credentials provided are not valid. |
404 | ❌ Not Found - The resource you try to access cannot be found. |
405 | ❌ Method Not Allowed - The HTTP method you are using is not accepted for this resource. |
408 | ❌ Request Timeout - The request timed out and was terminated by the server. |
428 | ❌ MFA Token Required - MFA token was required by the institution to connect. |
500 | ❌ Internal Server Error - The detail of the error is available in the response body. |
Belvo API errors are returned in JSON format. For example, an error might look like this:
[
{
"request_id": "a6e1c493d7a29d91aed4338e6fcf077d",
"message": "This field is required.",
"code": "required",
"field": "link"
}
]Typically, an error response will have the following parameters:
request_id: a unique ID for the request, you should share it with the Belvo support team for investigations.message: human-readable description of the error.code: a unique code for the error. Check the table below to see how to handle each error code.field (optional): The specific field in the request body that has an issue.When you need help with a specific error, include the request identifier (request_id) in your message to the Belvo support team. This will speed up investigations and get you back up and running in no time at all.
For a full list of errors and how to troubleshoot them, please see our dedicated Error Handling article.
Implement an automated exponential backoff of up to five retries. We recommend using a base interval of three seconds with a factor of two. For example, the first retry should be after three seconds, the second retry after six seconds (2 * 3), the third retry after 12 seconds (2 * 6), the fourth retry after 24 seconds (2 * 12), and the fifth retry after 48 seconds (2 * 24).
You should not retry making requests if you receive a 40x response, as this is a client error.
The only exception is the “Too Many Sessions” error, as it means that your end-user is accessing the account from another browser at the same time. In this case, please implement the same retry policy as with 50x errors.
In our schema, you may see that a field has been marked as deprecated. This means that this field is no longer maintained by the Belvo team. You may still receive data for this field depending on the institution, however, you should not rely on this field.
In our API specification, you'll see that some response parameters will have a required annotation. According to the OpenAPI specification, when a response parameter is marked as required, this means that the response key must be returned. However, the value of that response parameter can be null.
📘 Info
In short, any response parameter marked as required will be returned by our API, but the value can be set to null.
https://developers.belvo.com/_mock/apis/belvoopenapispec/
https://sandbox.belvo.com/
An institution is an entity that Belvo can access information from. It can be a:
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:
With the List Owners method, you can:
link.id (using the link query parameter).owners.id (using the id query parameter).This method returns a paginated response (default: 100 items per page). You can use the page_size query parameter to increase the number of items returned to a maximum of 1000 items. You can use the page query parameter to navigate through the results. For more details on how to navigate Belvo's paginated responses, see our Pagination Tips article.
Please see the query list below for a list of fields that you can filter your responses by. For more information on how to use filters, see our Filtering responses article.
This resource may return deprecated fields. In the response documentation you may see that a field has been marked as deprecated. This means that this field is no longer maintained by the Belvo team. You may still receive data for this field depending on the institution, however, you should not rely on this field.
The link.id you want to filter by.
ℹ️ We highly recommend adding the link.id filter in order to improve your performance.
Indicates how many results to return per page. By default we return 100 results per page.
ℹ️ The minimum number of results returned per page is 1 and the maximum is 1000. If you enter a value greater than 1000, our API will default to the maximum value (1000).
Omit certain fields from being returned in the response. For more information, see our Filtering responses DevPortal article.
Return only the specified fields in the response. For more information, see our Filtering responses DevPortal article.
Return results only for these link.ids.
Return information only for this resource id.
Return information for these resource ids.
Return items that were last updated in Belvo's database on this date (in YYYY-MM-DD format).
Return items that were last updated in Belvo's database after this date (in YYYY-MM-DD format).
Return items that were last updated in Belvo's database after or on this date (in YYYY-MM-DD format).
Return items that were last updated in Belvo's database before this date (in YYYY-MM-DD format).
Return items that were last updated in Belvo's database before or on this date (in YYYY-MM-DD format).
Return accounts that were last updated in Belvo's database between two dates (in YYYY-MM-DD format).
Returns owners whose email address match your query.
https://developers.belvo.com/_mock/apis/belvoopenapispec/api/owners/
https://sandbox.belvo.com/api/owners/
curl -i -X GET \
-u <username>:<password> \
'https://developers.belvo.com/_mock/apis/belvoopenapispec/api/owners/?created_at=2022-05-05&created_at__gt=2022-05-05&created_at__gte=2022-05-04&created_at__lt=2022-04-01&created_at__lte=2022-03-30&created_at__range=2022-03-03&display_name__icontains=Daniela&email=lopes.d%40gmail.com&fields=string&id=24ccab1d-3a86-4136-a6eb-e04bf52b356f&id__in=6b3dea0f-be29-49d1-aabe-1a6d588642e6&link=8848bd0c-9c7e-4f53-a732-ec896b11d4c4&link__in=5722d0ba-69d7-42dc-8ff5-33767b83c5d6&omit=string&page=1&page_size=100'Ok
The URL to next page of results. Each page consists of up to 100 items. If there are not enough results for an additional page, the value is null.
In our documentation example, we use {endpoint} as a placeholder value. In production, this value will be replaced by the actual endpoint you are currently using (for example, accounts or owners).
The URL to the previous page of results. If there is no previous page, the value is null.
An array of either:
🚧 One schema type per response
The response will contain an array of one of the schema types described above. In other words, there will not be a mix of schema types in the response.
Example of an individual (OFDA Brazil).
{ "count": 108, "next": "https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2", "previous": null, "results": [ { … } ] }
Omit certain fields from being returned in the response. For more information, see our Filtering responses DevPortal article.
Return only the specified fields in the response. For more information, see our Filtering responses DevPortal article.
The link.id you want to retrieve information for.
The MFA token generated by the institution which is required to continue a session.
https://developers.belvo.com/_mock/apis/belvoopenapispec/api/owners/
https://sandbox.belvo.com/api/owners/
curl -i -X POST \
-u <username>:<password> \
'https://developers.belvo.com/_mock/apis/belvoopenapispec/api/owners/?fields=string&omit=string' \
-H 'Content-Type: application/json' \
-d '{
"link": "c81a1dea-6dd6-4999-8b9f-541ee8197058",
"token": "1234ab",
"save_data": true
}'Ok (when save_data=false)
Belvo's unique identifier for the current item.
The link.id the data belongs to.
The institution's internal identifier for the owner.
The ISO-8601 timestamp when the data point was collected.
The ISO-8601 timestamp of when the data point was created in Belvo's database.
The full name of the individual, as provided by the institution.
Non-nullable: A value must be returned by Brazil's open finance network.
The social name of the individual, as generally accepted by the country.
The individual's date of birth, in YYYY-MM-DD format.
Non-nullable: A value must be returned by Brazil's open finance network.
The individual's marital status. We return one of the following values:
SINGLEMARRIEDWIDOWEDSEPARATEDDIVORCEDCIVIL_UNIONOTHERAdditional information about the individual's marital status.
The individual's gender. We return on of the following values:
FEMALEMALEOTHERThe institutions responsible for the creation and verification of the owner.
Non-nullable: A value must be returned by Brazil's open finance network.
Boolean to indicate if the individual is a local resident of the country.
Non-nullable: A value must be returned by Brazil's open finance network.
Information regarding the identification document the owner provided to the bank.
Non-nullable: A value must be returned by Brazil's open finance network.
The type of document the owner provided to the institution to open the account. Common document types are:
🇧🇷 Brazil
CPF (Cadastro de Pessoas Físicas)CNPJ(Cadastro Nacional de Pessoas Jurídicas)Non-nullable: A value must be returned by Brazil's open finance network.
Detailed information regarding additional documents provided to prove the individuals ID.
Non-nullable: A value must be returned by Brazil's open finance network.
The type of ID document. We return one of the following values:
DRIVERS_LICENSEPASSPORTID_CARDFISCAL_IDFOREIGNER_REGISTRATION_CARDOTHERnullAdditional information regarding the document type.
Note: For Business ID documents, this field must return a value from Brazil's open finance network.
The ID document's number.
Non-nullable: A value must be returned by Brazil's open finance network.
The check digit of the ID document.
Non-nullable: A value must be returned by Brazil's open finance network.
The date the the ID document was issued, in YYYY-MM-DD format.
The date the the ID document expires, in YYYY-MM-DD format.
The three-letter country code that issued the document (in ISO-3166 Alpha 3 format).
This field must be returned when the type is PASSPORT.
Detailed information regarding the individual's nationalities.
Only required to be returned when is_local_resident is set to false.
The nationality of the individual.
The type of ID document. We return one of the following values:
DRIVERS_LICENSEPASSPORTID_CARDFISCAL_IDFOREIGNER_REGISTRATION_CARDOTHERnullThe ID document's number.
Non-nullable: A value must be returned by Brazil's open finance network.
The date the the ID document was issued, in YYYY-MM-DD format.
The date the the ID document expires, in YYYY-MM-DD format.
The three-letter country code that issued the document (in ISO-3166 Alpha 3 format).
This field must be returned when the type is PASSPORT.
The account owner's registered email address.
Non-nullable: A value must be returned by Brazil's open finance network.
Additional list of emails the owner provided.
Non-nullable: A value must be returned by Brazil's open finance network.
Boolean to indicate if this is the user's main email address.
Non-nullable: A value must be returned by Brazil's open finance network.
The account owner's registered address.
Non-nullable: A value must be returned by Brazil's open finance network.
Detailed information regarding the owner's addresses.
Non-nullable: A value must be returned by Brazil's open finance network.
Boolean to indicate if this is the user's main address.
Non-nullable: A value must be returned by Brazil's open finance network.
The user's address.
Non-nullable: A value must be returned by Brazil's open finance network.
Additional information regarding the user's address.
The distrct of the address.
The user's town.
Non-nullable: A value must be returned by Brazil's open finance network.
The seven-digit code for the town, if applicable.
For Brazil, this is the IBGE town code.
The state that the address is located in.
The postcode of the address.
Non-nullable: A value must be returned by Brazil's open finance network.
The name of the country.
Non-nullable: A value must be returned by Brazil's open finance network.
The three-letter country code (ISO-3166 Alpha 3 compliant).
The geographic latitude coordinate.
The account owner's registered phone number.
Non-nullable: A value must be returned by Brazil's open finance network.
Detailed information regarding the owner's phone numbers.
Non-nullable: A value must be returned by Brazil's open finance network.
Boolean to indicate if this is the user's main phone number.
Non-nullable: A value must be returned by Brazil's open finance network.
The type of phone number. We return one of the following values:
LANDLINEMOBILEOTHERnullAdditional information about the phone number.
The phone number (not including the country, area, or extension codes).
Non-nullable: A value must be returned by Brazil's open finance network.
The country dialling code. For example: 351 (no +).
Information regarding any familial relationships of the individual.
Non-nullable: A value must be returned by Brazil's open finance network.
The familial relationship. We return one of the following values:
MOTHERFATHERnullThe person's full name.
Non-nullable: A value must be returned by Brazil's open finance network.
Information regarding the financial profile of the individual.
The identifier of the company where the individual is employed.
The area of employment of the individual. We return one of the following values:
BRAZIL_PUBLIC_OFFICEBRAZIL_OCCUPATION_CODEOTHERnullInformation regarding the individual's occupation.
Information regarding the individual's reported income.
Non-nullable: A value must be returned by Brazil's open finance network.
Indicates how often the individual receives their salary. We return one of the following values:
DAILYWEEKLYFORTNIGHTLYMONTHLYBIMONTHLYQUARTERLYBIANNUALLYANNUALLYOTHERSThe reported income that the individual receives.
Non-nullable: A value must be returned by Brazil's open finance network.
The three-letter currency code (ISO-4217).
Non-nullable: A value must be returned by Brazil's open finance network.
Information regarding the individual's reported assets (if available).
The reported assets of the individual.
Non-nullable: A value must be returned by Brazil's open finance network when the
patrimonyobject is available.
The three-letter currency code (ISO-4217).
Non-nullable: A value must be returned by Brazil's open finance network when the
patrimonyobject is available.
Details regarding any additional relationship the individual has with the institution (for example, other accounts or products they have with the institution).
The ISO-8601 timestamp when the financial relationship between the individual and the institution started.
Non-nullable: A value must be returned by Brazil's open finance network.
A list of products that the individual has with the institution.
Non-nullable: A value must be returned by Brazil's open finance network.
Additional information regarding the products that the individual has.
Information regarding any individuals or companies that can act on behalf of the owner.
The type of representative that can access and make changes to the account. We return one of the following values:
LEGAL_REPRESENTATIVEATTORNEYnullThe representatives's full name.
Non-nullable: A value must be returned by Brazil's open finance network if the
procuratorsfield is available.
The person's social name.
The document number of the representative.
Note: For individuals, this is Brazil's CPF number. For businesses, this is Brazil's CNPJ number.
Non-nullable: A value must be returned by Brazil's open finance network if the
procuratorsfield is available.
Details regarding any additional products that the individual has with the institution.
The additional products the individual has at the institution. We return one of the following values:
SAVINGS_ACCOUNTCHECKING_ACCOUNTnullThe subtype of the product that the individual has at the institution.
Non-nullable: A value must be returned by Brazil's open finance network if the
productsfield is available.
The branch code where the product was opened.
The banking clearing code for the product.
Non-nullable: A value must be returned by Brazil's open finance network if the
productsfield is available.
The account number of the product.
Non-nullable: A value must be returned by Brazil's open finance network if the
procuratorsfield is available.
Details regarding any salary portability requests that the individual has made with the institution.
A salary portability is a request to transfer the individual's salary from their employer's 'payroll' bank account to another bank account.
📘
Please note that the receiving bank account cannot terminate a salary portability (or be informed that it has been termnated). Only the employer's payroll bank is able to provide this information. As such, the portabilities listed here may not be up-to-date.
Details regarding any payroll bank accounts that are associated with the individual. That is, each time the indivudal has a new employer that they receive a salary from, it should be listed here.
📘
Past employers may not close the payroll account for the indiviual. As such, the payroll accounts listed here may not be up-to-date.
Example of an individual (OFDA Brazil).
[ { "id": "c749315b-eec2-435d-a458-06912878564f", "link": "30cb4806-6e00-48a4-91c9-ca55968576c8", "internal_identification": "7e5838e4", "collected_at": "2019-09-27T13:01:41.941Z", "created_at": "2022-02-09T08:45:50.406032Z", "display_name": "Jack Oswald White", "social_name": "O Piadista", "birth_date": "1988-07-15", "marital_status": "SINGLE", "marital_status_additional_info": "It's complicated", "gender": "MALE", "companies_id": [ … ], "is_local_resident": true, "document_id": { … }, "additional_documents": [ … ], "nationalities": [ … ], "email": "johndoe@belvo.com", "emails": [ … ], "address": "Carrer de la Llacuna, 162, 08018 Barcelona", "addresses": [ … ], "phone_number": "+52-XXX-XXX-XXXX", "phone_numbers": [ … ], "filiations": [ … ], "financial_profile": { … }, "financial_relation": { … } } ]
Omit certain fields from being returned in the response. For more information, see our Filtering responses DevPortal article.
Return only the specified fields in the response. For more information, see our Filtering responses DevPortal article.
The session you want to resume. You need to use the session value that is provided in the 428 Token Required response that you receive after you make your POST request.
The MFA token generated by the institution which is required to continue a session.
The link.id you want to resume. Must be the same link.id as the one you receive in the 428 Token Required response that contains the session ID.
https://developers.belvo.com/_mock/apis/belvoopenapispec/api/owners/
https://sandbox.belvo.com/api/owners/
curl -i -X PATCH \
-u <username>:<password> \
'https://developers.belvo.com/_mock/apis/belvoopenapispec/api/owners/?fields=string&omit=string' \
-H 'Content-Type: application/json' \
-d '{
"session": "6e7b283c6efa449c9c028a16b5c249fa",
"token": "1234ab",
"link": "683005d6-f45c-4adb-b289-f1a12f50f80c",
"save_data": true
}'Ok (when save_data=false)
Belvo's unique identifier for the current item.
The link.id the data belongs to.
The institution's internal identifier for the owner.
The ISO-8601 timestamp when the data point was collected.
The ISO-8601 timestamp of when the data point was created in Belvo's database.
The full name of the individual, as provided by the institution.
Non-nullable: A value must be returned by Brazil's open finance network.
The social name of the individual, as generally accepted by the country.
The individual's date of birth, in YYYY-MM-DD format.
Non-nullable: A value must be returned by Brazil's open finance network.
The individual's marital status. We return one of the following values:
SINGLEMARRIEDWIDOWEDSEPARATEDDIVORCEDCIVIL_UNIONOTHERAdditional information about the individual's marital status.
The individual's gender. We return on of the following values:
FEMALEMALEOTHERThe institutions responsible for the creation and verification of the owner.
Non-nullable: A value must be returned by Brazil's open finance network.
Boolean to indicate if the individual is a local resident of the country.
Non-nullable: A value must be returned by Brazil's open finance network.
Information regarding the identification document the owner provided to the bank.
Non-nullable: A value must be returned by Brazil's open finance network.
The type of document the owner provided to the institution to open the account. Common document types are:
🇧🇷 Brazil
CPF (Cadastro de Pessoas Físicas)CNPJ(Cadastro Nacional de Pessoas Jurídicas)Non-nullable: A value must be returned by Brazil's open finance network.
Detailed information regarding additional documents provided to prove the individuals ID.
Non-nullable: A value must be returned by Brazil's open finance network.
The type of ID document. We return one of the following values:
DRIVERS_LICENSEPASSPORTID_CARDFISCAL_IDFOREIGNER_REGISTRATION_CARDOTHERnullAdditional information regarding the document type.
Note: For Business ID documents, this field must return a value from Brazil's open finance network.
The ID document's number.
Non-nullable: A value must be returned by Brazil's open finance network.
The check digit of the ID document.
Non-nullable: A value must be returned by Brazil's open finance network.
The date the the ID document was issued, in YYYY-MM-DD format.
The date the the ID document expires, in YYYY-MM-DD format.
The three-letter country code that issued the document (in ISO-3166 Alpha 3 format).
This field must be returned when the type is PASSPORT.
Detailed information regarding the individual's nationalities.
Only required to be returned when is_local_resident is set to false.
The nationality of the individual.
The type of ID document. We return one of the following values:
DRIVERS_LICENSEPASSPORTID_CARDFISCAL_IDFOREIGNER_REGISTRATION_CARDOTHERnullThe ID document's number.
Non-nullable: A value must be returned by Brazil's open finance network.
The date the the ID document was issued, in YYYY-MM-DD format.
The date the the ID document expires, in YYYY-MM-DD format.
The three-letter country code that issued the document (in ISO-3166 Alpha 3 format).
This field must be returned when the type is PASSPORT.
The account owner's registered email address.
Non-nullable: A value must be returned by Brazil's open finance network.
Additional list of emails the owner provided.
Non-nullable: A value must be returned by Brazil's open finance network.
Boolean to indicate if this is the user's main email address.
Non-nullable: A value must be returned by Brazil's open finance network.
The account owner's registered address.
Non-nullable: A value must be returned by Brazil's open finance network.
Detailed information regarding the owner's addresses.
Non-nullable: A value must be returned by Brazil's open finance network.
Boolean to indicate if this is the user's main address.
Non-nullable: A value must be returned by Brazil's open finance network.
The user's address.
Non-nullable: A value must be returned by Brazil's open finance network.
Additional information regarding the user's address.
The distrct of the address.
The user's town.
Non-nullable: A value must be returned by Brazil's open finance network.
The seven-digit code for the town, if applicable.
For Brazil, this is the IBGE town code.
The state that the address is located in.
The postcode of the address.
Non-nullable: A value must be returned by Brazil's open finance network.
The name of the country.
Non-nullable: A value must be returned by Brazil's open finance network.
The three-letter country code (ISO-3166 Alpha 3 compliant).
The geographic latitude coordinate.
The account owner's registered phone number.
Non-nullable: A value must be returned by Brazil's open finance network.
Detailed information regarding the owner's phone numbers.
Non-nullable: A value must be returned by Brazil's open finance network.
Boolean to indicate if this is the user's main phone number.
Non-nullable: A value must be returned by Brazil's open finance network.
The type of phone number. We return one of the following values:
LANDLINEMOBILEOTHERnullAdditional information about the phone number.
The phone number (not including the country, area, or extension codes).
Non-nullable: A value must be returned by Brazil's open finance network.
The country dialling code. For example: 351 (no +).
Information regarding any familial relationships of the individual.
Non-nullable: A value must be returned by Brazil's open finance network.
The familial relationship. We return one of the following values:
MOTHERFATHERnullThe person's full name.
Non-nullable: A value must be returned by Brazil's open finance network.
Information regarding the financial profile of the individual.
The identifier of the company where the individual is employed.
The area of employment of the individual. We return one of the following values:
BRAZIL_PUBLIC_OFFICEBRAZIL_OCCUPATION_CODEOTHERnullInformation regarding the individual's occupation.
Information regarding the individual's reported income.
Non-nullable: A value must be returned by Brazil's open finance network.
Indicates how often the individual receives their salary. We return one of the following values:
DAILYWEEKLYFORTNIGHTLYMONTHLYBIMONTHLYQUARTERLYBIANNUALLYANNUALLYOTHERSThe reported income that the individual receives.
Non-nullable: A value must be returned by Brazil's open finance network.
The three-letter currency code (ISO-4217).
Non-nullable: A value must be returned by Brazil's open finance network.
Information regarding the individual's reported assets (if available).
The reported assets of the individual.
Non-nullable: A value must be returned by Brazil's open finance network when the
patrimonyobject is available.
The three-letter currency code (ISO-4217).
Non-nullable: A value must be returned by Brazil's open finance network when the
patrimonyobject is available.
Details regarding any additional relationship the individual has with the institution (for example, other accounts or products they have with the institution).
The ISO-8601 timestamp when the financial relationship between the individual and the institution started.
Non-nullable: A value must be returned by Brazil's open finance network.
A list of products that the individual has with the institution.
Non-nullable: A value must be returned by Brazil's open finance network.
Additional information regarding the products that the individual has.
Information regarding any individuals or companies that can act on behalf of the owner.
The type of representative that can access and make changes to the account. We return one of the following values:
LEGAL_REPRESENTATIVEATTORNEYnullThe representatives's full name.
Non-nullable: A value must be returned by Brazil's open finance network if the
procuratorsfield is available.
The person's social name.
The document number of the representative.
Note: For individuals, this is Brazil's CPF number. For businesses, this is Brazil's CNPJ number.
Non-nullable: A value must be returned by Brazil's open finance network if the
procuratorsfield is available.
Details regarding any additional products that the individual has with the institution.
The additional products the individual has at the institution. We return one of the following values:
SAVINGS_ACCOUNTCHECKING_ACCOUNTnullThe subtype of the product that the individual has at the institution.
Non-nullable: A value must be returned by Brazil's open finance network if the
productsfield is available.
The branch code where the product was opened.
The banking clearing code for the product.
Non-nullable: A value must be returned by Brazil's open finance network if the
productsfield is available.
The account number of the product.
Non-nullable: A value must be returned by Brazil's open finance network if the
procuratorsfield is available.
Details regarding any salary portability requests that the individual has made with the institution.
A salary portability is a request to transfer the individual's salary from their employer's 'payroll' bank account to another bank account.
📘
Please note that the receiving bank account cannot terminate a salary portability (or be informed that it has been termnated). Only the employer's payroll bank is able to provide this information. As such, the portabilities listed here may not be up-to-date.
Details regarding any payroll bank accounts that are associated with the individual. That is, each time the indivudal has a new employer that they receive a salary from, it should be listed here.
📘
Past employers may not close the payroll account for the indiviual. As such, the payroll accounts listed here may not be up-to-date.
Example of an individual (OFDA Brazil).
[ { "id": "c749315b-eec2-435d-a458-06912878564f", "link": "30cb4806-6e00-48a4-91c9-ca55968576c8", "internal_identification": "7e5838e4", "collected_at": "2019-09-27T13:01:41.941Z", "created_at": "2022-02-09T08:45:50.406032Z", "display_name": "Jack Oswald White", "social_name": "O Piadista", "birth_date": "1988-07-15", "marital_status": "SINGLE", "marital_status_additional_info": "It's complicated", "gender": "MALE", "companies_id": [ … ], "is_local_resident": true, "document_id": { … }, "additional_documents": [ … ], "nationalities": [ … ], "email": "johndoe@belvo.com", "emails": [ … ], "address": "Carrer de la Llacuna, 162, 08018 Barcelona", "addresses": [ … ], "phone_number": "+52-XXX-XXX-XXXX", "phone_numbers": [ … ], "filiations": [ … ], "financial_profile": { … }, "financial_relation": { … } } ]
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:
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:
At the moment, the employments resource is available for:
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:
At the moment, the employment records resource is available for:
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.
To receive inflow payments to your organization's bank account, you must register the bank accounts (individual and business) using Belvo's Payments API.
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_typein theform_fieldsarray, you must send through this value in your PATCH request.