Refresh Products
Refresh Products
Requests an update of the provided products for the link.
This is an asynchronous operation. The response will be a 202 Accepted if the request was successful.
Refreshes are subject to rate limiting.
Rate Limiting
- 1 refresh per link per hour for account data
- 1 refresh per link per hour for transaction data
- 1 refresh per link per day for account numbers
- 1 refresh per link per day for identity data
URL
Request
Response
products
: array
required
A list of at least one product to refresh.
example: account_numbers
example: transactions
Allowed values:
"accounts"
"account_numbers"
"identity"
"transactions"
"investments"
"enrichment"
id
: string
required
The unique ID for this link.
example: mk_eqkWN34UEoa2NxyALG8pcV
Responses
202
Successful Response
link_id
: string
required
The unique ID for this link.
example: mk_eqkWN34UEoa2NxyALG8pcV
institution_id
: string
required
The unique ID for the institution this link is connected to.
example: chase
institution_name
: string
required
The institution name this link is connected to.
example: Chase
institution_avatar
: string
required
An avatar image for the link's institution.
example: https://example.com/avatar.png
state
: string
required
The current state of this link. Links that are not yet connected, or which require reconnection, will be in one of the non-connected states.
connecting
awaiting_token_exchange
connected
deleted
error
example: connected
Allowed values:
"connecting"
"awaiting_token_exchange"
"connected"
"deleted"
"error"
error_code
: string
required
The type of error, if the link is in the error
state. See Errors for an explanation of error codes.
system_error
provider_error
institution_error
user_error
auth_expired
incomplete
Allowed values:
"system_error"
"provider_error"
"institution_error"
"user_error"
"auth_expired"
"incomplete"
last_synced_at
: string
required
deprecated
(Deprecated) An ISO-8601 timestamp indicating the last time that the link was updated.
format:
date-time
example: 2023-02-16T09:14:11
tags
: array
required
Arbitrary strings used to describe this link.
example: smoke_test
example: user_type:admin
example: user_type:admin
products
: object
required
The granted products available for this link.
available_products
: array
required
A list of products that could be added to this link.
Products can be added to (and removed from) an existing link by creating a new /link-session
and supplying the existing_link_id
with a new set of products.
example: account_numbers
Allowed values:
"accounts"
"account_numbers"
"identity"
"transactions"
"investments"
"enrichment"
401
Invalid access_token or insufficent API client scope or unauthorized link access.
403
Forbidden by link owner. The user did not give permission to access this data when linking.
error_code
: string
required
link_error.forbidden_action
default: "link_error.forbidden_action"
Allowed values:
"link_error.forbidden_action"
error_message
: string
required
Error message
example: Accounts access not permitted
documentation_url
: string
required
404
Link not found.
error_code
: string
required
link_error.not_found
default: "link_error.not_found"
Allowed values:
"link_error.not_found"
error_message
: string
required
default: "Link not found."
documentation_url
: string
required
410
Link deleted.
error_code
: string
required
link_error.deleted
default: "link_error.deleted"
Allowed values:
"link_error.deleted"
error_message
: string
required
default: "Link deleted."
documentation_url
: string
required
422
Link error.
error_code
: string
required
link_error.bad_state
default: "link_error.bad_state"
Allowed values:
"link_error.bad_state"
error_message
: string
required
documentation_url
: string
required
link_error_code
: string
required
429
Rate limit exceeded.
error_code
: string
required
api_error.rate_limit_exceeded
default: "api_error.rate_limit_exceeded"
Allowed values:
"api_error.rate_limit_exceeded"
error_message
: string
required
Error message
default: "Rate limit exceeded"
documentation_url
: string
required