---
title: "Plaid Component"
slug: "plaid-component"
tags: ["module-builder"]
updated: 2026-10-05T15:49:46Z
published: 2026-10-05T15:49:46Z
canonical: "docs.unqork.io/plaid-component"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.unqork.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Plaid Component

The Plaid component integrates with the Plaid financial data API to let end-users link their bank accounts. It displays a button that opens the Plaid Link dialog and supports triggers on success and failure.

> [!NOTE]
> The Build Agent does not create new instances of this component.

> **How to read settings tables**
> 
> 
> The tables below describe each configurable option as it displays in the UnqorkAI platform. Values are formatted as follows: `inline code` — a value to type exactly as shown | **Bold** — a value selected from a drop-down, radio button, tab, or choice chip | **ON**/**OFF** — toggle state | ✓ — checkbox checked | ☐ — checkbox unchecked

## General Settings

| Setting | Field | Type | Default | Description |
| --- | --- | --- | --- | --- |
| Property ID | `key` | Text input | `plaid` | The unique identifier for this component instance. |

## Display Settings

### Field Text

| Setting | Field | Type | Default | Description |
| --- | --- | --- | --- | --- |
| Label Text | `label` | Text input | `Plaid` | Identifies the component on the canvas and informs end-users what information is requested. |

### Contextual Help

| Setting | Field | Type | Default | Description |
| --- | --- | --- | --- | --- |
| Helper Text | `description` | Text input | — | A single line of guidance text that always displays below the component. |

### Default State Options

| Setting | Field | Type | Default | Description |
| --- | --- | --- | --- | --- |
| Hide Label | `hideLabel` | Toggle | OFF | Hides the label. The label remains visible in the Module Builder. |
| Button Label in Default State | `buttonTextDefault` | Text input | — | The label on the Plaid button before an account is linked. |
| Button Label in Success State | `buttonTextSuccess` | Text input | — | The label on the Plaid button after an account is successfully linked. |

## Data Settings

| Setting | Field | Type | Default | Description |
| --- | --- | --- | --- | --- |
| Plaid Service to Use | `service.name` | Service selector | — | The configured Plaid service, as set up in Services Administration. |
| Client Name | `client_name` | Text input | — | The company name shown to end-users in the Plaid dialog when authorizing data access. |

**Select Plaid Products to Initialize**: When checked, enables access to the corresponding Plaid product.

| Product | Value | Description |
| --- | --- | --- |
| Auth | `auth` | When checked, this setting instantly authenticates bank accounts for payments. |
| Assets | `assets` | When checked, this setting verifies borrower's assets from the source. |
| Identity | `identity` | When checked, this setting verifies end-user identities and reduces fraud. |
| Investments | `investments` | When checked, this setting builds a holistic view of end-users' investments. |
| Liabilities | `liabilities` | When checked, this setting accesses liabilities data for student loans and credit cards. |
| Payroll Providers | `sba_verification` | When checked, this setting accesses employee payroll information. |
| Transactions | `transactions` | When checked, this setting accesses detailed transaction history. |

## Actions Settings

### Triggers

| Setting | Field | Type | Default | Description |
| --- | --- | --- | --- | --- |
| Success | `successTrigger` | Property ID | — | Triggers a component when the end-user successfully links a bank account. |
| Error | `errorTrigger` | Property ID | — | Triggers a component when the Plaid account linking fails. |

## Validation Settings

### User Input

| Setting | Field | Type | Default | Description |
| --- | --- | --- | --- | --- |
| Account Linking Error Message | `errorMessage` | Text input | `Unable to link your account. Please try again` | Displays when Plaid account linking fails. |

## Advanced Settings

### Additional Styling

| Setting | Field | Type | Default | Description |
| --- | --- | --- | --- | --- |
| Custom CSS Class | `customClass` | Text input | — | A CSS class applied to the component for custom styling. |

---

**Changelog**

| Date | Change |
| --- | --- |
| 2026-10-02 | Added Build Agent notice — the Build Agent does not create new instances of this component (EN-8141). |
| — | Initial publication. |

APIs (application programming interfaces) are a set of protocols and definitions developers use to build and integrate application software. APIs act as the connective tissue between products and services.

End-users, also known as Express Users, are the individuals accessing an application through Express View. In most cases, end-users are the customers using the product.

A Property ID is the unique field ID used by Unqork to track and link components in your module.

Label Text conveys what the input component is and what information it displays. Enter the purpose of the corresponding component or field.

Label Text conveys what the input component is and what information it displays. Enter the purpose of the corresponding component or field.

End-users, also known as Express Users, are the individuals accessing an application through Express View. In most cases, end-users are the customers using the product.

Cascading Style Sheets (CSS) is a style sheet language used for presenting how a HTML or XML document looks to end-users.