Looking for the previous documentation?Go to v1.docs.pluggy.ai
PluggyDocs

Dashboard: connectors, test connections and the itemId

Step by step in the Pluggy Dashboard: choose which connectors Pluggy Connect shows, connect an account from the Dashboard itself, and copy the itemId and your API credentials.

View as Markdown

Three things every integration needs from the Pluggy Dashboard, with the exact place to click. The same steps work for any connector — a bank, an Open Finance institution, or the MeuPluggy connector for personal use (see Personal use with Meu Pluggy).

1. Choose which connectors Pluggy Connect shows#

Connector selection is set once for your team and applies to every application's Pluggy Connect widget.

  1. In the left menu, open Customization (under Financial Data).
  2. Go to the Connectors tab.

  1. Pick a mode:
    • Default to all selected — every available connector is shown.
    • Custom selection active — only the connectors you switch on are shown.
  2. Use the search box to find a connector by name (for example MeuPluggy, Itaú, Nubank). Results are grouped by category (Personal, Business, Investment); open a group and choose between its OF Connectors and Direct Connectors tabs — MeuPluggy is a Direct connector (it carries the Direct badge). In custom mode, turn the connector's switch on.

  1. Use Preview on the right to open the real widget and check the list your users will see.

Keep at least one connector

Pluggy Connect always needs at least one connector selected. Branding (name, logo, colors, button text) lives in the General tab of the same page — see Customization.

2. Connect an account from the Dashboard#

You do not need a frontend to test a connection: every application has a Demo page that opens Pluggy Connect for you.

  1. Open Applications and click the application you want to use (the gear icon opens its settings).
  2. Open its Demo page and click Connect Account.

  1. Pick the institution in the widget and finish the connection. The Sandbox connector is always listed here (search Sandbox), so you can test with the sandbox credentials on any plan; the item it creates is called Pluggy Bank.

3. Find the itemId#

Every connection creates an Item, and its id — the itemId — is what the API reads data with (GET /accounts?itemId=…).

  1. On the same Demo page, the left column Connected Items lists the application's items.
  2. Click an item: its detail shows the itemId with a copy button, plus its accounts, identity and investments.

In your own integration the itemId also arrives in the widget's onSuccess callback and in every item/* webhook — store it when the connection is created. See Item.

4. Client ID and Client Secret#

  1. Open Applications. Each application row shows its Client ID and a masked Client Secret, with buttons to reveal and copy them.

  1. Exchange them for an API key with POST /auth (see Authentication).

The secret can be revealed again at any time from the same place. Refresh Secret, in the application's settings, rotates it — the old secret stops working.

Common questions#

  • "The connector I want is not in the widget." Check the Connectors tab: in custom mode only switched-on connectors appear.
  • "I want real (production) data." Companies request it with Unlock real data on the application (it leads to Sales and due diligence). For personal use, choose that option and you are pointed to Meu Pluggy, which is free.
Was this page helpful?