POST /item/import

/item/import creates an Item for one of your customers and returns an access_token, which the other Permissions Manager endpoints take in place of a customer identifier. You supply your own identifier for the customer as user_auth.user_id.

The endpoint is idempotent and the access_token it returns is long-lived: repeated calls for the same user_auth.user_id return the same token.

Upon creating an Item via /item/import, Plaid will automatically begin an extraction of that Item through the data provider API endpoints you have already integrated.

Servers

https://production.plaid.com
https://sandbox.plaid.com

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`products[]`	Array	No	Array of product strings. Sent only by a Plaid-internal caller, the Data Partner Dashboard validation tool; external callers never need it. Not required for Permissions Manager callers, who authenticate with `user_auth.user_id`.
`client_id`	String	No	Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
`user_auth`	Object	Yes	Object of user ID and auth token pair, permitting Plaid to aggregate a user's accounts
`user_auth.auth_token`	String	No	Authorization token used by the legacy Plaid Exchange integration; not required for Permissions Manager callers.
`user_auth.user_id`	String	Yes	Your persistent, unique identifier for the customer.
`options`	Object	No	An optional object to configure `/item/import` request. Retained for the legacy Plaid Exchange integration; not required for Permissions Manager callers.
`options.webhook`	String	No	Specifies a webhook URL to associate with an Item. Plaid fires a webhook if credentials fail.
`institution_id`	String	No	The Plaid Institution ID associated with the Item. Most callers omit this field; Plaid resolves your institution automatically. If your organization has multiple institutions, contact Plaid to determine whether you should send it.
`secret`	String	No	Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.