Links have an ID value and an access_token. Together, these retrieve data from a user’s account. Exchange the public_token value during authentication while implementing Truv Bridge. Access tokens are for sensitive operations, such as generating reports.
Attributes
| Attribute | Type | Description |
|---|
| id | string | Unique ID of Link |
| created_at | string | ISO 8601 value for when Link was created |
| updated_at | string | ISO 8601 value for when Link was last updated |
| tracking_info | string | Optional tracking information provided by a partner |
| status | string | Status from Connection Lifecycle related to account Link |
| user_external_id | bool | External ID of user provided by a partner |
| provider_id | string | Data provider ID |
| link_hash | string | Unique hash for user credentials when creating link |
Example response
{
"id": "48427a36d43c4d5aa6324bc06c692456",
"created_at": "2022-06-07T15:00:00Z",
"updated_at": "2022-06-31T15:00:00Z",
"tracking_info": "user123456",
"status": "new",
"user_external_id": "user123456",
"provider_id": "adp",
"link_hash": "bc917458a3da4b2c8cc8282aa1707aaa"
}
Refresh data
Refresh data from an existing Link with the data refresh endpoints. These let the user bypass entering their payroll credentials a second time.
- [Optional] Subscribe to Webhooks for completed Tasks with
done status. Pull payroll data for the data refresh information.
- Use the Create a data refresh task endpoint with the access_token from the original connection.
- Use webhooks, the Retrieve a data refresh status endpoint, or both to check the status of the refresh.
Each data refresh Task is billed individually.
Refresh rate intervals
Truv has rate limits on each access_token value. Within a 24-hour period, only an initial request and three refreshes are allowed. The Refresh limit for the access_token exceeded error occurs for any requests outside of the interval and limit.
Data refresh task attributes
| Attribute | Type | Description |
|---|
| task_id | string | Unique ID for Link data refresh task |
Data refresh status attributes
| Attribute | Type | Description |
|---|
| id | string | Unique refresh task ID |
| created_at | string | Time when refresh task was created |
| refresh_date | string | Date of data refresh (Deprecated, invalid datetime format) |
| status | string | Data refresh task status |
Refresh example responses
Create a data refresh
{
"task_id": "48427a36d43c4d5aa6324bc06c692456"
}
{
"id": "24d7e80942ce4ad58a93f70ce4115f5c",
"created_at": "2021-04-06T11:30:00Z",
"refresh_date": "2020-03-10",
"status": "new"
}
Endpoints
