The Deposit Switch object

Direct Deposit Switch (DDS) reports contain the attributes in the tables below.

Attributes

The values below cover attributes for the Deposit Switch Report.

Attribute	Type	Description
id	string	Unique identifier
status	string	Status from Connection Lifecycle
finished_at	string	Time when report was finished
completed_at	string	~~Time when report was completed~~ (Deprecated, invalid datetime format)
access_token	string	Access token for Link to payroll provider
tracking_info	string	Information passed to Truv Bridge from partner
is_suspicious	boolean	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
fraud_reasons	array of objects	Findings recorded for this link and its tasks; present only with `show_fraud_reasons=true`. See Fraud reasons
deposit_details	object	Bank account info, for Direct Deposit Switch (DDS) and Paycheck Linked Lending (PLL), see Deposit details object
initial_accounts	array of objects	List of initial accounts (nullable), see Initial accounts object
pdf_report	string	URL that points to the PDF file containing the report
employer	object, null	Employer information, see Employer object
provider	object	Payroll provider, see Provider object

Deposit details object

This table has information for the deposit details object.

Attribute	Type	Description
account_number	string	Account number
account_type	string	Account type: `checking` - Checking account, `savings` - Savings account
routing_number	string	Routing number
bank_name	string	Bank name
deposit_type	string	Deposit type: `entire` - Entire paycheck, `percent` - Percentage of the paycheck, `amount` - Fixed amount from the paycheck
deposit_value	string	Deposit value

Initial accounts object

The information below is for the initial accounts object attributes.

Attribute	Type	Description
account_number	string	Account number
routing_number	string	Routing number
account_type	string	Account type: `checking` - Checking account, `savings` - Savings account
account_name	string	Account name
bank_name	string	Bank name
deposit_type	string	Deposit type: `entire` - Entire paycheck, `percent` - Percentage of the paycheck, `amount` - Fixed amount from the paycheck
deposit_value	string	Deposit value

Employer object

This table covers the employer object attributes.

Attribute	Type	Description
id	string	Employer ID
name	string	Employer name
logo_url	string, null	Employer logo image

Provider object

This table covers the payroll provider object attributes.

Attribute	Type	Description
id	string	Data provider ID
name	string	Data provider name
logo_url	string	Data provider logo image

Endpoints

Use the following endpoints to get information for Deposit Switch Reports.

Example response

The sample below is a JSON response for the endpoint.

{
  "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": "percent",
    "deposit_value": "50.00"
  },
  "initial_accounts": [
    {
      "account_number": "16001234",
      "routing_number": "55999876"
    }
  ]
}

API Reference

Platform

Income & Employment

Financial Accounts

Document Processing

Direct Deposit Switch

Insurance Verification