Create a bridge token

post https://prod.truv.com/v1/bridge-tokens/

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

The endpoint returns a bridge_token. This is typically the endpoint called before initializing Truv Bridge. The response from this call is passed to the TruvBridge.init function.

Body Params

Bridge token properties

tracking_info

string

Any information to associate with current user.

client_name

string

Client name to be used in the Bridge.

color_primary

string

Primary color for the widget in HEX format.

product_type

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

company_mapping_id

string

A mapping ID from a company to payroll provider.

provider_id

string

An ID of a data provider for direct login.

access_token

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

user

object

required

Applicant's personal info

locale

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

bridge_token

string

required

The bridge token

tracking_info

string

Any information to associate with current user.

client_name

string

Client name to be used in the Bridge.

product_type

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

company_mapping_id

string

A mapping ID from a company to payroll provider.

access_token

string

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

user_id

string

Unique Truv ID of the user.

template_id

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


xxxxxxxxxx
1
curl --request POST \
2
     --url https://prod.truv.com/v1/bridge-tokens/ \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "product_type": "income"
8
}
9
'


xxxxxxxxxx
17
 
1
{
2
  "bridge_token": "2f67984a110747d190c39e1022c81837",
3
  "tracking_info": "any data for tracking current user",
4
  "client_name": "Truv Demo",
5
  "product_type": "income",
6
  "allowed_products": [
7
    "income",
8
    "deposit_switch"
9
  ],
10
  "company_mapping_id": "99dd17074ac94aa9ace2621d657c7610",
11
  "access_token": "99dd17074ac94aa9ace2621d657c7610",
12
  "user_id": "99dd17074ac94aa9ace2621d657c7610",
13
  "template_id": "99dd17074ac94aa9ace2621d657c7610",
14
  "data_sources": [
15
    "payroll"
16
  ]
17
}

201

400HTTP 400 Bad Request

401HTTP 401 Unauthorized

403HTTP 403 Forbidden