View as Markdown
Plaid icon

Plaid ACTION

Create User

Creates a user ID and token to be used with Plaid Check, Income, or Multi-Item Link flow. See the documentation.
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Plaid account once, then configure and run Create User from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "plaid-create-user",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    plaid: { authProvisionId: "apn_xxxxxxx" },
    clientUserId: "Client User ID",
    includeConsumerReportUserIdentity: true,
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Create User inputs
Property Type Description
clientUserId Client User ID string
A unique ID representing the end user. Maximum of 128 characters. Typically this will be a user ID number from your application. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id.
Required
includeConsumerReportUserIdentity Include Consumer Report User Identity boolean
Whether to include the consumer report user identity. This is required for all Plaid Check customers.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
plaid-create-user
Version
0.0.2
App
Plaid
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes