At Pluggy, apart from our usual Connectors, we now also support obtaining data from the Brazilian Open Finance Network with Open Finance Connectors.
Open Finance Connectors follow Pluggy's data model like any other Connector (Items, Accounts, Transactions, etc.), so there is no breaking change when obtaining data from Open Finance. However, they are some differences in the products they retrieve, the institutions they support and the way the user connects their account. In this guide we will discuss those differences so you can choose which connector type is best suited for your use case.
If you are interested in using Open Finance Connectors, please contact our sales team to enable it for your plan
Right now, Open Finance supports only the following products:
- IDENTITY (only
If your use case needs the INVESTMENTS product for example, you can not retrieve this product with Open Finance Connectors.
Here is a comparison of support of brazilian institutions from Open Finance and from normal connectors:
|Open Finance Connector||Normal Connector|
|Itaú||Personal, Business||Personal, Business|
|Bradesco||Personal, Business||Personal, Business|
|Caixa||Personal, Business||Personal, Business|
|Santander||Personal, Business||Personal, Business|
|Banco do Brasil||Personal, Business||Personal, Business|
|Mercado Pago||Personal, Business||Personal|
|Itaú Cartões||Personal, Business||Personal|
|Banco Original||Personal, Business||Personal|
|Banco Bmg||Personal, Business||None|
Investment Connectors that were not mentioned here, as well as other types like Digital Economy and Payment Processors are not currently supported by Open Finance, but have Normal Connectors available. Check out the Connectors Coverage docs for all our supported Connectors.
When a user connects through Open Finance, the login process is different from a normal connector.
First, the user is prompted for their CPF (for Personal connectors) or CNPJ:
Then, the user is taken to the institution's Open Finance login page (with a pop-up) to complete the login process:
This step depends on the institution: it can prompt the user to scan a QR, or offer a link that opens the institution's app directly, ask for credentials, etc.
After logging in, the user is prompted to select the information they will share:
After the user accepts to sharing that information, the pop-up is closed and they are taken back to the connection screen, while the connector finishes retrieving the data.
This flow is solved out of the box in Pluggy Connect. If you are not using Pluggy Connect, please refer to the guide at the bottom of this page.
Once you have Open Finance enabled for your plan, to add an Open Finance Connector, follow these steps:
Open Finance connectors will have an Open Finance tag, and appear as "[OF]" in the selected connectors list.
Now, users will be able to choose those institutions in Pluggy Connect (they look just like any usual connector):
Use this approach if you do not use Pluggy Connect and you want to connect using Pluggy's API. Once the Open Finance feature is enabled for your plan, follow these steps:
- Obtain the connector ID for the Open Finance Connector of your choice. In the /connectors endpoint you will see them starting with ID 600 and higher. For example, Itaú's Open Finance Connector has ID 601.
- Create an Item for that connector's ID. It will require CPF or CNPJ depending on if it's a Personal or Business connector.
- Follow the Pluggy OAuth v2 documentation to complete the login. With this flow, from the created Item you will obtain a url to open for the user, which will transfer them to the institution's login.
- Once the user completes the login, they are redirected to a Pluggy OAuth callback endpoint that starts the connection on the Item automatically.
- Retrieve the data from the Item.
Updated 3 days ago