Users

Learn how to manage users and user tokens for the Truv Bridge via API.

User objects represent distinct users that would connect their accounts via Truv Bridge.

User Attributes

Attribute	Type	Description
id	string	Unique ID of the user
external_user_id	string	External user id
first_name	string	First name of the user
last_name	string	Last name of the user
email	string	User's email
phone	string	User's phone number
ssn	string	User's SSN
created_at	datetime	Timestamp when the user was created
updated_at	datetime	Timestamp when the user was updated last time

Endpoints

Below is the available endpoint list for user management:

Endpoint
List all users - GET /users/
Create a user - POST /users/
Retrieve a user - GET /users/{user_id}/
Update a user - PATCH /users/{user_id}/
Delete a user - DELETE /users/{user_id}/

Sample Object

The example object returned by the Create User endpoint is shown below.

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "external_user_id": "12345",
  "first_name": "John",
  "last_name": "Doe",
  "email": "[email protected]",
  "phone": "+14155554193",
  "ssn": "222233333",
  "created_at": "2022-05-04T11:30:00Z",
  "updated_at": "2022-05-04T12:00:00Z"
}

A user bridge token is a short-lived token that is required to load Truv Bridge for a specific user.

Bridge Token Attributes

The attributes of the Bridge Token are shown below.

Attribute	Type	Description
bridge_token	string	Unique ID of the Bridge Token
tracking_info	string	Any information to associate with a current user
product_type	string	Indicates the main type of product to use
allowed_products	array	List of all allowed products for this account. If not passed, only the main type will be allowed.
company_mapping_id	string	A Company ID to skip the search step
access_token	string	Access token of the existing Link (used for the data refresh).

Endpoints

Below is the available endpoint for user tokens:

Endpoint
Create Bridge Token - POST /users/{user_id}/tokens/

Sample Object

The example object returned by the Create Bridge Token endpoint is shown below.

{
  "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"
}