TRtruv
Account Links

Retrieve a link

Changed on
get/v1/links/{link_id}/

Request

  • Base URL
    https://prod.truv.com
  • URL
    https://prod.truv.com/v1/links/{link_id}/
  • Auth
    API key in header X-Access-Client-Id and API key in header X-Access-Secret

Query parameters

show_fraud_reasonsboolean

Set to true to include fraud_reasons in the response. The field is omitted by default.

Response

idstring

Link ID

access_tokenstring

Access token for data refresh. Returns masked value (e.g., ****************************7610) unless filtered by user_id, in which case the full token is returned.

created_atstring

Link creation timestamp (ISO 8601)

updated_atstring

Link last update timestamp (ISO 8601)

deleted_atstring nullable

Link removal timestamp (ISO 8601)

tracking_infostring nullable

Optional tracking information provided by a partner

statusstring

Status of the last Task

user_external_idstring nullable

User external ID is information provided by a partner

provider_idstring

Data provider ID

link_hashstring nullable

Unique hash for the user credentials used to create the link

allowed_productsstring[]

List of all allowed products for this connection

initial_product_type'income' | 'employment' | 'deposit_switch' | 'pll' | 'insurance' | 'transactions' | 'assets' | 'credit' | 'education' | 'null' nullable

Initial product type

data_source'payroll' | 'docs' | 'insurance' | 'financial_accounts' | 'tax' | 'scoring_attributes' | 'credit' | 'education'

Source of data: payroll - payroll provider parsing, docs - user uploaded documents, insurance - insurance data, financial_accounts - bank data, tax - tax documents, scoring_attributes - transactions scoring attributes report.

is_suspiciousboolean

Flag to indicate if the data from the source is suspicious. E.g. fraud detected in uploaded documents or SSN of the user does not match with the data

is_dds_availableboolean nullable

This flag indicates if connected account supports deposit switching functionality. null - unknown, True - yes, False - No

Example response

{
  "id": "48427a36d43c4d5aa6324bc06c692456",
  "access_token": "****************************7610",
  "created_at": "2022-06-07T15:00:00Z",
  "updated_at": "2022-06-30T15:00:00Z",
  "deleted_at": "2022-06-30T15:00:00Z",
  "tracking_info": "user123456",
  "status": "new",
  "user_external_id": "user123456",
  "provider_id": "adp",
  "provider": {
    "id": "adp",
    "name": "ADP"
  },
  "company_mapping": {
    "id": "meta",
    "name": "Meta"
  },
  "link_hash": "bc917458a3da4b2c8cc8282aa1707aaa",
  "allowed_products": [
    "income"
  ],
  "initial_product_type": "income",
  "data_source": "payroll",
  "fraud_reasons": [
    {
      "code": "editing_software_detected",
      "message": "Document metadata identifies editing software.",
      "severity": "high",
      "document_ids": [
        "d1f3a6e0b1c24f6c9b3e2a7d5c8e9f01"
      ],
      "uploaded_file_ids": [
        "9ac0b2d4e6f84a1c8e3b5d7f9a1c3e5b"
      ],
      "details": {
        "software": [
          "Adobe Photoshop 25.0 (Windows)"
        ]
      },
      "task_id": "48427a36d43c4d5aa6324bc06c692456",
      "created_at": "2026-10-20T14:03:11Z"
    }
  ]
}

Changes

  • 64de38c55f45Revision changes
    • info

      added the new optional query request parameter show_fraud_reasons

    • info

      added the optional property to the response with the status

  • e58688835e25Revision changes
    • breaking

      the / response property's maxLength was increased from 128 to 255 for the response status

    • warning

      added the new credit enum value to the / response property for the response status

    • warning

      added the new credit enum value to the response property for the response status

    • warning

      added the new credit enum value to the response property for the response status

    • warning

      added the new education enum value to the / response property for the response status

    • warning

      added the new education enum value to the response property for the response status

    • warning

      added the new education enum value to the response property for the response status