Implementing Truv Bridge

Truv Bridge is the client-side component and module for users to connect accounts.


Truv Bridge is a drop-in module for your users to connect their accounts to Truv. This allows you to access their data using Truv's API. Truv Bridge handles employer search, credentials, multi-factor authentication, and error handling.

Use the Quickstart guide to learn about Truv Bridge and start implementing Truv in your workflow.

Summary of sequence diagram

The diagram below shows the overview of token and data exchanges. The sequence covers your application, Truv Bridge, your server and backend, as well as the Truv API. View the Steps section to get started.

  1. Request a bridge_token value from your backend.
  2. On your backend server, create a user and request a bridge token from Truv's API.
  3. Initialize Truv Bridge in your application and pass the bridge_token to TruvBridge.init.
  4. When a user successfully connects their account, it generates a public_token. Truv Bridge hands off the public_token to the client through the onSuccess or onEvent callback.
  5. After the connection status changes, webhook events begin to arrive.
  6. Exchange the temporary public_token for a permanent access_token.
  7. Make an API request to Truv to get the data.


Integrate Truv Bridge after you've collected your Client ID and Access secret values.

Truv Bridge handles credential validation, multi-factor authentication, and error handling for each supported integration. Use the steps below to get started.

  1. Load the bridge.js library file from Truv, see the Embedding Truv Bridge section below.
  2. Create a user on your backend server, then request a Bridge Token from the API.
  3. Initialize Truv Bridge with TruvBridge.init and use the bridge_token value as a parameter.

Embedding Truv Bridge

Use Truv's SDKs to embed Truv Bridge in mobile, web apps, or both. The Javascript code below also works as a separate example.

    <!-- Step 1 - add the Bridge library to your app with a script tag -->
    <script src=""></script>
  // Step 2 - Call your back end to retrieve a bridge_token from truv
  const bridgeToken = <%= Value returned by API call to acquire bridge_token %>

  // Step 3 - Initialize Bridge
  const bridge = TruvBridge.init({
        bridgeToken: bridgeToken.bridge_token,
          // Optional, called when Bridge loads
          console.log('Bridge loaded')
        onSuccess:function(public_token, metadata){
          console.log('success handler')
          // Send the public_token to your server to exchange for an access_token
          // and retrieve payroll data.
          // The metadata object contains info about the Link.
          console.log("token: ", public_token)
          console.log("metadata: ", metadata)
        onEvent: function(event_type, payload) {
          // all events fire this function. event_type indicates what the event is,
          // payload has additional information depending on the event.
          console.log('event: ', event_type)
          console.log('payload: ', payload)
          // Optional, called when Bridge is closed by the user.
          console.log('Bridge closed')
<!-- Normal page content -->
<!-- Step 4 - Create a button or action that calls to Bridge -->
<button type="button" id="button" onclick="">


Truv Bridge is for authorized environments only. Confirm your application's request with your Client ID and Access secret values for security. Initialize Truv Bridge with the valid bridge_token value for TruvBridge.init to continue.


The table covers the required parameter for Truv Bridge.

bridgeTokenReturned bridge_token value from Create Bridge Token endpointrequired


The functions in this table cover specific actions.

onSuccessUser has successfully connected to a payroll provider and closed Bridge, function expects two arguments, the public_token and a metadata objectrequired
onLoadTruv Bridge has finished loadingoptional
onEventSpecific event occurs with Truv Bridge, see Event Reference for Truv Bridgeoptional
onCloseTruv Bridge closesoptional

Closing Truv Bridge

Close Truv Bridge programmatically with the close method. This is from the Truv Bridge instance returned by init function.

The default behavior for Truv Bridge to close is with user input.

// call close method of the bridge instance

What’s Next

Learn more about Truv Bridge and how it works within your integration.