Data Structure

Learn about Truv data structures and task flows.

The Truv API allows users to connect to a data source, like their payroll provider, and establish a persistent Link with it.

The Truv workflow starts by creating a Bridge token and a User for your customer, who will attempt to connect to one or more data providers through our Truv Bridge.

When a user attempts to connect to a data provider, a Link object is created. A new Task object is also created to start processing the requested action. Each Task goes through a lifecycle of states and ends up in one of the terminal states.

If a Task is successful, the data from a data provider can be easily consumed through one of the following endpoints:

The Link ID is unique for a combination of data source and user credentials. Each Link has a data provider ID associated with it. If the connection was successful, each Link also has an Identity associated with it, retrieved from the data provider.

Each data provider might return multiple Employment objects, which can have multiple pay statements, bank accounts, tax documents, and shifts.