Overview

Truv Bridge provides payload responses with user interaction data. Find information for Truv Bridge responses below.

• Callbacks - Responses for specific Truv Bridge actions
• Event data - Event type and payload descriptions
• Errors - Truv Bridge error objects, types, and codes

Callbacks

The functions in this table cover specific actions.

Event data

The sections below cover values and descriptions for events within Truv Bridge.

onEvent types

These event types are for specific actions occurring within Truv Bridge.

CommonEventData

The values in the table below are for general Truv Bridge use.

CommonEventData example response

View the JSON object sample response below for CommonEventData.

{
    "bridge_token": "b5cb1933e43043a792a9b337af5824e2",
    "product_type": "income",
    "data_source": "payroll"
}

ScreenViewData

This table has data for the Truv Bridge screen events.

{
    "view_name": "PROVIDER_LOGIN",
    "bridge_token": "b5cb1933e43043a792a9b337af5824e2",
    "product_type": "income",
    "data_source": "payroll"
}

EmployerSelectedData

This data is for events during the employer or provider selection process.

EmployerSelectedData example response

The sample JSON object below is for EmployerSelectedData.

{
    "bridge_token": "b5cb1933e43043a792a9b337af5824e2",
    "product_type": "income",
    "employer": {
        "name": "Facebook Demo"
    },
    "provider": "workday",
    "data_source": "payroll"
}

DocumentsUploadedData

The table below covers events from uploading documents.

DocumentsUploadedData example response

The JSON object below is a sample response.

{
    "bridge_token": "b5cb1933e43043a792a9b337af5824e2",
    "product_type": "income",
    "doc_type": "paystub",
    "data_source": "docs"
}

TaskData

The values in the table below cover events from Tasks.

TaskData example response

View the JSON object below for a sample response.

{
    "public_token": "d80ec8255dc54c5eb7cc03ac05d18ebd",
    "task_id": "2b0e7a7dec1d47678fec4e02af621cc0",
    "bridge_token": "b5cb1933e43043a792a9b337af5824e2",
    "product_type": "income",
    "provider_id": "adp",
    "employer": {
      "name": "Facebook Demo"
    },
    "data_source": "payroll"
}

ErrorData

Values in the table below are responses for errors.

{
    "error": {
        "error_code": "LOGIN_ERROR",
        "error_message": "Username or password is incorrect",
        "error_type": "LINK_ERROR"
    },
    "public_token": "d80ec8255dc54c5eb7cc03ac05d18ebd",
    "task_id": "5ad1938450c54024bbc967a3a7dc9020",
    "bridge_token": "b5cb1933e43043a792a9b337af5824e2",
    "product_type": "income",
    "data_source": "payroll"
}

CloseData

This value is for the Truv Bridge closing.

{
   "employer": {
        "name": "Facebook Demo"
    }
}

ManualDDSData

The table below covers events from a manual DDS operation.

{
    "depositType": "entire",
    "action": "EMAIL"
}

OAuthEventData

The table below covers events when OAuth is initiated to a financial institution's login page.

{
    "bridge_token": "b5cb1933e43043a792a9b337af5824e2",
    "product_type": "assets",
    "provider_id": "truv_bank_oauth",
    "task_id": "5ad1938450c54024bbc967a3a7dc9020",
    "url": "https://www.truv.com/oauth-login.html?provider_id=truv_bank_oauth&bridge_token=b5cb1933e43043a792a9b337af5824e2&task_id=5ad1938450c54024bbc967a3a7dc9020&token=eb18f867490347a497f36f43bec39043"
}

Errors

Below view the error codes for Truv Bridge. Truv Bridge values return as a callback.

{
    "error": {
        "error_code": "LOGIN_ERROR",
        "error_message": "Username or password is incorrect",
        "error_type": "LINK_ERROR"
    }
}

📘

Tip

Design your user experience to notify your users of login errors when connecting to payroll.

Error object

The table below contains information about the error objects.

Error types

This data is for error type values.

• LINK_ERROR - Generic error type has occurred

Error codes

These codes provide descriptions for the error.

• ERROR - Generic error occurred
• LINK_EXISTS - User's account is already connected
• LOGIN_ERROR - Incorrect username, password, or both
• MFA_ERROR - Invalid input for the multi-factor authentication
• NO_DATA - User account has no data
• UNAVAILABLE - Payroll provider is unreachable at the time of connection