Skip to main content

Documentation Index

Fetch the complete documentation index at: https://truv.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

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

AttributeTypeDescription
idstringUnique ID of Link
created_atstringISO 8601 value for when Link was created
updated_atstringISO 8601 value for when Link was last updated
tracking_infostringOptional tracking information provided by a partner
statusstringStatus from Connection Lifecycle related to account Link
user_external_idboolExternal ID of user provided by a partner
provider_idstringData provider ID
link_hashstringUnique 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.

​
Perform a data refresh

  1. [Optional] Subscribe to Webhooks for completed Tasks with done status. Pull payroll data for the data refresh information.
  2. Use the Create a data refresh task endpoint with the access_token from the original connection.
  3. 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

AttributeTypeDescription
task_idstringUnique ID for Link data refresh task

​
Data refresh status attributes

AttributeTypeDescription
idstringUnique refresh task ID
created_atstringTime when refresh task was created
refresh_datestringDate of data refresh (Deprecated, invalid datetime format)
statusstringData refresh task status

​
Refresh example responses

Create a data refresh 
{
  "task_id": "48427a36d43c4d5aa6324bc06c692456"
}
Retrieve a data refresh 
{
  "id": "24d7e80942ce4ad58a93f70ce4115f5c",
  "created_at": "2021-04-06T11:30:00Z",
  "refresh_date": "2020-03-10",
  "status": "new"
}

​
Endpoints