TRtruv
Account Links

List all links

Changed on
get/v1/links/

Request

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

Query parameters

user_idstring
pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

show_fraud_reasonsboolean

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

Response

countinteger required

Number of Links to return

nextstring nullable required

Url to the next page

previousstring nullable required

Url to the previous page

Example response

{
  "count": 100,
  "next": "https://prod.truv.com/v1/links?page=1",
  "previous": "https://prod.truv.com/v1/links?page=1",
  "results": [
    {
      "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