Learn about the endpoints supporting Links, connections to user accounts.
Overview
Links have an ID value and an access_token. Together, these retrieve data from a user's account. Exchange the public_token value during authentication while implementing Truv Bridge. Access tokens are for sensitive operations, such as generating reports.
Attributes
The values below are for Account Links.
Link Attributes
The attributes of the Link are in the table below.
Attribute | Type | Description |
---|---|---|
id | string | Unique ID of Link |
created_at | string | ISO 8601 value for when Link was created |
updated_at | string | ISO 8601 value for when Link was last updated |
tracking_info | string | Optional tracking information provided by a partner |
status | string | Status from Connection Lifecycle related to account Link |
user_external_id | bool | External ID of user provided by a partner |
provider_id | string | Data provider ID |
link_hash | string | Unique hash for user credentials when creating link |
Endpoints
The available endpoint for Account links are in the list below.
Example response
The JSON object below is an example from the Get Link
endpoint.
{
"id": "48427a36d43c4d5aa6324bc06c692456",
"created_at": "2022-06-07T15:00:00Z",
"updated_at": "2022-06-31T15:00:00Z",
"tracking_info": "user123456",
"status": "new",
"user_external_id": "user123456",
"provider_id": "adp",
"link_hash": "bc917458a3da4b2c8cc8282aa1707aaa"
}