Argyle · Schema
Item
Employment DataPayrollIncome VerificationGig EconomyFinancial DataEmployment HistoryEarned Wage AccessDirect Deposit
Properties
| Name | Type | Description |
|---|---|---|
| id | string | Unique ID of the Item. ID format — `item_123456789` |
| name | string | Name of the Item. |
| kind | string | Type of Item. |
| known_limitations | string | Known limitations of the Item, such as historical data limits, unique behavior, or degree of value obfuscation. Otherwise `null`. |
| status | string | Health status of the Item. - `healthy` — Normal service. - `issues` — Impacted service. New account connections still supported. - `unavailable` — Impacted service. New account connections not support |
| status_details | string | Additional details on the Item's health status, such as degraded account connection ability or paused [ongoing refresh](/overview/ongoing-refresh). Otherwise `null`. |
| logo_url | string | URL location of the Item's logo image file. |
| is_grouping | boolean | `true` if the Item does not directly support account connections, but instead acts as a container for other Items. |
| mapping_status | string | Verification status of the Item. - `verified` — The payroll system associated with the Item is known, and the Item has previously experienced a successful connection that returned paystub data. - `map |
| matching_score | string | Confidence score based on the degree of similarity between the Item and the search term. Ranges from "1.00" (strong match) to "0.01" (weak match). `matching_score` is only returned when [listing Items |
| features | object | What data fields the Item supports, the Item's deposit switching capabilities, and how often the Item is refreshed with new data. *Only returned when* [retrieving individual Items](/api-reference/item |
JSON Schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://raw.githubusercontent.com/api-evangelist/argyle/refs/heads/main/json-schema/item.json",
"title": "Item",
"type": "object",
"example": {
"id": "item_000000001",
"name": "Whole Goods",
"kind": "employer",
"known_limitations": "First 5 digits of SSN obfuscated.",
"status": "healthy",
"status_details": null,
"logo_url": "argyle.com/image-holdings",
"is_grouping": false,
"mapping_status": "verified",
"features": {
"data_retrieval": {
"refresh_frequency": "5h"
},
"field_coverage": {
"identities": {
"first_name": {
"supported": true
},
"last_name": {
"supported": true
},
"...": {
"supported": true
}
},
"paystubs": {
"hours_ytd": {
"supported": false
},
"paystub_period": {
"start_date": {
"supported": true
},
"end_date": {
"supported": true
}
},
"...": {
"supported": true
}
},
"payroll_documents": {
"...": {
"supported": true
}
},
"deposit_destinations": {
"...": {
"supported": true
}
},
"shifts": {
"...": {
"supported": true
}
},
"gigs": {
"...": {
"supported": true
}
},
"vehicles": {
"...": {
"supported": true
}
},
"ratings": {
"...": {
"supported": true
}
}
},
"direct_deposit_switch": {
"card": {
"supported": true,
"max_allocations": "3"
},
"deposit_account": {
"types": [
"ach_deposit_account"
],
"supported": true,
"max_allocations": "2",
"amount_allocation": false,
"percent_allocation": true,
"amount_precision": null,
"percent_precision": "0.01"
}
}
}
},
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the Item. ID format \u2014 `item_123456789`\n"
},
"name": {
"type": "string",
"description": "Name of the Item."
},
"kind": {
"type": "string",
"enum": [
"employer",
"gig",
"platform",
"benefits"
],
"description": "Type of Item."
},
"known_limitations": {
"type": "string",
"nullable": true,
"description": "Known limitations of the Item, such as historical data limits, unique behavior, or degree of value obfuscation. Otherwise `null`.\n"
},
"status": {
"type": "string",
"enum": [
"healthy",
"issues",
"unavailable"
],
"description": "Health status of the Item.\n\n- `healthy` \u2014 Normal service.\n- `issues` \u2014 Impacted service. New account connections still supported.\n- `unavailable` \u2014 Impacted service. New account connections not supported. [Ongoing refresh](/overview/ongoing-refresh) paused.\n"
},
"status_details": {
"type": "string",
"nullable": true,
"description": "Additional details on the Item's health status, such as degraded account connection ability or paused [ongoing refresh](/overview/ongoing-refresh). Otherwise `null`.\n"
},
"logo_url": {
"type": "string",
"description": "URL location of the Item's logo image file."
},
"is_grouping": {
"type": "boolean",
"description": "`true` if the Item does not directly support account connections, but instead acts as a container for other Items.\n"
},
"mapping_status": {
"type": "string",
"enum": [
"verified",
"mapped",
"unmapped"
],
"description": "Verification status of the Item.\n\n- `verified` \u2014 The payroll system associated with the Item is known, and the Item has previously experienced a successful connection that returned paystub data.\n- `mapped` \u2014 The payroll system associated with the Item is known, but the Item is awaiting a successful connection.\n- `unmapped` \u2014 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.\n"
},
"matching_score": {
"type": "string",
"description": "Confidence score based on the degree of similarity between the Item and the search term. Ranges from \"1.00\" (strong match) to \"0.01\" (weak match).\n\n`matching_score` is only returned when [listing Items](/api-reference/items#list) and is only applicable when the `q` \"free-text search\" [query parameter](/api-reference/items#list-q) is used.\n"
},
"features": {
"type": "object",
"description": "What data fields the Item supports, the Item's deposit switching capabilities, and how often the Item is refreshed with new data.\n\n*Only returned when* [retrieving individual Items](/api-reference/items#retrieve) *by Item ID.*\n",
"properties": {
"data_retrieval": {
"type": "object",
"description": "Details on how often the Item is re-scanned for new data.",
"properties": {
"refresh_frequency": {
"type": "string",
"description": "How often the Item is re-scanned to check for new data, which is used to update all accounts connected to this Item.\n\nRounded up to the nearest hour, in the format `#hr`.\n\n*`null` values indicate [ongoing data refreshes](/overview/ongoing-refresh) have temporarily been suspended. Check the Item's health [status](#object-status) and [status_details](#object-status_details) for more information.*\n"
}
}
},
"field_coverage": {
"type": "object",
"description": "Contains information on whether the Item returns data for a particular property within one of Argyle's data sets.\n\n*Does not include object ID's, account ID's, or metadata. `null` values are returned for properties of new or uncommon Items until a determination on data availability can be made.*\n",
"properties": {
"identities": {
"type": "object",
"description": "All data fields of the [identity object](/api-reference/identities#object)."
},
"paystubs": {
"type": "object",
"description": "All data fields of the [paystub object](/api-reference/paystubs#object)."
},
"payroll_documents": {
"type": "object",
"description": "All data fields of the [payroll document object](/api-reference/payroll-documents#object)."
},
"deposit_destinations": {
"type": "object",
"description": "All data fields of the [deposit destination object](/api-reference/deposit-destinations#object)."
},
"shifts": {
"type": "object",
"description": "All data fields of the [shift object](/api-reference/shifts#object)."
},
"gigs": {
"type": "object",
"description": "All data fields of the [gig object](/api-reference/gigs#object)."
},
"vehicles": {
"type": "object",
"description": "All data fields of the [vehicle object](/api-reference/vehicles#object)."
},
"ratings": {
"type": "object",
"description": "All data fields of the [rating object](/api-reference/ratings#object)."
}
}
},
"direct_deposit_switch": {
"type": "object",
"description": "Contains information on the Item's deposit switch capabilities.",
"properties": {
"card": {
"type": "object",
"description": "Employer supports payouts to debit cards.",
"properties": {
"supported": {
"type": "boolean",
"description": "`true` if the Item supports payouts to debit cards.\n\nGenerally applies to gig platforms, where users can send instant payouts to debit cards.\n"
},
"max_allocations": {
"type": "string",
"format": "integer",
"description": "Number of debit cards that can be added to the Item's underlying platform."
}
}
},
"deposit_account": {
"type": "object",
"description": "Direct deposit capabilities.",
"properties": {
"types": {
"type": "array",
"items": {
"type": "string"
},
"description": "The types of bank accounts supported.\n\nOnly `ach_deposit_account` (U.S. deposit account) is currently supported.\n"
},
"supported": {
"type": "boolean",
"description": "`true` if the Item supports deposit switching."
},
"max_allocations": {
"type": "string",
"format": "integer",
"description": "Number of total bank accounts supported by the Item's underlying platform."
},
"amount_allocation": {
"type": "boolean",
"description": "`true` if the Item's direct deposit settings support using exact amounts to define how pay is allocated to different bank accounts."
},
"percent_allocation": {
"type": "boolean",
"description": "`true` if the Item's direct deposit settings support using exact percentages of total pay to define how pay is allocated to different bank accounts."
},
"amount_precision": {
"type": "string",
"nullable": true,
"description": "What level of precision is allowed when setting amount allocations.\n\n- `100`\n- `10`\n- `1` \u2014 e.g. $52 or $53\n- `0.10`\n- `0.01` \u2014 e.g. $52.05 or $52.06\n- `null`\n\nNull values indicate the platform does not specify an exact level of precision.\n"
},
"percent_precision": {
"type": "string",
"nullable": true,
"description": "What level of precision is allowed when setting percentage allocations.\n\n- `100`\n- `10`\n- `1` \u2014 e.g. 52% or 53%\n- `0.10`\n- `0.01` \u2014 e.g. 52.05% or 52.06%\n- `0.001`\n- `0.0001`\n- `null`\n\nNull values indicate the platform does not specify an exact level of precision.\n"
}
}
}
}
}
}
}
}
}