Deposit Switch Reports

Retrieve a paycheck linked loan report

Changed on

The endpoint returns the PLL report.

get/v1/links/{link_id}/pll/report/

Request

  • Base URL
    https://prod.truv.com
  • URL
    https://prod.truv.com/v1/links/{link_id}/pll/report/
  • 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 required

Unique ID

statusstring required
finished_atstring

Time when report was finished

completed_atstring required

Time when report was completed (Deprecated, invalid datetime format)

access_tokenstring required

Access token for a Link to payroll provider

tracking_infostring nullable required

Any information passed to the Truv Bridge from a partner

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

pdf_reportstring uri

URL that points to the PDF file containing the report

Example response

{
  "id": "24d7e80942ce4ad58a93f70ce4115f5c",
  "status": "new",
  "finished_at": "2021-04-06T11:30:00Z",
  "completed_at": "2021-04-06 11:30:00+00:00",
  "access_token": "48427a36d43c4d5aa6324bc06c692456",
  "tracking_info": "user123456",
  "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"
    }
  ],
  "deposit_details": {
    "account_number": "16002600",
    "account_type": "checking",
    "routing_number": "123456789",
    "bank_name": "TD Bank",
    "deposit_type": "amount",
    "deposit_value": "50.00"
  },
  "initial_accounts": [
    {
      "account_number": "16001234",
      "routing_number": "55999876",
      "account_type": "checking",
      "bank_name": "TD Bank",
      "deposit_type": "amount",
      "deposit_value": "50.00"
    }
  ],
  "pdf_report": "https://cdn.truv.com/report.pdf",
  "employer": {
    "id": "meta",
    "name": "Meta"
  },
  "provider": {
    "id": "adp",
    "name": "ADP"
  }
}

Changes

    • info

      added the new optional query request parameter show_fraud_reasons

    • info

      added the optional property to the response with the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • info

      added the non-success response with the status