Connecting an Item with Open Finance through Pluggy Connect

When a user connects through Open Finance, the login process is different from a Direct 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.

Connecting an Item with Open Finance through API

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:

1. 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.
2. Create an Item for that connector's ID. It will require CPF or CNPJ depending on if it's a Personal or Business connector.
3. 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.
4. Once the user completes the login, they are redirected to a Pluggy OAuth callback endpoint that starts the connection on the Item automatically.
5. Retrieve the data from the Item.

Open Finance Test Account

To connect using our sandbox connection, you will be required to send a CPF the value "76109277673" and when accessing the Financial Institution of "Mock Bank" you can use the following parameters:

{
  user: "[email protected]",
  password: "P@ssword01"
}