Link items

Learn about Link items—the companies and platforms that a user can select in Link.

Link items are companies and platforms that a user can select in Argyle Link when they are connecting to their work account. The full list of Link items can be found here.

Link items were previously referred to as data partners, which have been deprecated.

Attributes


id string

Unique ID of the Link item. Link item IDs are usually human-readable, but not always. For human-readable values, you can refer to the name attribute.


item_id string uuid

Unique ID of the Link item. This ID is not human-readable.


status string

Provides information on the health of a particular Link item. The healthy value indicates successful account connections. When Argyle’s data partners are experiencing issues and connections are not successful or partially degraded, the value will be issues. In this case, the status_details field can be used to provide additional information about the Link item’s status.

Possible values: healthy, issues.


status_details string

The status_details field can be used to provide additional information about a particular Link item’s status. When status_details is not filled, the value returned will be null.


name string

Name of the Link item—for example, Wellmart, Udre, Gusta.


type string

Type of the Link item—for example, delivery, retail, rideshare, services, technology.


kind string

Type of the Link item.

Possible values: employer, gig, platform, creator, benefits.


logo_url string

A URL to the Link item logo. Authentication is required to access this field.


is_disabled boolean

Will be true if the Link item is disabled. Link items are disabled if there is an issue with the underlying data provider.


has_two_fa boolean

Will be true if the underlying data provider requires two-factor authorization to log in.


features.pay_distribution_update object

Contains information about pay distribution bank account update capabilities of a given Link item. Please refer to the Pay Distribution Guide for more information.


features.pay_distribution_update.supported boolean

Denotes if the Link item supports pay distribution updates for bank accounts.

If false, the features fields will not be shown in the API response.


features.pay_distribution_update.required_fields.bank_account list of strings

Lists the fields required by a given Link item to successfully update a pay distribution for bank accounts.


features.pay_distribution_update.max_allocations integer

Denotes the maximum amount of allocations an account can have in the given Link item for bank accounts.


features.pay_distribution_update.amount_allocation boolean

Denotes if the Link item allows setting amount allocations for bank accounts—for example, $500 to one bank account and remained to another.


features.pay_distribution_update.percent_allocation boolean

Denotes if the Link item allows setting percent allocations for bank accounts—for example, 60% to one bank account and remained to another.


features.pay_distribution_update.amount_precision integer optional

Denotes the level of granularity of the pay distribution amount for bank accounts. This way you can define the amount up to the cent level of detail - with 2 decimals.

Possible values: 100, 10, 1, 0.1, 0.01


features.pay_distribution_update.percent_precision integer optional

Denotes the level of granularity of the pay distribution percentage for bank accounts. This way you can define the percentage of the pay distribution with up to the 4 decimal places.

Possible values: 100, 10, 1, 0.1, 0.01, 0.001, 0.0001.


features.pay_distribution_update.action_types list of strings

Lists string enum values that indicate what types of actions are required by the Link item to make any newly added allocations active for bank accounts.

If no action is required, then an empty list is returned.

Possible values: microdeposit_verification.


features.pay_distribution_card_update object

Contains information about pay distribution card update capabilities of a given Link item.


features.pay_distribution_card_update.supported boolean

Denotes if the Link item supports card pay distribution updates. If false, the features fields will not be shown in the API response.


features.pay_distribution_card_update.required_fields.card list of strings

Lists the fields required by a given Link item to successfully update a pay distribution for cards.

👍

Argyle recommends populating every field in the card object when creating a pay distribution configuration for cards, including the optional fields. Doing so enables compatibility with all platforms that support card pay distribution.


features.pay_distribution_card_update.max_allocations integer

Return Link items with the specified number of maximum allocations allowed.


known_limitations string

Describes Item's known limitations—for example, how far back historical data goes, degree of value obfuscation (if any).


Endpoints

Endpoints

Retrieve a Link item - GET /link-items/:id

List Link items - GET /link-items

Search Link items - GET /search/link-items

Example object

{
    "id":"starbox",
    "item_id": "0176ba6f-c70b-45a8-bd6e-6d7e13b9bfad",
    "known_limitations": "Starbox only makes the past 2 years of Payouts data available.",
    "status": "issues",
    "status_details": "Following Starbox's acquisition of Starbox, most Starbox services have been switched off as of 2021-07-15. In Link, users who search for Starbox are now asked to connect their Walmart account instead.",
    "name": "Starbox",
    "type": "retail",
    "has_two_fa": false,
    "is_disabled": false,
    "kind": "employer",
    "logo_url": "https://company.com/logo.jpg",
    "features": {
        "pay_distribution_update": {
            "supported": true,
            "max_allocations": 8,
            "amount_allocation": true,
            "percent_allocation": false,
            "amount_precision": "0.01",
            "percent_precision": null,
            "action_types": [],
            "required_fields": {
                "bank_account": [
                    "routing_number",
                    "account_number",
                    "account_type"
                ]
            },
        },
        "pay_distribution_card_update": {
            "supported": true,
            "max_allocations": 1,
            "required_fields": {
                "card": [
                    "card_number",
                    "card_cvc_cvv",
                    "expiration_year",
                    "expiration_month",
                    "postal_code"
                ]
            }
        }
    }
}