← Plaid

Create User with Plaid API

Pipedream makes it easy to connect APIs for Plaid and 2,500+ other apps remarkably fast.

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Create User with the Plaid API
No credit card required
Intro to Pipedream
Watch us build a workflow
Watch us build a workflow
8 min
Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo
Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo

Developers Pipedream

Getting Started

Create a workflow to Create User with the Plaid API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Create User action
    1. Connect your Plaid account
    2. Configure Client User ID
    3. Optional- Configure Include Consumer Report User Identity
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Create User with Plaid API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + Plaid
 
Try it
Create User with Plaid API on New Submission from Typeform API
Typeform + Plaid
 
Try it
Create User with Plaid API on New Submission (Instant) from Jotform API
Jotform + Plaid
 
Try it
Create User with Plaid API on New Scheduled Tasks from Pipedream API
Pipedream + Plaid
 
Try it
Create User with Plaid API on New Download Counts from npm API
npm + Plaid
 
Try it

Details

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Create User on Plaid
Description:Creates a user ID and token to be used with Plaid Check, Income, or Multi-Item Link flow. [See the documentation](https://plaid.com/docs/api/users/#usercreate).
Version:0.0.1
Key:plaid-create-user

Code

import app from "../../plaid.app.mjs";

export default {
  key: "plaid-create-user",
  name: "Create User",
  description: "Creates a user ID and token to be used with Plaid Check, Income, or Multi-Item Link flow. [See the documentation](https://plaid.com/docs/api/users/#usercreate).",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    clientUserId: {
      type: "string",
      label: "Client User ID",
      description: "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.",
      optional: false,
    },
    includeConsumerReportUserIdentity: {
      type: "boolean",
      label: "Include Consumer Report User Identity",
      description: "Whether to include the consumer report user identity. This is required for all Plaid Check customers.",
      optional: true,
      reloadProps: true,
    },
  },
  additionalProps() {
    if (!this.includeConsumerReportUserIdentity) {
      return {};
    }

    return {
      firstName: {
        type: "string",
        label: "First Name",
        description: "The user's first name",
      },
      lastName: {
        type: "string",
        label: "Last Name",
        description: "The user's last name",
      },
      phoneNumbers: {
        type: "string[]",
        label: "Phone Numbers",
        description: "The user's phone number, in E.164 format: +{countrycode}{number}. For example: `+14157452130`. Phone numbers provided in other formats will be parsed on a best-effort basis. Phone number input is validated against valid number ranges; number strings that do not match a real-world phone numbering scheme may cause the request to fail, even in the Sandbox test environment.",
      },
      emails: {
        type: "string[]",
        label: "Emails",
        description: "The user's emails",
      },
      ssnLast4: {
        type: "string",
        label: "SSN Last 4",
        description: "The last 4 digits of the user's social security number.",
        optional: true,
      },
      dateOfBirth: {
        type: "string",
        label: "Date of Birth",
        description: "To be provided in the format `yyyy-mm-dd`. This field is required for all Plaid Check customers.",
      },
      primaryAddressCity: {
        type: "string",
        label: "City",
        description: "The full city name for the primary address",
      },
      primaryAddressRegion: {
        type: "string",
        label: "Region/State",
        description: "The region or state. Example: `NC`",
      },
      primaryAddressStreet: {
        type: "string",
        label: "Street",
        description: "The full street address. Example: `564 Main Street, APT 15`",
      },
      primaryAddressPostalCode: {
        type: "string",
        label: "Postal Code",
        description: "The postal code",
      },
      primaryAddressCountry: {
        type: "string",
        label: "Country",
        description: "The ISO 3166-1 alpha-2 country code",
      },
    };
  },
  async run({ $ }) {
    const {
      app,
      clientUserId,
      includeConsumerReportUserIdentity,
      firstName,
      lastName,
      phoneNumbers,
      emails,
      ssnLast4,
      dateOfBirth,
      primaryAddressCity,
      primaryAddressRegion,
      primaryAddressStreet,
      primaryAddressPostalCode,
      primaryAddressCountry,
    } = this;

    const response = await app.createUser({
      client_user_id: clientUserId,
      ...(includeConsumerReportUserIdentity
        ? {
          consumer_report_user_identity: {
            first_name: firstName,
            last_name: lastName,
            phone_numbers: phoneNumbers,
            emails: emails,
            date_of_birth: dateOfBirth,
            ssn_last_4: ssnLast4,
            primary_address: {
              city: primaryAddressCity,
              region: primaryAddressRegion,
              street: primaryAddressStreet,
              postal_code: primaryAddressPostalCode,
              country: primaryAddressCountry,
            },
          },
        }
        : {}
      ),
    });

    $.export("$summary", `Successfully created user with ID \`${response.user_id}\`.`);

    return response;
  },
};

Configuration

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.
LabelPropTypeDescription
PlaidappappThis component uses the Plaid app.
Client User IDclientUserIdstring

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.

Include Consumer Report User IdentityincludeConsumerReportUserIdentityboolean

Whether to include the consumer report user identity. This is required for all Plaid Check customers.

Authentication

Plaid uses API keys for authentication. When you connect your Plaid account, Pipedream securely stores the keys so you can easily authenticate to Plaid APIs in both code and no-code steps.

Find your client ID and client secret in your Plaid Keys settings and enter them below.

You develop Plaid apps in different environments. Please choose the environment below (you can change this at https://pipedream.com/accounts at any time).

About Plaid

Connect to users' bank accounts.

More Ways to Use Plaid

Triggers

New Accounts Available (Instant) from the Plaid API

Emit new event when there are new accounts available at the Financial Institution. See the documentation

 
Try it
New Event (Instant) from the Plaid API

Emit new event when there are changes to Plaid Items or the status of asynchronous processes. See the documentation

 
Try it
Sync Updates Available (Instant) from the Plaid API

Emit new event when there are new updates available for a connected account. See the documentation

 
Try it

Actions

Create Access Token with the Plaid API

Exchange a Link public_token for an API access_token. See the documentation

 
Try it
Create Sandbox Public Token with the Plaid API

Creates a valid public_token for an arbitrary institution ID, initial products, and test credentials. See the documentation

 
Try it
Get Real-Time Balance with the Plaid API

Get the real-time balance for each of an Item's accounts. See the documentation

 
Try it
Get Transactions with the Plaid API

Retrieves user-authorized transaction data for a specified date range. See the documentation

 
Try it

Explore Other Apps

1
-
24
of
2,500+
apps by most popular

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
Pipedream Utils
Pipedream Utils
Utility functions to use within your Pipedream workflows
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.
Premium
Salesforce
Salesforce
Cloud-based customer relationship management (CRM) platform that helps businesses manage sales, marketing, customer support, and other business activities, ultimately aiming to improve customer relationships and streamline operations.
Premium
HubSpot
HubSpot
HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.
Premium
Zoho CRM
Zoho CRM
Zoho CRM is an online Sales CRM software that manages your sales, marketing, and support in one CRM platform.
Premium
Stripe
Stripe
Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.
Shopify
Shopify
Shopify is a complete commerce platform that lets anyone start, manage, and grow a business. You can use Shopify to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.
Premium
WooCommerce
WooCommerce
WooCommerce is the open-source ecommerce platform for WordPress.
Premium
Snowflake
Snowflake
A data warehouse built for the cloud
Premium
MongoDB
MongoDB
MongoDB is an open source NoSQL database management program.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
Premium
AWS
AWS
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Premium
Twilio SendGrid
Twilio SendGrid
Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Premium
Klaviyo
Klaviyo
Email Marketing and SMS Marketing Platform
Premium
Zendesk
Zendesk
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
Premium
ServiceNow
ServiceNow
The smarter way to workflow
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.