Sign in

v4

latestOpenAPI 3.0.12026-07-3189233676.2 KB
Data Refresh

Retrieve a data refresh status

The endpoint returns the refresh task status.

get/v1/refresh/tasks/{task_id}/

Response

idstring required

Unique refresh task ID

created_atstring

Time when refresh task was created

refresh_datestring date required

Date of the data refresh (Deprecated, invalid datetime format)

status'new' | 'login' | 'mfa' | 'parse' | 'full_parse' | 'switch_deposit' | 'session_expired' | 'done' | 'error' | 'login_error' | 'account_locked' | 'mfa_error' | 'config_error' | 'no_data' | 'unavailable' | 'unable_to_reset' | 'not_supported' required

Refresh task status. Includes in-progress statuses (new, login, mfa, parse, full_parse, switch_deposit, session_expired) that appear while the refresh is still running, and the terminal statuses shared with tasks.

Example response

{
  "id": "24d7e80942ce4ad58a93f70ce4115f5c",
  "created_at": "2021-04-06T11:30:00Z",
  "refresh_date": "2020-03-10",
  "status": "new"
}