Manage users and user tokens for Truv Bridge with the Users endpoint.
Attributes
User objects represent distinct users that would connect their accounts via Truv Bridge.
User Attributes
| Attribute | Type | Description |
|---|---|---|
| id | string | Unique ID of user |
| external_user_id | string | External user ID |
| first_name | string | First name* |
| last_name | string | Last name* |
| string | User email | |
| phone | string | User phone number |
| ssn | string | User SSN |
| created_at | datetime | Timestamp when user was created |
| updated_at | datetime | Timestamp when user was last updated |
Note*
Users and applicants require both
first_nameandlast_namevalues when testing for Integrating Document Processing.
Endpoints
The list below contains available endpoints for user management.
Example response
View the example object from the Create User endpoint 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"
}
User bridge token
A User bridge token is a temporary value required for loading Truv Bridge for a specific user.
Bridge token attributes
The attributes of the Bridge Token are below.
| Attribute | Type | Description |
|---|---|---|
| bridge_token | string | Unique ID of Bridge Token |
| tracking_info | string | Information to associate with current user |
| client_name | string | Client name for Truv Bridge |
| product_type | string | Indicates main product type |
| allowed_products | array | List of allowed products for account, only main type allowed if not included |
| company_mapping_id | string | Company ID to skip search step, see Deeplinking |
| access_token | string | Access token of existing Link, used for data refresh |
Endpoints
Below is the available endpoint for user tokens.
Example response
The example object below is from the Create Bridge Token endpoint.
{
"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"
}