Sign in

v4

OpenAPI 3.0.12026-07-3189233676.2 KB
Bridge Token

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.

post/v1/users/{user_id}/tokens/

Request body

tracking_infostring

Any information to associate with current user.

product_type'income' | 'employment' | 'deposit_switch' | 'pll' | 'insurance' | 'transactions' | 'assets' 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_productsstring[]

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

company_mapping_idstring

A mapping ID from a company to payroll provider.

provider_idstring

An ID of a data provider for direct login.

access_tokenstring

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

template_idstring

An ID of a customization template.

use_case'' | 'background_screening' | 'mortgage_lending' | 'home_equity_lending' | 'consumer_lending' | 'auto_lending' | 'tenant_screening' | 'banking' | 'government'

Use case for the connection.

request_extended_historyboolean

A boolean parameter to enable extended transaction/statement history.

locale'en' | 'ar' | 'cmn' | 'es' | 'fa' | 'hy' | 'km' | 'zh' | 'hi' | 'hmn' | 'ja' | 'ko' | 'lo' | 'ium' | 'pa' | 'pt' | 'ru' | 'so' | 'tl' | 'th' | 'uk' | 'vi'

Locale parameter (ISO 639) for regional customization of the Bridge.

data_sourcesstring[]

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

Example request

{
  "tracking_info": "any data for tracking current user",
  "product_type": "income",
  "allowed_products": [
    "income"
  ],
  "company_mapping_id": "99dd17074ac94aa9ace2621d657c7610",
  "provider_id": "adp",
  "access_token": "99dd17074ac94aa9ace2621d657c7610",
  "account": {
    "action": "create",
    "account_number": "16002600",
    "routing_number": "123456789",
    "account_type": "checking",
    "bank_name": "TD Bank",
    "bank_address": "123 Main St, New York, NY 10001",
    "deposit_type": "entire",
    "deposit_value": "50.00"
  },
  "template_id": "99dd17074ac94aa9ace2621d657c7610",
  "use_case": "mortgage_lending",
  "request_extended_history": true,
  "locale": "es",
  "data_sources": [
    "payroll"
  ]
}

Response

bridge_tokenstring required

The bridge token

tracking_infostring nullable

Any information to associate with current user.

client_namestring nullable

Client name to be used in the Bridge.

product_type'income' | 'employment' | 'deposit_switch' | 'pll' | 'insurance' | 'transactions' | 'assets' | 'credit' | 'education'

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_productsstring[]

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

company_mapping_idstring nullable

A mapping ID from a company to payroll provider.

access_tokenstring nullable

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

user_idstring

Unique Truv ID of the user.

template_idstring nullable

An ID of a customization template.

data_sourcesstring[]

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

Example response

{
  "bridge_token": "2f67984a110747d190c39e1022c81837",
  "tracking_info": "any data for tracking current user",
  "client_name": "Truv Demo",
  "product_type": "income",
  "allowed_products": [
    "income",
    "deposit_switch"
  ],
  "company_mapping_id": "99dd17074ac94aa9ace2621d657c7610",
  "access_token": "99dd17074ac94aa9ace2621d657c7610",
  "user_id": "99dd17074ac94aa9ace2621d657c7610",
  "template_id": "99dd17074ac94aa9ace2621d657c7610",
  "data_sources": [
    "payroll"
  ]
}