POST /item/import
/item/import creates an Item via your Plaid Exchange Integration and returns an access_token. As part of an /item/import request, you will include a User ID (user_auth.user_id) and Authentication Token (user_auth.auth_token) that enable data aggregation through your Plaid Exchange API endpoints. These authentication principals are to be chosen by you.
Upon creating an Item via /item/import, Plaid will automatically begin an extraction of that Item through the Plaid Exchange infrastructure 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 | Yes |
Array of product strings |
client_id |
String | No |
Your Plaid API |
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 | Yes |
Authorization token Plaid will use to aggregate this user’s accounts |
user_auth.user_id |
String | Yes |
Opaque user identifier |
options |
Object | No |
An optional object to configure |
options.webhook |
String | No |
Specifies a webhook URL to associate with an Item. Plaid fires a webhook if credentials fail. |
secret |
String | No |
Your Plaid API |
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.