TRtruv
Data Refresh

Retrieve a data refresh status

Changed on

The endpoint returns the refresh task status.

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

Request

  • Base URL
    https://prod.truv.com
  • URL
    https://prod.truv.com/v1/refresh/tasks/{task_id}/
  • Auth
    API key in header X-Access-Client-Id and API key in header X-Access-Secret

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' | '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) 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"
}

Changes

  • 85952cfcaa91Revision changes
    • info

      removed the session_expired enum value from the response property for the response status

  • f7c013875516Revision changes
    • warning

      added the new account_locked enum value to the response property for the response status

    • warning

      added the new config_error enum value to the response property for the response status

    • warning

      added the new done enum value to the response property for the response status

    • warning

      added the new error enum value to the response property for the response status

    • warning

      added the new full_parse enum value to the response property for the response status

    • warning

      added the new login enum value to the response property for the response status

    • warning

      added the new login_error enum value to the response property for the response status

    • warning

      added the new mfa enum value to the response property for the response status

    • warning

      added the new mfa_error enum value to the response property for the response status

    • warning

      added the new new enum value to the response property for the response status

    • warning

      added the new no_data enum value to the response property for the response status

    • warning

      added the new not_supported enum value to the response property for the response status

    • warning

      added the new parse enum value to the response property for the response status

    • warning

      added the new session_expired enum value to the response property for the response status

    • warning

      added the new switch_deposit enum value to the response property for the response status

    • warning

      added the new unable_to_reset enum value to the response property for the response status

    • warning

      added the new unavailable enum value to the response property for the response status