Get an item's refresh status

get https://api.bridgeapi.io/v2/items/{id}/refresh/status

Retrieve the refresh status of an item.

📘
User resource
This resource is only accessible when a user is logged in.

ITEM STATUS JSON

Field	Description
`status` string	Item's refresh status.
`mfa` mfa object	Information to display to the client when the bank requires a Strong Customer Authentication (SCA). This information is only available when the `status` is `info_required`. See object definition below.
`refreshed_at` timestamp	Timestamp recording when the item was refreshed.
`refreshed_accounts_count` integer	Count how many accounts of the item have been refreshed. This information is only available when the `status` is `retreiving_data`.
`total_accounts_count` integer	Count the total number of accounts in the item. This information is only available when the `status` is `retreiving_data`.

MFA JSON


`type` string	The MFA type can be a One Time Password (`SMS`) or an App to App validation (`APP_TO_APP`). By default the value is `null`.
`description` string	Message to display to the user.
`label` string	Message to display to the user by default if we don't have the `description` from the bank.
`is_numeric` boolean	True if the OTP is numeric (0-9) only.

LIST OF REFRESH STATUS

Status	Description
`authenticating`	The item is connecting to the bank.
`retrieving_data`	`refreshed_accounts_count` and `total_accounts_count` will indicate the progression of the refresh.
`info_required`	Connector requires a One Time Password (OTP) or an app to app validation.
`finished`	Refresh process is done. All data are up to date and available.
`invalid_creds`	Provided credentials are invalid. Corresponding's item status is 402.
`finished_error`	An error occurred while refreshing the item. Check its status (429, 1003, ...).

Language

Credentials