Skip to main content
POST
/
v1
/
users
/
{user_id}
/
tokens
Create a Bridge Token
curl --request POST \
  --url https://api.example.com/v1/users/{user_id}/tokens/

​
Overview

This endpoint generates a bridge token required to initialize the Transcrypts Bridge widget. The token must be created before launching the user-facing integration.

​
Request

​
Endpoint

POST https://prod.transcrypts.com/v1/users/{user_id}/tokens/

​
Authentication

API authentication requires the following headers:
HeaderDescription
X-Access-Client-IdYour Client ID
X-Access-SecretYour Access Key

​
Path Parameters

ParameterTypeRequiredDescription
user_idstringYesThe unique identifier for the user

​
Request Body

​
Core Parameters

ParameterTypeRequiredDescription
product_typestringYesSpecifies product: income, employment, deposit_switch, pll, insurance, transactions, or assets

​
Optional Parameters

ParameterTypeDescription
tracking_infostringCustom data to associate with the user
client_namestringDisplay name for the Bridge interface
color_primarystringPrimary color in HEX format (e.g., #000000)
allowed_productsarrayList of permitted products; defaults to product_type only
company_mapping_idstringPre-selected company mapping ID
provider_idstringDirect login for specific data provider
access_tokenstringToken for existing link refresh operations
localestringLanguage preference (ISO 639): en, es, ar, zh, ja, ru, etc.
data_sourcesarraySpecify data source priority: payroll, docs, insurance, financial_accounts, tax

​
Account Object (for deposit_switch and pll)

FieldTypeRequiredDescription
account_numberstringYes*Account digits only; leading zeros preserved
routing_numberstringYes*Routing digits; leading zeros preserved
bank_namestringYes*Financial institution name
account_typestringYes*Either checking or savings
actionstringNoOperation: create, update, or delete
bank_addressstringNoBank location
deposit_typestringNoentire, percent, or amount
deposit_valuestringNoValue depends on deposit_type
Account fields marked with * are required when action is create.

​
Example Request

{
  "product_type": "income",
  "tracking_info": "any data for tracking current user",
  "client_name": "Transcrypts Demo",
  "allowed_products": ["income", "deposit_switch"],
  "company_mapping_id": "99dd17074ac94aa9ace2621d657c7610"
}

​
Response

​
Success Response (HTTP 201)

{
  "bridge_token": "2f67984a110747d190c39e1022c81837",
  "tracking_info": "any data for tracking current user",
  "client_name": "Transcrypts 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", "docs"]
}

​
Error Responses

Status CodeDescription
400Bad Request - Invalid or incomplete request parameters
401Unauthorized - Missing or invalid authentication credentials
403Forbidden - Insufficient permissions

​
Key Notes

  • The returned bridge_token must be passed to TranscryptsBridge.init() on the client side.
  • The product_type field determines available verification options.
  • Bank account information is only relevant for deposit switching and paycheck-linked lending workflows.
  • Locale selection enables regional customization of the user interface.