Items

Items are the employers or payroll platforms available in Link.

Definition#

"Items" are the searchable employers and payroll platforms in Link through which payroll accounts are connected.

A full list of supported Items can be viewed in the Coverage section of Console. You can also subscribe to our Changelog for ongoing updates on Argyle's coverage expansion.

Types of Items#

There are four different types of Items, representing where payroll information is ultimately sourced.

Individual Item information#

Health status#

Items that currently support new connections with no known issues are considered healthy. If the connection process or ongoing refresh is not available or partially degraded, the Item is tagged as unavailable or having issues.

You can view each Item's health status by searching for the Item in the Coverage section of Console and checking the status column, or retrieve the Item via the API and check the status property. Subscribing to the items.updated webhook via Console or via the API will also notify you when an Item's health status changes.

Deposit switch capabilities#

To see if an Item supports deposit switches, check the DDS supported column of the Coverage section of Console, or retrieve the Item via the API and check the direct_deposit_switch object to see if deposit_account deposit switches are supported.

Data fields returned#

While essential payroll data can be retrieved from most Item connections, some data fields are not supported by all Items. For example, a non-gig platform may not contain vehicle data.

To check which data fields are available on an Item by Item basis:

• Console — search for and select an individual Item in the Coverage section of Console, and expand the relevant data category within the Field availability area.

• API — retrieve the Item and check the field_coverage object to see if an individual data field is supported.

  Example

  To see if an Item supports the job_title field from the Identities data set.

  1. Retrieve the Item via the API using its ID.

  2. Search the response, in this case by job_title, and check if the desired field is supported.

     1"field_coverage": {
     2    "identities": {
     3        "job_title": {
     4            "supported": true
     5        }
     6    }
     7}
     

Data refresh frequency#

How often an Item is re-scanned to check for new data, which is used to update all accounts that were connected through the Item in Link, is returned in the refresh_frequency field when retrieving an Item by its ID via the API.

See our Ongoing Refresh Guide for more information.

Mapping status#

Items are classified into three mapping statuses, which represent the Item's previous connection history:

• verified — The payroll system associated with the Item is known, and the Item has previously experienced a successful connection that returned paystub data.

• mapped — The payroll system associated with the Item is known, but the Item is awaiting a successful connection.

• unmapped — The payroll system associated with this Item is not yet known.

  If an unmapped Item is selected in Link, the user will be given the option to search for the relevant payroll system and attempt to connect using their login credentials.

An Item's mapping status can be retrieved by filtering or selecting an individual Item or within the Coverage section of Console, or via the API using the Items endpoint. You can choose which Items to show in Link search based on their mapping status when customizing a Flow in Console by using the Display income sources based on mapping status toggle within the Search and connect tab.

Data limits and obfuscations#

Items with specific constraints, such as historical data limits or obscured values, are documented in:

• Console — search for and select an individual Item in the Coverage section of Console. A known limitations area will be present only when the Item has data limitations.
• API — retrieve the Item and check the known_limitations property.

Creating Item filters#

Using the API's /item-filters endpoint, you can create custom filters to search for Items that support specific requirements:

1. Create an Item filter.
2. Add supported filters for your desired fields or deposit switch capabilities.
3. When listing Items, use the Item filter ID as a query parameter.