POST /user/third_party_token/create

This endpoint is used to create a third-party user token. This token can be shared with and used by a specified third-party client to access data associated with the user through supported endpoints.

Ensure you store the third_party_user_token along with the user_token and third_party_client_id, as it is not possible to retrieve a previously created third_party_user_token.

Servers

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
user_token String Yes

The user token associated with the User data is being requested for.

client_id String No

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.

expiration_time String No

The expiration date and time for the third-party user token in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). The expiration is restricted to a maximum of 24 hours from the token's creation time. If not provided, the token will automatically expire after 24 hours.

third_party_client_id String Yes

The Plaid API client_id of the third-party client the token will be shared with. The token will only be valid for the specified client.

secret String No

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.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.