plaid

Retrieve Link sessions for your user

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).

post/credit/sessions/get

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.

user_tokenstring

The user token associated with the user for which data is being requested. This field is used only by customers with pre-existing integrations that already use the user_token field. All other customers should use the user_id instead. For more details, see New User APIs.

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.

Response

OK

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

Changed in 8 of the 52 revisions of this API.12010

  • e536704a333f111See the full diff
    • the user_id request property type/format changed from / to string/

      request-property-type-changed

    • removed NewUserID from the user_id request property allOf list

      request-property-all-of-removed

    • the request property user_token became optional

      request-property-became-optional

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new optional request property user_id

      new-optional-request-property

  • a1bbca018160131See the full diff
    • added the new ASSETS_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new CRA_MONITORING_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new CREDIT_PROFILE_REPORT_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new ENCOMPASS_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new ENRICH_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new FRAUD_INSIGHTS_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new FREDDIE_MAC_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new LINK_DELIVERY_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new PROFILE_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new RECURRING_TRANSACTIONS_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new STATEMENTS_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new TRANSFER_RECURRING_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new TRANSFER_REFUND_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the required property sessions/items/results/document_income_results/num_i20s_uploaded to the response with the 200 status

      response-required-property-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new IDEMPOTENCY_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new BASE_REPORT_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new INTERNAL_ERROR enum value to the sessions/items/results/bank_employment_results/items/status response property for the response status 200

      response-property-enum-value-added

    • added the new INTERNAL_ERROR enum value to the sessions/items/results/bank_income_results/items/status response property for the response status 200

      response-property-enum-value-added

    • added the new STARTED enum value to the sessions/items/results/bank_employment_results/items/status response property for the response status 200

      response-property-enum-value-added

    • added the new STARTED enum value to the sessions/items/results/bank_income_results/items/status response property for the response status 200

      response-property-enum-value-added

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the optional property provided_account_subtypes to the response with the default status

      response-optional-property-added

    • added the optional property required_account_subtypes to the response with the default status

      response-optional-property-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • removed the IDENTITY_ERROR enum value from the error_type response property for the response status default

      response-property-enum-value-removed

    • removed the INTERNAL_ERROR enum value from the sessions/items/results/bank_employment_results/items/status response property for the response status 200

      response-property-enum-value-removed

    • removed the INTERNAL_ERROR enum value from the sessions/items/results/bank_income_results/items/status response property for the response status 200

      response-property-enum-value-removed

    • removed the STARTED enum value from the sessions/items/results/bank_employment_results/items/status response property for the response status 200

      response-property-enum-value-removed

    • removed the STARTED enum value from the sessions/items/results/bank_income_results/items/status response property for the response status 200

      response-property-enum-value-removed

    This revision also has 699 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog