Argyle · Schema

AvailabilityItem

Status of the account's most recent data scan (initial data retrieval included) or [document upload](/api-reference/user-uploads) submission. - `in_progress` — A data scan is in progress, or a document was uploaded but not submitted. - `synced` — The most recent data scan of the account was successful, or an uploaded document was submitted. - `sync_failed` — Data retrieval during the most recent data scan failed, resulting in an [account connection error](/api-reference/account-connection-errors).

Employment DataPayrollIncome VerificationGig EconomyFinancial DataEmployment HistoryEarned Wage AccessDirect Deposit

Properties

Name Type Description
status string
updated_at string Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) of the most recent change to available data.
available_count integer Number of gig events, paystubs available, or response form submissions. During initial data retrieval, the `available_count` will increase until all data has been retrieved and `availability.status` b
files_count integer Total number of uploaded documents.
in_progress_count integer Total number of documents uploaded or response forms in progress but not submitted.
available_from string Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) of the earliest gig or paystub available.
available_to string Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) of the latest gig or paystub available.
View JSON Schema on GitHub

JSON Schema

availabilityitem.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/argyle/refs/heads/main/json-schema/availabilityitem.json",
  "title": "AvailabilityItem",
  "type": "object",
  "description": "Status of the account's most recent data scan (initial data retrieval included) or [document upload](/api-reference/user-uploads) submission.\n\n- `in_progress` \u2014 A data scan is in progress, or a document was uploaded but not submitted.\n- `synced` \u2014 The most recent data scan of the account was successful, or an uploaded document was submitted.\n- `sync_failed` \u2014 Data retrieval during the most recent data scan failed, resulting in an [account connection error](/api-reference/account-connection-errors).\n",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "in_progress",
        "synced",
        "sync_failed"
      ]
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) of the most recent change to available data."
    },
    "available_count": {
      "type": "integer",
      "description": "Number of gig events, paystubs available, or response form submissions.\n\nDuring initial data retrieval, the `available_count` will increase until all data has been retrieved and `availability.status` becomes `synced`.\n"
    },
    "files_count": {
      "type": "integer",
      "description": "Total number of uploaded documents."
    },
    "in_progress_count": {
      "type": "integer",
      "description": "Total number of documents uploaded or response forms in progress but not submitted."
    },
    "available_from": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) of the earliest gig or paystub available."
    },
    "available_to": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) of the latest gig or paystub available."
    }
  }
}