Sign in

v4

latestOpenAPI 3.0.12026-07-3189233676.2 KB
Data Refresh

Create a data refresh task

The endpoint creates a link data refresh task.

post/v1/refresh/tasks/

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,

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