plaid

Get Link Token

Changed on

The /link/token/get endpoint gets information about a Link session, including all callbacks fired during the session along with their metadata, including the public token. This endpoint is used with Link flows that don't provide a public token via frontend callbacks, such as the Hosted Link flow and the Multi-Item Link flow. It also can be useful for debugging purposes.

By default, this endpoint will only return complete event data for Hosted Link sessions. To use /link/token/get to retrieve event data for non-Hosted-Link sessions, contact your account manager to request that your account be enabled for Link events. If you do not have an account manager, you can submit this request via a support ticket. Enablement for Link events will also cause you to receive additional webhooks related to Link events, such as the SESSION_FINISHED and EVENTS webhook.

post/link/token/get

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/link/token/get
  • 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.

link_tokenstring required

A link_token from a previous invocation of /link/token/create

Response

OK

link_tokenstring required

A link_token, which can be supplied to Link in order to initialize it and receive a public_token, which can be exchanged for an access_token.

created_atstring date-time nullable required

The creation timestamp for the link_token, in ISO 8601 format.

expirationstring date-time nullable required

The expiration timestamp for the link_token, in ISO 8601 format.

user_idstring

A unique user identifier, created by /user/create. Integrations that began using /user/create after December 10, 2025 use this field to identify a user instead of the user_token. For more details, see New User APIs.

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_PARTNER_INSIGHTS_ERROR enum value to the //// response property for the response status

    • 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

    • warning

      added the new CRA_REPORT_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

    • info

      added the optional property // to the response with the status

  • e07a869352e8Revision changes
    • info

      removed the charge card enum value from the //// response property for the response status

    • info

      removed the installment enum value from the //// response property for the response status