Skip to main content
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

AttributeTypeDescription
idstringUnique ID of the Link
created_atstringISO 8601 timestamp when Link was created
updated_atstringISO 8601 timestamp when Link was last updated
deleted_atstringISO 8601 timestamp when Link was deleted (if applicable)
tracking_infostringOptional tracking information
statusstringConnection status
user_external_idstringExternal ID of user
provider_idstringData provider ID
providerobjectProvider details (id, name, logo_url)
link_hashstringUnique hash for user credentials
allowed_productsarray of stringsProducts enabled for this Link
initial_product_typestringProduct type used when creating the Link
data_sourcestringData source type (payroll, financial_accounts, etc.)

​
List response attributes

AttributeTypeDescription
countintegerTotal number of links
nextstringURL to next page (null if last page)
previousstringURL to previous page (null if first page)
resultsarray of objectsLink records

​
Endpoints

​
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"]
    }
  ]
}