Retrieve Link sessions for your user

POST /credit/sessions/get

This endpoint can be used for your end users after they complete the Link flow. This endpoint returns a list of Link sessions that your user completed, where each session includes the results from the Link flow.

These results include details about the Item that was created and some product related metadata (showing, for example, whether the user finished the bank income verification step).

Request Body

Required

CreditSessionsGetRequest defines the request schema for /credit/sessions/get

Parameters

client_id
string
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.
secret
string
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.
user_token
required, string
The user token associated with the User data is being requested for.

Response

CreditSessionsGetResponse defines the response schema for /credit/sessions/get

Response Properties

sessions
array[object]
A list of Link sessions for the user. Sessions will be sorted in reverse chronological order.
link_session_id
string
The unique identifier associated with the Link session. This identifier matches the link_session_id returned in the onSuccess/onExit callbacks.
session_start_time
string
The time when the Link session started
results
object
The set of results for a Link session.
item_add_results
array[object]
The set of Item adds for the Link session.
public_token
string
Returned once a user has successfully linked their Item.
item_id
string
The Plaid Item ID. The item_id is always unique; linking the same account at the same institution twice will result in two Items with different item_id values. Like all Plaid identifiers, the item_id is case-sensitive.
institution_id
string
The Plaid Institution ID associated with the Item.
bank_income_results
array[object]
The set of bank income verifications for the Link session.
status
string
Status of the Bank Income Link session. APPROVED: User has approved and verified their income NO_DEPOSITS_FOUND: We attempted, but were unable to find any income in the connected account. USER_REPORTED_NO_INCOME: The user explicitly indicated that they don’t receive income in the connected account. STARTED: The user began the bank income portion of the link flow. INTERNAL_ERROR: The user encountered an internal error.
item_id
string
The Plaid Item ID. The item_id is always unique; linking the same account at the same institution twice will result in two Items with different item_id values. Like all Plaid identifiers, the item_id is case-sensitive.
institution_id
string
The Plaid Institution ID associated with the Item.
bank_employment_results
array[object]
The set of bank employment verifications for the Link session.
status
string
Status of the Bank Employment Link session. APPROVED: User has approved and verified their employment. NO_EMPLOYMENTS_FOUND: We attempted, but were unable to find any employment in the connected account. EMPLOYER_NOT_LISTED: The user explicitly indicated that they did not see their current or previous employer in the list of employer names found. STARTED: The user began the bank income portion of the link flow. INTERNAL_ERROR: The user encountered an internal error.
item_id
string
The Plaid Item ID. The item_id is always unique; linking the same account at the same institution twice will result in two Items with different item_id values. Like all Plaid identifiers, the item_id is case-sensitive.
institution_id
string
The Plaid Institution ID associated with the Item.
payroll_income_results
array[object]
The set of payroll income verifications for the Link session.
num_paystubs_retrieved
integer
The number of paystubs retrieved from a payroll provider.
num_w2s_retrieved
integer
The number of w2s retrieved from a payroll provider.
institution_id
string
The Plaid Institution ID associated with the Item.
institution_name
string
The Institution Name associated with the Item.
document_income_results
object
The details of a document income verification in Link
num_paystubs_uploaded
required, integer
The number of paystubs uploaded by the user.
num_w2s_uploaded
required, integer
The number of w2s uploaded by the user.
num_bank_statements_uploaded
required, integer
The number of bank statements uploaded by the user.
num_1099s_uploaded
required, integer
The number of 1099s uploaded by the user
errors
array[object]
The set of errors that occurred during the Link session.
error_type
string
A broad categorization of the error.
error_code
string
The particular error code.
error_message
string
A developer-friendly representation of the error code.
display_message
string
A user-friendly representation of the error code. null if the error is not related to user action.
request_id
required, string
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.