---
title: "Create a bridge token"
method: POST
path: "/v1/users/{user_id}/tokens/"
tags: ["Bridge Token"]
---

# Create a bridge token

`POST /v1/users/{user_id}/tokens/`

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.

## Request body

- ApplicantBridgeTokenCreate
  - `tracking_info` string — 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_products` string[] — List of all allowed products for this payroll connection. If not passed, only type from the product_type field will be allowed.
  - `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
    - `action` 'create' | 'update' | 'delete' — Action to be performed on the account. `update` and `delete` actions are only available for the accounts that were previously created.
    - `account_number` string, required — Account number. Only digits are allowed, leading zeros will be preserved.
    - `routing_number` string, required — Routing number. Only digits are allowed, leading zeros will be preserved.
    - `account_type` 'checking' | 'savings' — Account type. Required for the `create` action. * `checking` - Checking account, * `savings` - Savings account
    - `bank_name` string, required — Bank name. Required for the `create` action.
    - `bank_address` string — Bank address.
    - `deposit_type` 'entire' | 'percent' | 'amount' — Deposit type. For `pll` product type is required and must be set to `amount`. For `deposit_switch` product type is optional and can be set to any supported value. * `entire` - Entire paycheck, * `percent` - Percentage of the paycheck, * `amount` - Fixed amount from the paycheck
    - `deposit_value` string — Deposit value. Possible values for this field depend on the `deposit_type` field: `percent` - this field must be set to a whole number between 0 and 100. `amount` - this field must be set to a number between 0 and 9999.99. `entire` - this field must be set to `null` or be not provided.
  - `template_id` string — 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_history` boolean — 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_sources` string[] — List of data sources for the provided product_type. Leave blank to apply default values.

## Response `201`

- BridgeTokenCreateResponse — Data for the bridge token
  - `bridge_token` string, required — The bridge token
  - `tracking_info` string, nullable — Any information to associate with current user.
  - `client_name` string, 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_products` string[] — List of all allowed products for this payroll connection. If not passed, only main type will be allowed.
  - `company_mapping_id` string, nullable — A mapping ID from a company to payroll provider.
  - `access_token` string, nullable — Access token of the existing link (used for the data refresh).
  - `user_id` string — Unique Truv ID of the user.
  - `template_id` string, nullable — An ID of a customization template.
  - `data_sources` string[] — List of data sources for the provided product_type. Leave blank to apply default values.

## Other responses

- `400` — HTTP 400 Bad Request
- `401` — HTTP 401 Unauthorized
- `403` — HTTP 403 Forbidden
- `404` — HTTP 404 Not Found

---

[API](https://skmtc.net/truv/apis/truv-api.md) · [All operations](https://skmtc.net/truv/apis/truv-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/truv/truv-api/revisions/3d9b9702e0e3/schema)