The Links object - MyTruv

A Link represents a persistent connection to a user’s financial institution or payroll provider. Links have an ID and track the connection status, provider details, and allowed products.

Attributes

Attribute	Type	Description
id	string	Unique ID of the Link
created_at	string	ISO 8601 timestamp when Link was created
updated_at	string	ISO 8601 timestamp when Link was last updated
deleted_at	string	ISO 8601 timestamp when Link was deleted (if applicable)
tracking_info	string	Optional tracking information
status	string	Connection status
user_external_id	string	External ID of user
provider_id	string	Data provider ID
provider	object	Provider details (id, name, logo_url)
link_hash	string	Unique hash for user credentials
allowed_products	array of strings	Products enabled for this Link
initial_product_type	string	Product type used when creating the Link
data_source	string	Data source type (`payroll`, `financial_accounts`, etc.)

List response attributes

Attribute	Type	Description
count	integer	Total number of links
next	string	URL to next page (`null` if last page)
previous	string	URL to previous page (`null` if first page)
results	array of objects	Link records

Endpoints

List all links

Example response

{
  "count": 2,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": "48427a36d43c4d5aa6324bc06c692456",
      "created_at": "2022-06-07T15:00:00Z",
      "updated_at": "2022-06-07T15:00:00Z",
      "status": "new",
      "provider_id": "chase",
      "provider": {
        "id": "chase",
        "name": "Chase",
        "logo_url": "https://cdn.mytruv.com/providers/chase.png"
      },
      "link_hash": "bc917458a3da4b2c8cc8282aa1707aaa",
      "data_source": "financial_accounts",
      "allowed_products": ["income", "transactions"]
    }
  ]
}

⌘I