Data Structure

Learn about Truv data structures and task flows.

Overview

The Truv API allows users to connect to a data source such as payroll provider, and create a Link to manage data.

Truv starts the workflow by creating a Bridge token and a user for your customer. Users then attempt to connect to one or more data providers through Truv Bridge.

Connecting to providers

When users attempt to connect to a data provider, it generates a Link object. From there, a new Task object then starts processing the requested action. Each Task goes through the connection lifecycle of stages. Each state proceeds to the next with specific status updates.

For successful Tasks, manage data from a data provider through one of the following endpoints.

Link ID values are a combination of data source and user credentials. Each Link has a data provider ID associated with it. With successful connections, each Link also has an Identity associated with it, retrieved from the data provider.

Multiple employment object responses are available from data providers as well. This occurs from user accounts which may have multiple pay statements, bank accounts, tax documents, and shifts.