v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-313352,3122.9 MB

plaid

Get Hosted Link session

Use the /link_delivery/get endpoint to get the status of a Hosted Link session.

post/link_delivery/get

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_delivery_session_idstring required

The ID for the Hosted Link session from a previous invocation of /link_delivery/create.

status'CREATED' | 'OPENED' | 'EXITED' | 'COMPLETED' | 'EXPIRED' required

The status of the given Hosted Link session.

CREATED: The session is created but not yet accessed by the user

OPENED: The session is opened by the user but not yet completed

EXITED: The session has been exited by the user

COMPLETED: The session has been completed by the user

EXPIRED: The session has expired

created_atstring date-time required

Timestamp in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ) indicating the time the given Hosted Link session was created at.

completed_atstring date-time nullable

Timestamp in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ) indicating the time the given Hosted Link session was completed at.

request_idstring required

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

access_tokensAccessToken[] nullable

An array of access tokens associated with the Hosted Link session.

item_idsItemId[] nullable

An array of item_ids associated with the Hosted Link session.