Plaid Developer Portal
Plaid
HomeSDKsAPI ReferenceContext Plugin
Item

itemApplicationScopesUpdate

POST
/item/application/scopes/update

Enable consumers to update product access on selected accounts for an application.

Authorization

PLAID-CLIENT-ID PLAID-SECRET Plaid-Version
PLAID-CLIENT-ID<token>

In: header

PLAID-SECRET<token>

In: header

Plaid-Version<token>

In: header

Request Body

application/json

ItemApplicationScopesUpdateRequest defines the request schema for /item/application/scopes/update

client_id?string

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.

secret?string

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.

access_token*string

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

application_id*string

This field will map to the application ID that is returned from /item/applications/list, or provided to the institution in an oauth redirect.

scopes*

The scopes object

state?string

When scopes are updated during enrollment, this field must be populated with the state sent to the partner in the OAuth Login URI. This field is required when the context is ENROLLMENT.

context*ScopesContext

An indicator for when scopes are being updated. When scopes are updated via enrollment (i.e. OAuth), the partner must send ENROLLMENT. When scopes are updated in a post-enrollment view, the partner must send PORTAL.

Value in

  • "ENROLLMENT"
  • "PORTAL"

Response Body

application/json

application/json

curl -X POST "https://example.com/item/application/scopes/update" \  -H "Content-Type: application/json" \  -d '{    "access_token": "string",    "application_id": "string",    "scopes": {},    "context": "ENROLLMENT"  }'
{  "request_id": "string"}

itemCreatePublicToken POST

Note: As of July 2020, the `/item/public_token/create` endpoint is deprecated. Instead, use `/link/token/create` with an `access_token` to create a Link token for use with [update mode](https://plaid.com/docs/link/update-mode). If you need your user to take action to restore or resolve an error associated with an Item, generate a public token with the `/item/public_token/create` endpoint and then initialize Link with that `public_token`. A `public_token` is one-time use and expires after 30 minutes. You use a `public_token` to initialize Link in [update mode](https://plaid.com/docs/link/update-mode) for a particular Item. You can generate a `public_token` for an Item even if you did not use Link to create the Item originally. The `/item/public_token/create` endpoint is **not** used to create your initial `public_token`. If you have not already received an `access_token` for a specific Item, use Link to obtain your `public_token` instead. See the [Quickstart](https://plaid.com/docs/quickstart) for more information.

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.