643 matches
46 actions
Plaid
46 actions
Finance/Plaid
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).
{
"type": "object",
"description": "CreditSessionsGetRequest defines the request schema for `/credit/sessions/get`",
"required": [
"user_token"
],
"properties": {
"client_id": {
"type": "string",
"description": "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": {
"type": "string",
"description": "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": {
"type": "string",
"description": "The user token associated with the User data is being requested for."
}
}
}{
"type": "object",
"description": "CreditSessionsGetResponse defines the response schema for `/credit/sessions/get`",
"required": [
"request_id"
],
"properties": {
"request_id": {
"type": "string",
"description": "A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive."
},
"sessions": {
"type": "array",
"description": "A list of Link sessions for the user. Sessions will be sorted in reverse chronological order.",
"items": {
"type": "object",
"description": "Metadata and results for a Link session",
"properties": {
"errors": {
"type": "array",
"description": "The set of errors that occurred during the Link session.",
"items": {
"type": "object",
"description": "The details of a Link error.",
"properties": {
"display_message": {
"type": "string",
"description": "A user-friendly representation of the error code. `null` if the error is not related to user action."
},
"error_code": {
"type": "string",
"description": "The particular error code."
},
"error_message": {
"type": "string",
"description": "A developer-friendly representation of the error code."
},
"error_type": {
"type": "string",
"description": "A broad categorization of the error."
}
}
}
},
"link_session_id": {
"type": "string",
"description": "The unique identifier associated with the Link session. This identifier matches the `link_session_id` returned in the onSuccess/onExit callbacks."
},
"results": {
"type": "object",
"description": "The set of results for a Link session.",
"properties": {
"bank_income_results": {
"type": "array",
"description": "The set of bank income verifications for the Link session.",
"items": {
"type": "object",
"description": "The details of a bank income verification in Link",
"properties": {
"institution_id": {
"type": "string",
"description": "The Plaid Institution ID associated with the Item."
},
"item_id": {
"type": "string",
"description": "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."
},
"status": {
"type": "string",
"description": "The terminal status of the bank income verification.\n\n`APPROVED`: User has approved and verified their income\n\n`NO_DEPOSITS_FOUND`: We attempted, but were unable to find any income in the connected account.\n\n`USER_REPORTED_NO_INCOME`: The user explicitly indicated that they don't receive income in the connected account.",
"enum": [
"APPROVED",
"NO_DEPOSITS_FOUND",
"USER_REPORTED_NO_INCOME"
]
}
}
}
},
"document_income_results": {
"type": "object",
"description": "The details of a document income verification in Link",
"required": [
"num_paystubs_uploaded",
"num_w2s_uploaded"
],
"properties": {
"num_paystubs_uploaded": {
"type": "integer",
"description": "The number of paystubs uploaded by the user."
},
"num_w2s_uploaded": {
"type": "integer",
"description": "The number of w2s uploaded by the user."
}
}
},
"item_add_results": {
"type": "array",
"description": "The set of Item adds for the Link session.",
"items": {
"type": "object",
"description": "The details of an Item add in Link.",
"properties": {
"institution_id": {
"type": "string",
"description": "The Plaid Institution ID associated with the Item."
},
"item_id": {
"type": "string",
"description": "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."
},
"public_token": {
"type": "string",
"description": "Returned once a user has successfully linked their Item."
}
}
}
},
"payroll_income_results": {
"type": "array",
"description": "The set of payroll income verifications for the Link session.",
"items": {
"type": "object",
"description": "The details of a digital payroll income verification in Link",
"properties": {
"institution_id": {
"type": "string",
"description": "The Plaid Institution ID associated with the Item."
},
"institution_name": {
"type": "string",
"description": "The Institution Name associated with the Item."
},
"num_paystubs_retrieved": {
"type": "integer",
"description": "The number of paystubs retrieved from a payroll provider."
},
"num_w2s_retrieved": {
"type": "integer",
"description": "The number of w2s retrieved from a payroll provider."
}
}
}
}
}
},
"session_start_time": {
"type": "string",
"format": "date-time",
"description": "The time when the Link session started"
}
}
}
}
}
}