{ "opencollection": "1.0.0", "info": { "name": "Plaid item/", "version": "2020-09-14_1.517.0" }, "items": [ { "info": { "name": "Plaid", "type": "folder" }, "items": [ { "info": { "name": "Plaid List a historical log of user consent events", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/item/activity/list", "body": { "type": "json", "data": "{}" } }, "docs": "List a historical log of user consent events" }, { "info": { "name": "Plaid List a user’s connected applications", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/item/application/list", "body": { "type": "json", "data": "{}" } }, "docs": "List a user’s connected applications" }, { "info": { "name": "Plaid Unlink a user’s connected application", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/item/application/unlink", "body": { "type": "json", "data": "{}" } }, "docs": "Unlink a user’s connected application. On an unlink request, Plaid will immediately revoke the Application’s access to the User’s data. The User will have to redo the OAuth authentication process in order to restore functionality.\n\nThis endpoint only removes ongoing data access permissions, therefore the User will need to reach out to the Application itself in order to disable and delete their account and delete any data that the Application already received (if the Application does not do so b" }, { "info": { "name": "Plaid Update the scopes of access for a particular application", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/item/application/scopes/update", "body": { "type": "json", "data": "{}" } }, "docs": "Enable consumers to update product access on selected accounts for an application." }, { "info": { "name": "Plaid Retrieve an Item", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/item/get", "body": { "type": "json", "data": "{}" } }, "docs": "Returns information about the status of an Item." }, { "info": { "name": "Plaid Remove an Item", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/item/remove", "body": { "type": "json", "data": "{}" } }, "docs": "The `/item/remove` endpoint allows you to remove an Item. Once removed, the `access_token`, as well as any processor tokens or bank account tokens associated with the Item, is no longer valid and cannot be used to access any data that was associated with the Item.\n\nRemoving an Item does not affect any Asset Reports or Audit Copies you have already created, which will remain accessible until you remove access to them specifically using the `/asset_report/remove` endpoint.\n\nNote that in the Develo" }, { "info": { "name": "Plaid Fire a test webhook", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/sandbox/item/fire_webhook", "body": { "type": "json", "data": "{}" } }, "docs": "The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks:\n\n`DEFAULT_UPDATE`: Transactions update webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result.\n\n`NEW_ACCOUNTS_AVAILABLE`: Webhook to be fired for a given Sandbox Item created with Account Select v2.\n\n`AUTH_DATA_UPDATE`: Webhook to be fired for a given Sandbox Item creat" }, { "info": { "name": "Plaid Update Webhook URL", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/item/webhook/update", "body": { "type": "json", "data": "{}" } }, "docs": "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/items/#webhook_update_acknowledged) webhook to the newly specified webhook URL." }, { "info": { "name": "Plaid Invalidate access_token", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/item/access_token/invalidate", "body": { "type": "json", "data": "{}" } }, "docs": "By default, the `access_token` associated with an Item does not expire and should be stored in a persistent, secure manner.\n\nYou can use the `/item/access_token/invalidate` endpoint to rotate the `access_token` associated with an Item. The endpoint returns a new `access_token` and immediately invalidates the previous `access_token`.\n" }, { "info": { "name": "Plaid Force a Sandbox Item into an error state", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/sandbox/item/reset_login", "body": { "type": "json", "data": "{}" } }, "docs": "`/sandbox/item/reset_login/` forces an Item into an `ITEM_LOGIN_REQUIRED` state in order to simulate an Item whose login is no longer valid. This makes it easy to test Link's [update mode](https://plaid.com/docs/link/update-mode) flow in the Sandbox environment. After calling `/sandbox/item/reset_login`, You can then use Plaid Link update mode to restore the Item to a good state. An `ITEM_LOGIN_REQUIRED` webhook will also be fired after a call to this endpoint, if one is associated with the Ite" }, { "info": { "name": "Plaid Set verification status for Sandbox account", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/sandbox/item/set_verification_status", "body": { "type": "json", "data": "{}" } }, "docs": "The `/sandbox/item/set_verification_status` endpoint can be used to change the verification status of an Item in in the Sandbox in order to simulate the Automated Micro-deposit flow.\n\nFor more information on testing Automated Micro-deposits in Sandbox, see [Auth full coverage testing](https://plaid.com/docs/auth/coverage/testing#)." }, { "info": { "name": "Plaid Exchange public token for an access token", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/item/public_token/exchange", "body": { "type": "json", "data": "{}" } }, "docs": "Exchange a Link `public_token` for an API `access_token`. Link hands off the `public_token` client-side via the `onSuccess` callback once a user has successfully created an Item. The `public_token` is ephemeral and expires after 30 minutes. An `access_token` does not expire, but can be revoked by calling `/item/remove`.\n\nThe response also includes an `item_id` that should be stored with the `access_token`. The `item_id` is used to identify an Item in a webhook. The `item_id` can also be retrieve" }, { "info": { "name": "Plaid Create public token", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/item/public_token/create", "body": { "type": "json", "data": "{}" } }, "docs": "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).\n\nIf 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`.\n\nA `public_token` is one-time use and expires after 30 mi" }, { "info": { "name": "Plaid Import Item", "type": "http" }, "http": { "method": "POST", "url": "https://production.plaid.com/item/import", "body": { "type": "json", "data": "{}" } }, "docs": "`/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.\n\nUpon creating an Item via `/item/import`, Plaid will automatically begin an extraction of that Item through the Plaid Exchange infrastr" } ] } ], "bundled": true }