# Argyle Docs Documentation index for pages and API specification files. ## Home - [Documentation](https://docs.argyle.com/): Learn how Argyle works, and begin accessing real-time payroll data. ## Guides - [How Argyle Works](https://docs.argyle.com/overview/how-argyle-works): Payroll connections unlock a lot of possibilities. - [Users](https://docs.argyle.com/overview/data-structure/users): Users connect their payroll accounts using Link. - [Accounts](https://docs.argyle.com/overview/data-structure/accounts): Every payroll connection creates a new account. - [Data Sets](https://docs.argyle.com/overview/data-structure/data-sets): Standardized payroll data, when every paystub and payroll system is unique. - [Items](https://docs.argyle.com/overview/data-structure/items): Items are the employers or payroll platforms available in Link. - [Reports](https://docs.argyle.com/overview/data-structure/reports): Reports are PDF summaries of data retrieved from users' connected payroll accounts. - [Data Delivery](https://docs.argyle.com/overview/data-delivery): When to expect data after a payroll account connection. - [Data Security](https://docs.argyle.com/overview/data-security): Protecting personal information is our top priority. - [Ongoing Refresh](https://docs.argyle.com/overview/ongoing-refresh): Real-time updates, as soon as new payroll data is available. - [Sandbox Testing](https://docs.argyle.com/overview/sandbox-testing): Retrieve sample data and simulate errors in the Sandbox environment. - [Account Connections](https://docs.argyle.com/workflows/account-connections) - [Reconnecting Accounts](https://docs.argyle.com/workflows/reconnecting-accounts) - [Document Processing](https://docs.argyle.com/workflows/document-processing) - [3-in-1 Verification Suite](https://docs.argyle.com/integrations/pos-los/encompass/verifications): Verify income, employment, & assets within the Encompass® by ICE Mortgage Technology® platform. - [Encompass Setup Guide](https://docs.argyle.com/integrations/pos-los/encompass/setup-guide): Setting up manual and automated Argyle verification ordering within the Encompass® by ICE Mortgage Technology® platform. - [Payroll Verifications](https://docs.argyle.com/integrations/pos-los/encompass/legacy-guide/payroll-verifications): Verify income and employment within the Encompass® by ICE Mortgage Technology® platform. - [Banking Verifications](https://docs.argyle.com/integrations/pos-los/encompass/legacy-guide/banking-verifications): Verify assets within the Encompass® by ICE Mortgage Technology® platform. - [Document Verifications](https://docs.argyle.com/integrations/pos-los/encompass/legacy-guide/document-verifications): Document-based income verifications within the Encompass® by ICE Mortgage Technology® platform. - [Encompass - Manual Order Setup](https://docs.argyle.com/integrations/pos-los/encompass/legacy-guide/setup-guide): Setting up the Argyle verification service within the Encompass® by ICE Mortgage Technology® platform. - [nCino](https://docs.argyle.com/integrations/pos-los/ncino): Securely retrieve income, assets, and employment history with direct borrower connections in nCino. - [Consumer Connect](https://docs.argyle.com/integrations/pos-los/consumer-connect): Provide an enhanced borrower experience with direct payroll and banking connections. - [Empower](https://docs.argyle.com/integrations/pos-los/empower): Verify income and employment within the Empower® LOS platform. - [Point of Sale Systems](https://docs.argyle.com/integrations/pos-los/point-of-sale-systems): Connect borrowers through Argyle to unlock payroll data and documents. - [Loan Origination Systems](https://docs.argyle.com/integrations/pos-los/loan-origination-systems): Automate income and employment verifications. - [Day 1 Certainty® and AIM](https://docs.argyle.com/integrations/d1c-aim/verifications): Achieve Day 1 Certainty® and AIM eligibility through Argyle income and employment verifications. - [OCR and Authenticity](https://docs.argyle.com/integrations/ocr/ocrolus): OCR and Authenticity information for document uploads. - [Overview](https://docs.argyle.com/console/overview): Console is where you learn about, manage, and operate Argyle. - [Shareable URLs](https://docs.argyle.com/console/flows/shareable-urls): Create URLs that link to Argyle's payroll connection experience. - [Email/SMS Templates](https://docs.argyle.com/console/flows/email-sms-templates): Invite users via text or email to connect their payroll accounts. - [Embedded Experiences](https://docs.argyle.com/console/flows/embedded-experiences): Embed, brand, and customize Argyle - [Members & Permissions](https://docs.argyle.com/console/management/members): Managing roles and permissions in Console. - [Groups](https://docs.argyle.com/console/management/groups): Organize invitations and connections across your company. - [Developers](https://docs.argyle.com/console/management/developers): Accessing API keys through Console. - [Webhooks](https://docs.argyle.com/console/management/webhooks): Subscribe to event notifications through Console. - [Integrations](https://docs.argyle.com/console/management/integrations): Connecting third party services via Console. - [Overview](https://docs.argyle.com/link/overview) - [Initialization](https://docs.argyle.com/link/initialization) - [Upgrade](https://docs.argyle.com/link/upgrade) - [User Tokens](https://docs.argyle.com/link/user-tokens) - [Tracking](https://docs.argyle.com/link/reference/tracking) - [Callbacks](https://docs.argyle.com/link/reference/callbacks) - [Error Codes](https://docs.argyle.com/link/reference/error-codes) - [Overview](https://docs.argyle.com/api-guide/overview) - [Postman](https://docs.argyle.com/api-guide/postman) - [Webhooks](https://docs.argyle.com/api-guide/webhooks) ## API Reference - [Users](https://docs.argyle.com/api-reference/users): Users connect their payroll accounts using Link. - [Create A User](https://docs.argyle.com/api-reference/users/create-a-user): Creates a new user object. Includes a new \[user token\](/link/user-tokens) in the response. - [Retrieve A User](https://docs.argyle.com/api-reference/users/retrieve-a-user): Retrieves a user object. - [Update A User](https://docs.argyle.com/api-reference/users/update-a-user) - [Delete A User](https://docs.argyle.com/api-reference/users/delete-a-user): Deletes a user object. Deleting a user object will also delete all accounts and resources associated with the user. - [List All Users](https://docs.argyle.com/api-reference/users/list-all-users): Returns a paginated list of all user objects. - [User Tokens](https://docs.argyle.com/api-reference/user-tokens): Create user tokens for direct embedded Link initializations. - [Create A User Token](https://docs.argyle.com/api-reference/user-tokens/create-a-user-token): Creates a new user token from the `id` of an existing user. \[Creating a new user\](/api-reference/users#create) will also return a user token in the response. - [Invites](https://docs.argyle.com/api-reference/invites): Email or text users a URL connecting them to Link. - [Send An Invite](https://docs.argyle.com/api-reference/invites/send-an-invite): Immediately sends an invite via email, SMS, or both. Returns an invite object in the response. - [Retrieve An Invite](https://docs.argyle.com/api-reference/invites/retrieve-an-invite): Retrieves an invite object. - [Re-send an invite](https://docs.argyle.com/api-reference/invites/re-send-an-invite): Re-sends a previously sent invite. Updates the `updated_at` and `invited_at` time. - [Revoke An Invite](https://docs.argyle.com/api-reference/invites/revoke-an-invite): Invalidates a previously sent invite. If a user clicks a revoked invite URL, the landing page will notify the user the invite has expired. - [List All Invites](https://docs.argyle.com/api-reference/invites/list-all-invites): Returns an object containing all invite objects. - [Accounts](https://docs.argyle.com/api-reference/accounts): Accounts are payroll connections made through Link. - [Retrieve An Account](https://docs.argyle.com/api-reference/accounts/retrieve-an-account): Retrieves an account object. - [Delete An Account](https://docs.argyle.com/api-reference/accounts/delete-an-account): Deletes an account object. **Caution** - Deleting an account object will delete all resources associated with the account, such as paystubs or uploaded documents. - [List All Accounts](https://docs.argyle.com/api-reference/accounts/list-all-accounts): Returns a paginated list of all account objects. - [Disable Account Updates](https://docs.argyle.com/api-reference/accounts/disable-account-updates): Disables `ongoing_refresh` for an individual account. To access this feature, reach out to our team for assistance. * Link will display the \[ongoing\_refresh\_disabled\](/api-reference/account-connection-errors#ongoingrefreshdisabled) account connection error when users return to view this account. * Changes the account's \[`ongoing_refresh.status`\](/api-reference/accounts#object-ongoing_refresh) value from `enabled` to `disabled` and causes the \[`accounts.updated`\](/api-reference/accounts-webhooks/updated) webhook to be sent.
After `ongoing_refresh` is disabled: * The specified account will no longer receive \[data updates\](/overview/ongoing-refresh). * If the user returns to Link and \[reconnects the account\](/workflows/reconnecting-accounts#reconnecting-disconnected-accounts): 1. The account will immediately be re-scanned and its data updated. 2. The account will be billed as a new account connection. 3. Ongoing refresh will be re-enabled for the account. - [Employments](https://docs.argyle.com/api-reference/employments): Individual employments associated with a user or account. - [List All Employments](https://docs.argyle.com/api-reference/employments/list-all-employments) - [Items](https://docs.argyle.com/api-reference/items): Users connect their payroll accounts through **Items** in Link. - [Retrieve An Item](https://docs.argyle.com/api-reference/items/retrieve-an-item): Retrieves an Item object. - [List All Items](https://docs.argyle.com/api-reference/items/list-all-items): Returns a paginated list of all Item objects. - [Migrate a Link Item ID](https://docs.argyle.com/api-reference/items/migrate-a-link-item-id): Returns the Item ID's that correspond to a provided list of Link item ID's. - Link item ID's were used in Link 4 initializations. - Item ID's are used in \[Link 5 initializations\](/link/initialization). Item ID's use the convention: "item_\[9 digits\]" - `"item_123456789"` for example. - [Item Filters](https://docs.argyle.com/api-reference/item-filters): Create custom filters that can be used as a search parameter when listing Items. - [Create An Item Filter](https://docs.argyle.com/api-reference/item-filters/create-an-item-filter): Filters are applied to properties of the `field_coverage` object of \[Items\](/api-reference/items#object) using the comparison operators below. You can also filter Items by their `status` property using the `eq` operator. The name and ID of the new Item filter are returned in the response, which can be used as a query parameter when \[listing Items\](/api-reference/items#list). ## Comparison operators `eq` — equals `gt` — greater than `gte` — greater than or equal to `lt` — less than `lte` — less than or equal to - [Retrieve An Item Filter](https://docs.argyle.com/api-reference/item-filters/retrieve-an-item-filter): Retrieves an Item filter. - [Replace An Item Filter](https://docs.argyle.com/api-reference/item-filters/replace-an-item-filter): Replaces the filters of an Item filter with a new set of filters. - [Delete An Item Filter](https://docs.argyle.com/api-reference/item-filters/delete-an-item-filter): Deletes an Item filter. - [List All Item Filters](https://docs.argyle.com/api-reference/item-filters/list-all-item-filters): Returns a paginated list of all Item filters. - [Employer Search](https://docs.argyle.com/api-reference/employer-search): Use the employer search endpoint to create free-text employer search inputs in your applications. - [List All Employers](https://docs.argyle.com/api-reference/employer-search/list-all-employers): Returns a paginated list of all Item objects, representing the most relevant search results. - [Identities](https://docs.argyle.com/api-reference/identities): Profile and employment information. - [Retrieve An Identity](https://docs.argyle.com/api-reference/identities/retrieve-an-identity): Retrieves an identity object. - [List All Identities](https://docs.argyle.com/api-reference/identities/list-all-identities): Returns a paginated list of all identity objects. - [Paystubs](https://docs.argyle.com/api-reference/paystubs): The digital equivalent of a traditional paystub. - [Retrieve A Paystub](https://docs.argyle.com/api-reference/paystubs/retrieve-a-paystub): Retrieves a paystub object. - [List All Paystubs](https://docs.argyle.com/api-reference/paystubs/list-all-paystubs): Returns a paginated list of all paystub objects. - [Payroll Documents](https://docs.argyle.com/api-reference/payroll-documents): Retrieve metadata and PDF's of paystubs, tax forms, and other payroll documents. - [Retrieve A Payroll Document](https://docs.argyle.com/api-reference/payroll-documents/retrieve-a-payroll-document): Retrieves a payroll document object. - [List All Payroll Documents](https://docs.argyle.com/api-reference/payroll-documents/list-all-payroll-documents): Returns a paginated list of all payroll document objects. - [Deposit Destinations](https://docs.argyle.com/api-reference/deposit-destinations): Where paychecks are sent, and how they are allocated. - [Retrieve A Deposit Destination](https://docs.argyle.com/api-reference/deposit-destinations/retrieve-a-deposit-destination): Retrieves a deposit destination object. - [List All Deposit Destinations](https://docs.argyle.com/api-reference/deposit-destinations/list-all-deposit-destinations): Returns a paginated list of all deposit destination objects. - [Shifts](https://docs.argyle.com/api-reference/shifts): Retrieve information on work shifts and hours spent on individual tasks. - [Retrieve A Shift](https://docs.argyle.com/api-reference/shifts/retrieve-a-shift): Retrieves a shift object. - [List All Shifts](https://docs.argyle.com/api-reference/shifts/list-all-shifts): Returns a paginated list of all shift objects. - [Gigs](https://docs.argyle.com/api-reference/gigs): Retrieve information specific to gig employments. - [Retrieve A Gig](https://docs.argyle.com/api-reference/gigs/retrieve-a-gig): Retrieves a gig object. - [List All Gigs](https://docs.argyle.com/api-reference/gigs/list-all-gigs): Returns a paginated list of all gig objects. - [Vehicles](https://docs.argyle.com/api-reference/vehicles): Work vehicle information. - [Retrieve A Vehicle](https://docs.argyle.com/api-reference/vehicles/retrieve-a-vehicle): Retrieves a vehicle object. - [List All Vehicles](https://docs.argyle.com/api-reference/vehicles/list-all-vehicles): Returns a paginated list of all vehicle objects. - [Ratings](https://docs.argyle.com/api-reference/ratings): Achievement and task summary details for gig employments. - [Retrieve A Rating](https://docs.argyle.com/api-reference/ratings/retrieve-a-rating): Retrieves a rating object. - [List All Ratings](https://docs.argyle.com/api-reference/ratings/list-all-ratings): Returns a paginated list of all rating objects. - [Reports](https://docs.argyle.com/api-reference/reports): Generate PDF summaries based on Argyle's data sets. - [List All Reports](https://docs.argyle.com/api-reference/reports/list-all-reports): Returns a paginated list of all report objects. - [Generate A Report](https://docs.argyle.com/api-reference/reports/generate-a-report): Generates a new report and returns a report object. There is a daily limit of 10 reports per user to prevent excessive report generation due to accidental client-side errors. If the daily report limit is reached, deleting a previously generated report from the same 24 hour period will allow another report to be generated. - [Retrieve A Report](https://docs.argyle.com/api-reference/reports/retrieve-a-report): Retrieves a report object. - [Delete A Report](https://docs.argyle.com/api-reference/reports/delete-a-report): Deletes a report object. - [User Uploads](https://docs.argyle.com/api-reference/user-uploads): Upload and retrieve documents. - [Upload A Document](https://docs.argyle.com/api-reference/user-uploads/upload-a-document) - [Retrieve A User Upload](https://docs.argyle.com/api-reference/user-uploads/retrieve-a-user-upload): Retrieves a user upload object. - [List All User Uploads](https://docs.argyle.com/api-reference/user-uploads/list-all-user-uploads): Returns a paginated list of all user upload objects. - [User Forms](https://docs.argyle.com/api-reference/user-forms): User form submissions. - [Retrieve A User Form](https://docs.argyle.com/api-reference/user-forms/retrieve-a-user-form): Retrieves a user form object. - [List All User Forms](https://docs.argyle.com/api-reference/user-forms/list-all-user-forms): Returns a paginated list of all user form objects. - [Document Verifications](https://docs.argyle.com/api-reference/documents-overview): Implementation guide for document-based income verifications. - [Banking Overview Guide](https://docs.argyle.com/api-reference/banking-overview): Implementation guide for banking reports. - [Connect URL](https://docs.argyle.com/api-reference/connect-url): Create session links for bank authentications. - [Create A Connect Url](https://docs.argyle.com/api-reference/connect-url/create-a-connect-url): Creates a new Connect URL for the specified user. - [Banking Reports](https://docs.argyle.com/api-reference/banking-reports): Generate asset and income reports based on bank data. - [Generate A Banking Report](https://docs.argyle.com/api-reference/banking-reports/generate-a-banking-report): Generates a new banking report and returns a report object. - [Bank Accounts](https://docs.argyle.com/api-reference/bank-accounts): Bank account information. - [Retrieve A Bank Account](https://docs.argyle.com/api-reference/bank-accounts/retrieve-a-bank-account): Retrieves a bank account. - [List All Bank Accounts](https://docs.argyle.com/api-reference/bank-accounts/list-all-bank-accounts): Returns a paginated list of the user's bank accounts. - [Financial Institutions](https://docs.argyle.com/api-reference/financial-institutions): Explore supported financial institutions. - [Retrieve An Institution](https://docs.argyle.com/api-reference/financial-institutions/retrieve-an-institution): Retrieves a financial institution. - [List All Institutions](https://docs.argyle.com/api-reference/financial-institutions/list-all-institutions): Returns a paginated list of supported financial institutions. - [Verifications Guide](https://docs.argyle.com/api-reference/verifications-guide): Implementation guide for payroll, banking, and document verifications. - [Order a verification](https://docs.argyle.com/api-reference/verifications/order-a-verification) - [Create a session](https://docs.argyle.com/api-reference/verifications/create-a-session) - [Refresh a verification](https://docs.argyle.com/api-reference/verifications/refresh-a-verification) - [Retrieve a verification](https://docs.argyle.com/api-reference/verifications/retrieve-a-verification) - [Update a verification](https://docs.argyle.com/api-reference/verifications/update-a-verification) - [Cancel a verification](https://docs.argyle.com/api-reference/verifications/cancel-a-verification) - [List all verifications](https://docs.argyle.com/api-reference/verifications/list-all-verifications) - [Partners Verifications Guide](https://docs.argyle.com/api-reference/verifications-partners-guide): Partners implementation guide for payroll, banking, and document verifications. - [Create a user](https://docs.argyle.com/api-reference/verifications-partners/create-a-user) - [Update a user](https://docs.argyle.com/api-reference/verifications-partners/update-a-user) - [Order a verification](https://docs.argyle.com/api-reference/verifications-partners/order-a-verification) - [Create a session](https://docs.argyle.com/api-reference/verifications-partners/create-a-session) - [Refresh a verification](https://docs.argyle.com/api-reference/verifications-partners/refresh-a-verification) - [Retrieve a verification](https://docs.argyle.com/api-reference/verifications-partners/retrieve-a-verification) - [Update a verification](https://docs.argyle.com/api-reference/verifications-partners/update-a-verification) - [Cancel a verification](https://docs.argyle.com/api-reference/verifications-partners/cancel-a-verification) - [List all verifications](https://docs.argyle.com/api-reference/verifications-partners/list-all-verifications) - [Create a webhook subscription](https://docs.argyle.com/api-reference/verifications-partners/create-a-webhook-subscription) - [Retrieve a payroll document](https://docs.argyle.com/api-reference/verifications-partners/retrieve-a-payroll-document) - [List all payroll documents](https://docs.argyle.com/api-reference/verifications-partners/list-all-payroll-documents) - [Users.fully_synced webhook](https://docs.argyle.com/api-reference/users-webhooks/fully-synced) - [Accounts.added webhook](https://docs.argyle.com/api-reference/accounts-webhooks/added) - [Accounts.updated webhook](https://docs.argyle.com/api-reference/accounts-webhooks/updated): The `accounts.updated` webhook is sent when there is any change to a property value of the \[account object\](/api-reference/accounts/overview). When an account is first connected, the `accounts.updated` webhook is sent frequently — each time new data is added or used to refine a previous value. Whenever the `accounts.connected` and `accounts.failed` webhooks are sent, the `accounts.updated` webhook is sent as well. - [Accounts.removed webhook](https://docs.argyle.com/api-reference/accounts-webhooks/removed): The `accounts.removed` webhook is sent when a user revokes access to their account or an account is deleted. When an account is removed all resources associated with the account, such as paystubs or uploaded documents, are deleted and this webhook is sent. It is not recommend to use .removed webhooks for particular data sets to monitor for account deletions or revoked access, as they are not sent when an account is removed. - [Accounts.connected webhook](https://docs.argyle.com/api-reference/accounts-webhooks/connected): The `accounts.connected` webhook is sent when a user's login credentials are successfully authenticated and the account connection was successful. The webhook is also sent when a user re-connects an \[existing account\](/workflows/reconnecting-accounts). - [Accounts.failed webhook](https://docs.argyle.com/api-reference/accounts-webhooks/failed): The `accounts.failed` webhook is sent when: 1. The user submits login credentials that fail to authenticate. 2. The user submits login credentials to re-authenticate an account and authentication fails. 3. The user submits login credentials but there is a timeout during a required multi-factor authentication (MFA) process. To stay notified of \[account disconnections\](/workflows/reconnecting-accounts), instead use the `accounts.updated` webhook with a `resource` object included, and check for changes the account object's `connection.status` property. - [Items.updated webhook](https://docs.argyle.com/api-reference/items-webhooks/updated) - [Items.removed webhook](https://docs.argyle.com/api-reference/items-webhooks/removed): The `items.removed` webhook is sent when an existing Item is `deleted` and removed from Link. The `config` parameter is **required** when subscribing to the `items.removed` webhook. - [Identities.added webhook](https://docs.argyle.com/api-reference/identities-webhooks/added) - [Identities.updated webhook](https://docs.argyle.com/api-reference/identities-webhooks/updated): The `identities.updated` webhook is sent when there is any change to a property value of an \[identity object\](/api-reference/identities#object). - [Paystubs.added webhook](https://docs.argyle.com/api-reference/paystubs-webhooks/added) - [Paystubs.updated webhook](https://docs.argyle.com/api-reference/paystubs-webhooks/updated): The `paystubs.updated` webhook is sent when there is any change to a property value of the \[paystub object\](/api-reference/paystubs/overview). For example, after a payment is sent the paystub object's `status` value changes from `scheduled` to `completed`. - [Paystubs.partially_synced webhook](https://docs.argyle.com/api-reference/paystubs-webhooks/partially-synced): The `paystubs.partially_synced` webhook is sent when paystubs going back a specified number of days prior (starting from the date \[when the account was added\](/api-reference/accounts-webhooks/added)) have been retrieved. By default, this period is set to 30 days. You can subscribe to this webhook multiple times with different numbers of specified days. Of note: - This webhook is sent only during initial data retrieval (not \[ongoing refresh\](/overview/ongoing-refresh)). - If the number of paystubs for an account is small and captured completely with only one data pull, this webhook will not be sent. Instead the `paystubs.fully_synced` webhook will be sent. - [Paystubs.fully_synced webhook](https://docs.argyle.com/api-reference/paystubs-webhooks/fully-synced): The `paystubs.fully_synced` webhook is sent when all paystubs have been retrieved from a newly connected payroll account. - [Payroll Documents.added webhook](https://docs.argyle.com/api-reference/payroll-documents-webhooks/added) - [Payroll Documents.updated webhook](https://docs.argyle.com/api-reference/payroll-documents-webhooks/updated): The `payroll_documents.updated` webhook is sent when there is any change to a property value of a \[payroll document object\](/api-reference/payroll-documents) during a \[data refresh\](/overview/ongoing-refresh). - [Payroll Documents.removed webhook](https://docs.argyle.com/api-reference/payroll-documents-webhooks/removed): The `payroll_documents.removed` webhook is sent when an individual payroll document is deleted from an account or otherwise not found during a \[data refresh\](/overview/ongoing-refresh). This webhook is not sent when an account is deleted via the API, or a user revokes access to their account. - [Payroll Documents.ocr_completed webhook](https://docs.argyle.com/api-reference/payroll-documents-webhooks/ocr-completed): The `payroll_documents.ocr_completed` webhook is sent when Argyle has finished scanning a 1099 or W-2 document retrieved from a connected payroll account. The scanned information can be found within the `ocr_data` object when retrieving a \[payroll document\](/api-reference/payroll-documents#object). - [Payroll Documents.ocr_failed webhook](https://docs.argyle.com/api-reference/payroll-documents-webhooks/ocr-failed): The `payroll_documents.ocr_failed` webhook is sent when Argyle encounters an error while scanning a 1099 or W-2 document retrieved from a connected payroll account. The error that occurred will be returned within the `ocr_data` object of the \[payroll document\](/api-reference/payroll-documents). - [Shifts.added webhook](https://docs.argyle.com/api-reference/shifts-webhooks/added) - [Shifts.updated webhook](https://docs.argyle.com/api-reference/shifts-webhooks/updated): The `shifts.updated` webhook is sent when there is any change to a property value of the \[shift object\](/api-reference/shifts#object). For example, after a shift is completed the shift object's `status` value changes from `in_progress` to `completed`. - [Shifts.removed webhook](https://docs.argyle.com/api-reference/shifts-webhooks/removed): The `shifts.removed` webhook is sent when a shift object has been deleted after a previous shift was not found when an account's data was refreshed. - [Shifts.partially_synced webhook](https://docs.argyle.com/api-reference/shifts-webhooks/partially-synced): The `shifts.partially_synced` webhook is sent when shifts going back a specified number of days prior (starting from the date \[when the account was added\](/api-reference/accounts-webhooks/added)) have been retrieved. By default, this period is set to 30 days. You can subscribe to this webhook multiple times with different numbers of specified days. * This webhook is sent only during initial data retrieval (not \[ongoing refresh\](/overview/ongoing-refresh)). * If the number of shifts for an account is small and captured completely with only one data pull, this webhook will not be sent. Instead the `shifts.fully_synced` webhook will be sent. - [Shifts.fully_synced webhook](https://docs.argyle.com/api-reference/shifts-webhooks/fully-synced): The `shifts.fully_synced` webhook is sent when all shifts have been retrieved from a newly connected payroll account. - [Gigs.added webhook](https://docs.argyle.com/api-reference/gigs-webhooks/added) - [Gigs.updated webhook](https://docs.argyle.com/api-reference/gigs-webhooks/updated): The `gigs.updated` webhook is sent when there is any change to a property value of the \[gig object\](/api-reference/gigs/overview). For example, after a gig assignment is completed the gig object's `status` value changes from `in_progress` to `completed`. - [Gigs.removed webhook](https://docs.argyle.com/api-reference/gigs-webhooks/removed): The `gigs.removed` webhook is sent when a gig object has been deleted after a previous gig was not found when an account's data was refreshed. - [Gigs.partially_synced webhook](https://docs.argyle.com/api-reference/gigs-webhooks/partially-synced): The `gigs.partially_synced` webhook is sent when gigs going back a specified number of days prior (starting from the date \[when the account was added\](/api-reference/accounts-webhooks/added)) have been retrieved. By default, this period is set to 30 days. You can subscribe to this webhook multiple times with different numbers of specified days. Of note: * This webhook is sent only during initial data retrieval (not \[ongoing refresh\](/overview/ongoing-refresh)). * If the number of gigs for an account is small and captured completely with only one data pull, this webhook will not be sent. Instead the `gigs.fully_synced` webhook will be sent. - [Gigs.fully_synced webhook](https://docs.argyle.com/api-reference/gigs-webhooks/fully-synced): The `gigs.fully_synced` webhook is sent when all gigs have been retrieved from a newly connected payroll account. - [Vehicles.added webhook](https://docs.argyle.com/api-reference/vehicles-webhooks/added) - [Vehicles.updated webhook](https://docs.argyle.com/api-reference/vehicles-webhooks/updated): The `vehicles.updated` webhook is sent when there is any change to a property value of a \[vehicle object\](/api-reference/vehicles#object). - [Vehicles.removed webhook](https://docs.argyle.com/api-reference/vehicles-webhooks/removed): The `vehicles.removed` webhook is sent when a vehicle object has been deleted due to a previous vehicle not being found when an account's data was refreshed. This webhook is not sent when an account is deleted via the API, or a user revokes access to their account. - [Ratings.added webhook](https://docs.argyle.com/api-reference/ratings-webhooks/added) - [Ratings.updated webhook](https://docs.argyle.com/api-reference/ratings-webhooks/updated): The `ratings.updated` webhook is sent when there is any change to a property value of a \[ratings object\](/api-reference/ratings#object). - [Reports.ready webhook](https://docs.argyle.com/api-reference/reports-webhooks/ready) - [Reports.generated webhook](https://docs.argyle.com/api-reference/reports-webhooks/generated): The `reports.generated` webhook is sent when a report has been successfully \[generated\](/api-reference/reports#generate) and can be retrieved. - [User Uploads.added webhook](https://docs.argyle.com/api-reference/user-uploads-webhooks/added) - [User Uploads.removed webhook](https://docs.argyle.com/api-reference/user-uploads-webhooks/removed): The `user_uploads.removed` webhook is sent when a user deletes a previously uploaded document, or an account associated with an uploaded document is deleted. - [User Uploads.ocr_completed webhook](https://docs.argyle.com/api-reference/user-uploads-webhooks/ocr-completed): The `user_uploads.ocr_completed` webhook is sent when \[Ocrolus OCR\](/api-reference/user-uploads#object-metadata-ocr_data) data is available for an uploaded document. - This webhook is sent on a per document basis. - If any \[OCR errors\](/integrations/ocr/ocrolus#ocr-errors) occurred, this webhook will not be sent. Instead the `user_uploads.ocr_failed` \[webhook\](/api-reference/user-uploads-webhooks/ocr-failed) will be sent. Errors will be listed in the `ocr_data` object of the \[user uploads object\](/api-reference/user-uploads/overview) in an `error` field. - [User Uploads.ocr_failed webhook](https://docs.argyle.com/api-reference/user-uploads-webhooks/ocr-failed): The `user_uploads.ocr_failed` webhook is sent when Ocrolus OCR processing could not be completed for an uploaded document. \[OCR errors\](/integrations/ocr/ocrolus#ocr-errors) are returned in the `ocr_data` object of the \[user uploads object\](/api-reference/user-uploads/overview) in an `error` field. - [User Uploads.ocr_authenticity webhook](https://docs.argyle.com/api-reference/user-uploads-webhooks/ocr-authenticity): The `user_uploads.ocr_authenticity` webhook is sent when \[Ocrolus authenticity\](/api-reference/user-uploads#object-metadata-ocr_authenticity) data is available for an uploaded document. - [User Forms.submitted webhook](https://docs.argyle.com/api-reference/user-forms-webhooks/user-forms-submitted) - [User Forms.removed webhook](https://docs.argyle.com/api-reference/user-forms-webhooks/user-forms-removed) - [Verifications.updated webhook](https://docs.argyle.com/api-reference/verifications-webhooks/updated) - [Receipts](https://docs.argyle.com/api-reference/receipts): Generate billing receipts for users. - [Account Connection Errors](https://docs.argyle.com/api-reference/account-connection-errors): Common causes and troubleshooting. ## API specifications - [Argyle API (Consolidated)](https://docs.argyle.com/openAPI/argyle-all.yaml) - [Accounts Webhooks API](https://docs.argyle.com/openAPI/account-webhook-updated.yaml) - [Accounts Webhooks API](https://docs.argyle.com/openAPI/account-webhooks-added.yaml) - [Accounts Webhooks API](https://docs.argyle.com/openAPI/accounts-webhooks-connected.yaml) - [Accounts Webhooks API](https://docs.argyle.com/openAPI/accounts-webhooks-failed.yaml) - [Accounts Webhooks API](https://docs.argyle.com/openAPI/accounts-webhooks-removed.yaml) - [Argyle API - Accounts](https://docs.argyle.com/openAPI/accounts.yaml) - [Deposit Destinations API](https://docs.argyle.com/openAPI/deposit-destinations.yaml) - [Employer Search API](https://docs.argyle.com/openAPI/employer-search.yaml) - [Employments API](https://docs.argyle.com/openAPI/employments.yaml) - [Gigs API](https://docs.argyle.com/openAPI/gigs.yaml) - [Gigs Webhooks](https://docs.argyle.com/openAPI/gigs-webhooks-added.yaml) - [Gigs Webhooks](https://docs.argyle.com/openAPI/gigs-webhooks-fully-synced.yaml) - [Gigs Webhooks](https://docs.argyle.com/openAPI/gigs-webhooks-partially-synced.yaml) - [Gigs Webhooks](https://docs.argyle.com/openAPI/gigs-webhooks-removed.yaml) - [Gigs Webhooks](https://docs.argyle.com/openAPI/gigs-webhooks-updated.yaml) - [Identities API](https://docs.argyle.com/openAPI/identities.yaml) - [Identities Webhooks API](https://docs.argyle.com/openAPI/identities-webhooks-added.yaml) - [Identities Webhooks API](https://docs.argyle.com/openAPI/identities-webhooks-updated.yaml) - [Invites API](https://docs.argyle.com/openAPI/invites.yaml) - [Item Filters API](https://docs.argyle.com/openAPI/item-filters.yaml) - [Items API](https://docs.argyle.com/openAPI/items.yaml) - [Items Webhooks](https://docs.argyle.com/openAPI/items-webhooks-removed.yaml) - [Items Webhooks](https://docs.argyle.com/openAPI/items-webhooks-updated.yaml) - [Open Banking API](https://docs.argyle.com/openAPI/open-banking.yaml) - [Partner Verifications API](https://docs.argyle.com/openAPI/verifications-partners.yaml) - [Payroll Documents API](https://docs.argyle.com/openAPI/payroll-documents.yaml) - [Payroll Documents Webhooks](https://docs.argyle.com/openAPI/payroll-documents-webhooks-added.yaml) - [Payroll Documents Webhooks](https://docs.argyle.com/openAPI/payroll-documents-webhooks-ocr-completed.yaml) - [Payroll Documents Webhooks](https://docs.argyle.com/openAPI/payroll-documents-webhooks-ocr-failed.yaml) - [Payroll Documents Webhooks](https://docs.argyle.com/openAPI/payroll-documents-webhooks-removed.yaml) - [Payroll Documents Webhooks](https://docs.argyle.com/openAPI/payroll-documents-webhooks-updated.yaml) - [Paystubs API](https://docs.argyle.com/openAPI/paystubs.yaml) - [Paystubs Webhooks API](https://docs.argyle.com/openAPI/paystubs-webhooks-added.yaml) - [Paystubs Webhooks API](https://docs.argyle.com/openAPI/paystubs-webhooks-fully-synced.yaml) - [Paystubs Webhooks API](https://docs.argyle.com/openAPI/paystubs-webhooks-partially-synced.yaml) - [Paystubs Webhooks API](https://docs.argyle.com/openAPI/paystubs-webhooks-updated.yaml) - [Ratings API](https://docs.argyle.com/openAPI/ratings.yaml) - [Ratings Webhooks API](https://docs.argyle.com/openAPI/ratings-webhooks-added.yaml) - [Ratings Webhooks API](https://docs.argyle.com/openAPI/ratings-webhooks-updated.yaml) - [Receipts API](https://docs.argyle.com/openAPI/receipts.yaml) - [Reports API](https://docs.argyle.com/openAPI/reports.yaml) - [Reports Webhooks API](https://docs.argyle.com/openAPI/reports-webhooks-generated.yaml) - [Reports Webhooks API](https://docs.argyle.com/openAPI/reports-webhooks-ready.yaml) - [Shifts API](https://docs.argyle.com/openAPI/shifts.yaml) - [Shifts Webhooks](https://docs.argyle.com/openAPI/shifts-webhooks-added.yaml) - [Shifts Webhooks](https://docs.argyle.com/openAPI/shifts-webhooks-fully-synced.yaml) - [Shifts Webhooks](https://docs.argyle.com/openAPI/shifts-webhooks-partially-synced.yaml) - [Shifts Webhooks](https://docs.argyle.com/openAPI/shifts-webhooks-removed.yaml) - [Shifts Webhooks](https://docs.argyle.com/openAPI/shifts-webhooks-updated.yaml) - [User Forms API](https://docs.argyle.com/openAPI/user-forms.yaml) - [User Forms Webhooks API](https://docs.argyle.com/openAPI/user-forms-webhooks-removed.yaml) - [User Forms Webhooks API](https://docs.argyle.com/openAPI/user-forms-webhooks.yaml) - [User Tokens API](https://docs.argyle.com/openAPI/user-tokens.yaml) - [User Uploads API](https://docs.argyle.com/openAPI/user-uploads.yaml) - [User Uploads Webhooks](https://docs.argyle.com/openAPI/user-uploads-webhooks-added.yaml) - [User Uploads Webhooks](https://docs.argyle.com/openAPI/user-uploads-webhooks-ocr-authenticity.yaml) - [User Uploads Webhooks](https://docs.argyle.com/openAPI/user-uploads-webhooks-ocr-completed.yaml) - [User Uploads Webhooks](https://docs.argyle.com/openAPI/user-uploads-webhooks-ocr-failed.yaml) - [User Uploads Webhooks](https://docs.argyle.com/openAPI/user-uploads-webhooks-removed.yaml) - [Users API](https://docs.argyle.com/openAPI/users.yaml) - [Users Webhooks API](https://docs.argyle.com/openAPI/users-webhooks.yaml) - [Vehicles API](https://docs.argyle.com/openAPI/vehicles.yaml) - [Vehicles Webhooks API](https://docs.argyle.com/openAPI/vehicles-webhooks-added.yaml) - [Vehicles Webhooks API](https://docs.argyle.com/openAPI/vehicles-webhooks-removed.yaml) - [Vehicles Webhooks API](https://docs.argyle.com/openAPI/vehicles-webhooks-updated.yaml) - [Verifications API](https://docs.argyle.com/openAPI/verifications.yaml) - [Verifications Webhooks API](https://docs.argyle.com/openAPI/verifications-webhooks-updated.yaml)