itemImport
/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. This will automatically generate the Plaid native account ID for the account the user will switch their direct deposit to (target_account_id).
Authorization
PLAID-CLIENT-ID PLAID-SECRET Plaid-Version In: header
In: header
In: header
Request Body
application/json
ItemImportRequest defines the request schema for /item/import
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.
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.
Array of product strings
1 <= itemsObject of user ID and auth token pair, permitting Plaid to aggregate a user’s accounts
An optional object to configure /item/import request.
Response Body
application/json
curl -X POST "https://example.com/item/import" \ -H "Content-Type: application/json" \ -d '{ "products": [ "assets" ], "user_auth": { "user_id": "string", "auth_token": "string" } }'{ "access_token": "access-sandbox-99ace160-3cf7-4e51-a083-403633425815", "request_id": "ewIBAn6RZirsk4W"}itemWebhookUpdate POST
The POST `/item/webhook/update` allows you to update the webhook URL associated with an Item. This request triggers a [`WEBHOOK_UPDATE_ACKNOWLEDGED`](https://plaid.com/docs/api/webhooks/#item-webhook-url-updated) webhook to the newly specified webhook URL.
assetReportAuditCopyCreate POST
Plaid can provide an Audit Copy of any Asset Report directly to a participating third party on your behalf. For example, Plaid can supply an Audit Copy directly to Fannie Mae on your behalf if you participate in the Day 1 Certainty™ program. An Audit Copy contains the same underlying data as the Asset Report. To grant access to an Audit Copy, use the `/asset_report/audit_copy/create` endpoint to create an `audit_copy_token` and then pass that token to the third party who needs access. Each third party has its own `auditor_id`, for example `fannie_mae`. You’ll need to create a separate Audit Copy for each third party to whom you want to grant access to the Report.