Unqork documentation is available in two workspaces: UnqorkAI for the latest AI-first platform, and legacy Unqork for previous versions. Use the drop-down near the logo to switch.

Plaid Component

Prev Next

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.

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 user identities and reduces fraud.

Investments

investments

When checked, this setting builds a holistic view of user's 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

—

Initial publication.