Skip to main content
POST
Create a Data Refresh Task

Description

This endpoint allows you to initiate a data refresh for an existing user link. The operation triggers the system to re-fetch current employment and income information from connected data sources.

Authentication

This endpoint requires API authentication:
  • Client ID (header)
  • Access Key (header)

Request Body

The request body should contain the parameters needed to specify which link to refresh and what data to update.

Response

Success Response (201 Created)

Upon successful creation, the endpoint returns a task object containing the task ID for tracking the refresh operation.

Error Responses

400 Bad Request: Returned when request parameters are invalid or missing required fields. 401 Unauthorized: Returned when authentication credentials are missing or invalid. 403 Forbidden: Returned when authentication credentials are provided but lack necessary permissions.