Create a bridge token

The endpoint creates a bridge token for a user.
This is typically the endpoint called before initializing the Bridge since the
response from this call is passed to the TruvBridge.init function.

Path Params
string
required
Body Params

Bridge token properties

string

Any information to associate with current user.

string
required

Indicates the type of product to use:

  • employment - Employment verification,
  • income - Income and Employment verification,
  • deposit_switch - Direct deposit switch,
  • pll - Paycheck linked lending,
  • insurance - Insurance verification,
  • transactions - Financial account aggregation,
  • assets - Assets verification,
allowed_products
array of strings

List of all allowed products for this payroll connection. If not passed, only type from the product_type field will be allowed.

allowed_products
string

A mapping ID from a company to payroll provider.

string

An ID of a data provider for direct login.

string

Access token of the existing link (used for the data refresh).

account
object

Bank account info. Used for Direct deposit switching and Paycheck linked lending

string

An ID of a customization template.

string

Use case for the connection.

boolean
Defaults to false

A boolean parameter to enable extended transaction/statement history.

string

Locale parameter for regional customization of the Bridge.

data_sources
array of strings

List of data sources for the provided product_type. Leave blank to apply default values.

data_sources
Responses

Response body
object
string
required

The bridge token

string

Any information to associate with current user.

string

Client name to be used in the Bridge.

string

Indicates the type of product to use:

  • employment - Employment verification,
  • income - Income and Employment verification,
  • deposit_switch - Direct deposit switch,
  • pll - Paycheck linked lending,
  • insurance - Insurance verification,
  • transactions - Financial account aggregation,
  • assets - Assets verification,

income employment deposit_switch pll insurance transactions assets

allowed_products
array of strings

List of all allowed products for this payroll connection. If not passed, only main type will be allowed.

allowed_products
string

A mapping ID from a company to payroll provider.

string

Access token of the existing link (used for the data refresh).

string

Unique Truv ID of the user.

string

An ID of a customization template.

data_sources
array of strings

List of data sources for the provided product_type. Leave blank to apply default values.

data_sources

Language
Credentials