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).
Request body
Response
OK
Changes
Changed in 8 of the 52 revisions of this API.12010
- ▲
the
user_idrequest property type/format changed from/tostring/request-property-type-changed
- ●
removed
NewUserIDfrom theuser_idrequest propertyallOflistrequest-property-all-of-removed
- ○
the request property
user_tokenbecame optionalrequest-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_idnew-optional-request-property
- ○
- ●
added the new
ASSETS_ERRORenum value to theerror_typeresponse property for the response statusdefaultresponse-property-enum-value-added
- ●
added the new
CRA_MONITORING_ERRORenum value to theerror_typeresponse property for the response statusdefaultresponse-property-enum-value-added
- ●
added the new
CREDIT_PROFILE_REPORT_ERRORenum value to theerror_typeresponse property for the response statusdefaultresponse-property-enum-value-added
- ●
added the new
ENCOMPASS_ERRORenum value to theerror_typeresponse property for the response statusdefaultresponse-property-enum-value-added
- ●
added the new
ENRICH_ERRORenum value to theerror_typeresponse property for the response statusdefaultresponse-property-enum-value-added
- ●
added the new
FRAUD_INSIGHTS_ERRORenum value to theerror_typeresponse property for the response statusdefaultresponse-property-enum-value-added
- ●
added the new
FREDDIE_MAC_ERRORenum value to theerror_typeresponse property for the response statusdefaultresponse-property-enum-value-added
- ●
added the new
LINK_DELIVERY_ERRORenum value to theerror_typeresponse property for the response statusdefaultresponse-property-enum-value-added
- ●
added the new
PROFILE_ERRORenum value to theerror_typeresponse property for the response statusdefaultresponse-property-enum-value-added
- ●
added the new
RECURRING_TRANSACTIONS_ERRORenum value to theerror_typeresponse property for the response statusdefaultresponse-property-enum-value-added
- ●
added the new
STATEMENTS_ERRORenum value to theerror_typeresponse property for the response statusdefaultresponse-property-enum-value-added
- ●
added the new
TRANSFER_RECURRING_ERRORenum value to theerror_typeresponse property for the response statusdefaultresponse-property-enum-value-added
- ●
added the new
TRANSFER_REFUND_ERRORenum value to theerror_typeresponse property for the response statusdefaultresponse-property-enum-value-added
- ○
added the required property
sessions/items/results/document_income_results/num_i20s_uploadedto the response with the200statusresponse-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_ERRORenum value to theerror_typeresponse property for the response statusdefaultresponse-property-enum-value-added
- ●
- ●
added the new
BASE_REPORT_ERRORenum value to theerror_typeresponse property for the response statusdefaultresponse-property-enum-value-added
- ●
added the new
INTERNAL_ERRORenum value to thesessions/items/results/bank_employment_results/items/statusresponse property for the response status200response-property-enum-value-added
- ●
added the new
INTERNAL_ERRORenum value to thesessions/items/results/bank_income_results/items/statusresponse property for the response status200response-property-enum-value-added
- ●
added the new
STARTEDenum value to thesessions/items/results/bank_employment_results/items/statusresponse property for the response status200response-property-enum-value-added
- ●
added the new
STARTEDenum value to thesessions/items/results/bank_income_results/items/statusresponse property for the response status200response-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_subtypesto the response with thedefaultstatusresponse-optional-property-added
- ○
added the optional property
required_account_subtypesto the response with thedefaultstatusresponse-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_ERRORenum value from theerror_typeresponse property for the response statusdefaultresponse-property-enum-value-removed
- ○
- ○
removed the
INTERNAL_ERRORenum value from thesessions/items/results/bank_employment_results/items/statusresponse property for the response status200response-property-enum-value-removed
- ○
removed the
INTERNAL_ERRORenum value from thesessions/items/results/bank_income_results/items/statusresponse property for the response status200response-property-enum-value-removed
- ○
removed the
STARTEDenum value from thesessions/items/results/bank_employment_results/items/statusresponse property for the response status200response-property-enum-value-removed
- ○
removed the
STARTEDenum value from thesessions/items/results/bank_income_results/items/statusresponse property for the response status200response-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
- ○