Sign in

v4

OpenAPI 3.0.12026-07-3189233676.2 KB
Tasks

Retrieve a task

The endpoint returns a Task.

get/v1/tasks/{id}/

Response

idstring required

Unique task identifier

status'done' | 'error' | 'login_error' | 'account_locked' | 'mfa_error' | 'config_error' | 'no_data' | 'unavailable' | 'unable_to_reset' | 'not_supported' required

Current task status

product_type'income' | 'employment' | 'deposit_switch' | 'pll' | 'insurance' | 'transactions' | 'assets' required

Type of data product being processed

created_atstring date-time required

Task creation timestamp (ISO 8601)

updated_atstring date-time required

Task last update timestamp (ISO 8601)

error_messagestring nullable

Error details if task failed

tracking_infostring nullable

Optional tracking information provided by partner

bridge_tokenstring nullable

Bridge token used for authentication

data_source'payroll' | 'docs' | 'insurance' | 'financial_accounts' | 'tax'

Source of the data collection

link_idstring required

ID of the associated link (connection)

is_suspiciousboolean

Whether the task or link is flagged as suspicious

user_idstring required

ID of the user associated with this task

order_idstring nullable

ID of the order associated with this task

Example response

{
  "id": "48427a36d43c4d5aa6324bc06c692456",
  "status": "done",
  "product_type": "income",
  "provider": {
    "id": "adp",
    "name": "ADP",
    "logo_url": "https://cdn.truv.com/providers/adp.svg"
  },
  "created_at": "2022-06-07T15:00:00Z",
  "updated_at": "2022-06-07T15:30:00Z",
  "error_message": "Invalid credentials provided",
  "tracking_info": "0c8d444ff53947cd822efca7b3d9ef18",
  "bridge_token": "2f67984a110747d190c39e1022c81837",
  "data_source": "financial_accounts",
  "link_id": "48427a36d43c4d5aa6324bc06c692456",
  "user_id": "48427a36d43c4d5aa6324bc06c692456",
  "order_id": "48427a36d43c4d5aa6324bc06c692456"
}