plaid

Import Item

Changed on

/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.

post/item/import

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/item/import
  • Auth
    API key in header PLAID-CLIENT-ID and API key in header PLAID-SECRET and API key in header Plaid-Version

Request body

client_idstring

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.

secretstring

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.

institution_idstring

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.

productsProducts[]

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.

Response

OK

access_tokenstring required

The access token associated with the Item for which data is being requested.

request_idstring required

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

Changes

  • ea443cd78f6fRevision changes
    • warning

      added the new CRA_PARTNER_INSIGHTS_ERROR enum value to the response property for the response status

    • warning

      added the new CRA_REPORT_ERROR enum value to the response property for the response status

  • e536704a333fRevision changes
    • info

      the request property became optional

    • info

      the request property / became optional

    • info

      request property deprecated

    • info

      request property / deprecated

    • info

      request property / deprecated

    • info

      added the new cra_home_lending enum value to the request property /