itemImport

POST {{baseUrl}}/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. This will automatically generate the Plaid native account ID for the account the user will switch their direct deposit to (target_account_id).

Request Body

{"products"=>["<string>"], "user_auth"=>{"user_id"=>"<string>", "auth_token"=>"<string>"}, "client_id"=>"5fd43aad1186c30013d6f3e2", "secret"=>"<string>", "options"=>{"webhook"=>"<string>"}}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring

RESPONSES

status: OK

{&quot;access_token&quot;:&quot;\u003cstring\u003e&quot;,&quot;request_id&quot;:&quot;\u003cstring\u003e&quot;}