TRtruv
Data Refresh

Create a data refresh task

Changed on

The endpoint creates a link data refresh task.

post/v1/refresh/tasks/

Request

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

Request body

access_tokenstring required

Access token for a Link to payroll provider

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

Indicates the type of product to use:

  • employment - Employment verification,
  • income - Income and Employment verification,
  • deposit_switch - Direct deposit switch,
  • pll - Paycheck linked lending,
  • insurance - Insurance verification,
  • transactions - Financial account aggregation,
  • assets - Assets verification,
request_extended_historyboolean

When true, this refresh pulls the full transaction-history window (730 days) instead of the 90-day default. Applies only to refreshes of connected financial accounts. By default every refresh uses the shallow 90-day window, regardless of how much history the original connection pulled — set this flag on each refresh that needs the full window.

Example request

{
  "access_token": "48427a36d43c4d5aa6324bc06c692456",
  "account": {
    "account_number": "16002600",
    "account_type": "checking",
    "routing_number": "123456789",
    "bank_name": "TD Bank",
    "deposit_type": "entire",
    "deposit_value": "50.00"
  },
  "product_type": "income"
}

Response

task_idstring required

Unique ID for the Link data refresh task

Example response

{
  "task_id": "48427a36d43c4d5aa6324bc06c692456"
}

Changes

  • b92671dcb52dRevision changes
    • info

      added the new optional request property

  • f7c013875516Revision changes
    • warning

      the request property's maxLength was set to 32

    • warning

      the / request property's maxLength was set to 128