v4

latestOpenAPI 3.0.12026-07-3189233676.2 KB

Deposit Switch Reports

Retrieve a direct deposit switch report for a link

The endpoint returns the DDS report for a link

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

Response

idstring required

Unique ID

statusstring required

Request status

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",
  "deposit_details": {
    "account_number": "16002600",
    "account_type": "checking",
    "routing_number": "123456789",
    "bank_name": "TD Bank",
    "deposit_type": "entire",
    "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"
  }
}