POST /item/public_token/exchange
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
.
The 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 retrieved by making an /item/get
request.
Servers
- https://production.plaid.com
- https://sandbox.plaid.com
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
client_id |
String | No |
Your Plaid API |
public_token |
String | Yes |
Your |
secret |
String | No |
Your Plaid API |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.