# AI Tools Source: https://docs.argyle.com/api-guide/ai-tools Use Argyle's machine-readable docs and API resources with AI coding tools. ## What to provide an AI coding tool AI coding tools do not need to be trained on Argyle. Give them current Argyle context instead: start with `llms.txt`, use the OpenAPI specification for endpoint and schema details, and connect the MCP server when your tool supports MCP. ## Resources * [llms.txt](https://docs.argyle.com/llms.txt) — Use Argyle's LLM-friendly docs index to find relevant guide, API reference, and OpenAPI pages. * [OpenAPI specification](https://docs.argyle.com/openAPI/argyle-all.yaml) — Use the consolidated Argyle API spec for generated clients, schema-aware API calls, and endpoint references. * [Argyle Docs MCP server](https://docs.argyle.com/mcp) — Connect this in MCP-capable tools so the assistant can search and read Argyle docs directly. ## Common ways to use these resources * In AI coding tools such as Claude Code, Codex, Cursor, and VS Code, add the MCP server if the tool supports remote MCP servers. * If the tool cannot connect to MCP or does not automatically discover Argyle docs, give it the `llms.txt` link first and ask it to follow the linked Markdown docs for the specific feature. * For API implementation work, include the OpenAPI specification so the tool can use current endpoint and schema definitions. ## Safety Keep API keys, secrets, customer data, and user data out of AI prompts unless your organization has approved that workflow. # Overview Source: https://docs.argyle.com/api-guide/overview Learn how to use the Argyle API. The Argyle API uses HTTPS, HTTP basic authentication, REST-style resources, and JSON request and response bodies. Start with the [API Reference overview](/api-reference/overview) to choose the endpoint family for your implementation. ## API keys Create separate Sandbox and Production API keys in [Console](https://console.argyle.com/api-keys). The API key secret is shown only when the key is created and is partially obscured afterward. Copy it immediately and store it securely. ## Authentication Use HTTP basic authentication on every request: * Username: `api_key_id` * Password: `api_key_secret` ```bash theme={} curl https://api-sandbox.argyle.com/v2/accounts \ -u api_key_id:api_key_secret ``` API keys must match the requested environment. Sandbox keys used against Production, or Production keys used against Sandbox, return `401 Unauthorized`. ## Environments | Environment | Purpose | Base URL | | - | - | - | | Sandbox | Test sample users and simulated workflows. | `https://api-sandbox.argyle.com/v2` | | Production | Process real user connections and data. | `https://api.argyle.com/v2` | Both Link and the API support Sandbox and Production. Most endpoints are available in both environments. Billing resources such as receipts are Production-only. See [Sandbox Testing](/overview/sandbox-testing) for sample users, refresh simulation, data updates, and error scenarios. ## Data readiness Connected-account data arrives and updates in stages. Do not treat account creation as confirmation that every historical resource is available. Follow [Data Delivery and Readiness](/overview/data-delivery) for account and resource webhooks. Verification implementations should use [verification status](/verifications/verification-statuses) instead. ## Compatibility Implementations must tolerate new optional fields, response fields, enum values, and webhook events. Breaking changes include: * Changing authentication or authorization requirements. * Removing or renaming an endpoint or webhook. * Removing or renaming a required request parameter. * Adding a required request parameter. * Removing or renaming a response field. * Changing a field, request parameter, or query parameter type. Non-breaking changes include: * Adding an endpoint or webhook. * Adding an optional request parameter or response field. * Returning new response or enum values. * Changing an error message. * Correcting an HTTP status code that was previously wrong. Subscribe to the [Changelog](https://changelog.argyle.com/) for API changes. ## Security * Call the Argyle API only from server-side applications. * Never include API keys in browser or mobile application code. * Store secrets outside source control. * Use separate keys for separate backend systems and environments. * Delete unused keys. See [Data Security](/overview/data-security) for broader implementation guidance. ## Status codes | Status | Meaning | | - | - | | `200 OK` | Request succeeded. | | `201 Created` | Request succeeded and created a resource. | | `204 No Content` | Request succeeded without a response body. | | `400 Bad Request` | Request or field validation failed. | | `401 Unauthorized` | Authentication credentials are missing or invalid. | | `402 Request Failed` | Request was valid but could not be processed. | | `403 Forbidden` | API key lacks the required permission. | | `404 Not Found` | Resource does not exist or is not available to the key. | | `409 Conflict` | Request conflicts with the current resource state. | | `429 Too Many Requests` | Request rate exceeded the limit. | | `500`, `502`, `503`, `504` | Argyle server error. | | `520 External Server Error` | An upstream platform returned an error. | ## Error responses General request errors return a `detail` value: ```json theme={} { "detail": "Authentication credentials were not provided." } ``` Field validation errors return the affected fields: ```json theme={} { "name": ["This field may not be blank."], "url": ["Enter a valid URL."] } ``` ## Null and empty values Responses can contain partial records. * A field can be `null` when the source does not support it or has no value for the user. * An array can be empty: `[]`. * An object can be empty: `{}`. * An object can contain properties whose values are all `null`. Do not assume a field is present only because its Item reports that field as supported. ## Pagination List endpoints return paginated responses. The default `limit` is 10 and the maximum is 200. ```json theme={} { "next": "https://api-sandbox.argyle.com/v2/users?cursor=NEXT_CURSOR", "previous": null, "results": [ { "id": "018051aa-f7a9-a0db-2f38-6cfa325e9d69" } ] } ``` Follow the complete URL returned in `next` or `previous`. Do not construct cursor values or request pages in parallel. ## Rate limiting The API allows 50 requests per second. Requests above the limit return `429 Too Many Requests`. Queue rate-limited requests and retry them after reducing request volume. Avoid immediate retry loops. ## Concurrency and caching Limit simultaneous requests when retrieving large result sets. This reduces duplicate work and rate limiting. The Argyle API does not use HTTP caching. If your application caches API responses, manage cache freshness within your own systems. ## System status Operational status and incidents are published at [status.argyle.com](https://status.argyle.com/). # Postman Source: https://docs.argyle.com/api-guide/postman The quickest way to test the Argyle API. Copy our public Postman collection to get started testing each endpoint: [![](https://mintcdn.com/argyle/zqWJd3KfgY_JZecH/images/api-guide/postman/postman-button.svg?fit=max\&auto=format\&n=zqWJd3KfgY_JZecH\&q=85\&s=8e07ab9bae4b5398b9173e85aec71f4d)](https://god.gw.postman.com/run-collection/24800167-234f2ed5-ac66-4265-8afe-cd2119292380?action=collection%2Ffork\&collection-url=entityId%3D24800167-234f2ed5-ac66-4265-8afe-cd2119292380%26entityType%3Dcollection%26workspaceId%3Da4918323-bf08-413d-b8d4-c8b7b7f39924) ## How to copy the collection 1. Click the button above. 2. Create or retrieve your Argyle API keys [from Console](https://console.argyle.com/api-keys). 3. Replace the username field on Postman's authorization page with your `Sandbox API Key ID`. 4. Replace the password field on Postman's authorization page with your `Sandbox API key SECRET`. ![Add your API keys on Postman's Authorization tab.](https://mintcdn.com/argyle/0_py1wv-xzxlL1Oi/images/api-guide/postman/postman-01.png?fit=max\&auto=format\&n=0_py1wv-xzxlL1Oi\&q=85\&s=48544269908a087552b5c8bc4a8a3da4) ## Setting environment variables We recommend creating a Sandbox and Production environment via Postman's sidebar, where you can store `{{variable values}}` such as your [API keys](/api-guide/overview#authentication) or [base URLs](/api-guide/overview#environments). This lets you quickly switch between Sandbox and Production when making API calls using the dropdown in the upper right. ![Save environment variables in Postman to quickly switch between using the Sandbox and Production API's.](https://mintcdn.com/argyle/0_py1wv-xzxlL1Oi/images/api-guide/postman/postman-03.png?fit=max\&auto=format\&n=0_py1wv-xzxlL1Oi\&q=85\&s=97739ab69aa91f5b048c684b6b5d8af7) Argyle provides two environments: | Environment | Purpose | Base URL | | - | - | - | | Sandbox | Testing | `https://api-sandbox.argyle.com/v2` | | Production | Real connections | `https://api.argyle.com/v2` | ## Documentation in Postman Clicking on the **Documentation** icon in the upper-right corner will display additional details for each endpoint. ![Image showing how to open Documentation within Postman for the Argyle API collection.](https://mintcdn.com/argyle/0_py1wv-xzxlL1Oi/images/api-guide/postman/postman-02.png?fit=max\&auto=format\&n=0_py1wv-xzxlL1Oi\&q=85\&s=a471fe289d90ab58ee66831c8bcabf93) [API Reference](/api-reference/overview) # Webhooks Source: https://docs.argyle.com/api-guide/webhooks Receive backend notifications when verification, account, and resource state changes. Webhooks notify your backend when an event occurs. Use them to track asynchronous processing instead of repeatedly polling list or retrieve endpoints. Webhook subscriptions apply to every matching event available to the API key. They are not scoped to one user or account. ## Choose events * For verification lifecycles, subscribe to the [`verifications.updated`](/api-reference/verifications-webhooks/updated) webhook and the [`verifications.creation_failed`](/api-reference/verifications-webhooks/creation-failed) webhook. * For Data API workflows, subscribe to the account and data webhooks that indicate when the records your application needs are available. * For Item health changes, subscribe to [Item webhooks](/api-reference/items-webhooks/updated) explicitly. See the [Webhooks area in API Reference](/api-reference/users-webhooks/fully-synced) for available event pages. ## Create a subscription Create subscriptions in [Console](/console/management/webhooks) or with [`POST /v2/webhooks`](/api-reference/webhooks/create-a-webhook). ```json theme={} { "events": [ "verifications.updated" ], "name": "verification-status", "url": "https://your-webhook-backend.com/argyle", "secret": "optional-secret", "config": { "include_resource": true } } ``` | Field | Use | | - | - | | `events` | Event names included in the subscription. | | `name` | Your internal name for the subscription. | | `url` | HTTPS backend URL that receives deliveries. Send the normal, unencoded URL. | | `secret` | Optional value used to sign deliveries. | | `config.include_resource` | Includes the current resource in supported webhook payloads. | `"*"` subscribes to most current events, with important exceptions: * Item webhooks are not included. * Partial-synchronization events cannot define their history window through the wildcard subscription. * Events that support `include_resource` must be subscribed to individually when you need the resource object. ## Receive deliveries Return an HTTP `200` response within 10 seconds after accepting a webhook. Argyle sends webhooks from these static IP addresses: * `34.27.251.226` * `34.122.50.253` * `35.188.163.115` * `35.226.53.251` ## Verify signatures When a subscription has a `secret`, deliveries include `X-Argyle-Signature`. 1. Read the raw request body without parsing or reformatting it. 2. Create an HMAC-SHA512 digest using the subscription secret. 3. Compare the hexadecimal digest with `X-Argyle-Signature` using a timing-safe comparison. ```js theme={} const crypto = require('crypto') function isValidArgyleWebhook(rawBody, receivedSignature, secret) { const expected = crypto .createHmac('sha512', secret) .update(rawBody) .digest('hex') const received = Buffer.from(receivedSignature, 'hex') const calculated = Buffer.from(expected, 'hex') return received.length === calculated.length && crypto.timingSafeEqual(received, calculated) } ``` ## Retry behavior If a successful `200` response is not received within 10 seconds, the delivery is retried once after 30 seconds for these response codes: * `429` * `500` * `502` * `503` * `504` Argyle does not log webhook request bodies. Build idempotent handlers because a delivery can be received more than once. ## Manage subscriptions * [List subscriptions](/api-reference/webhooks/list-all-webhooks) * [Retrieve a subscription](/api-reference/webhooks/retrieve-a-webhook) * [Delete a subscription](/api-reference/webhooks/delete-a-webhook) The subscription object's `last_sent_at` field can help determine whether Argyle attempted a delivery. > [!NOTE] > > Webhooks are lifecycle notifications, not an analytics event stream. Use Console or your own application telemetry for conversion analysis. # Account Connection Errors Source: https://docs.argyle.com/api-reference/account-connection-errors Common causes and troubleshooting. ## Overview Account connection errors occur when a user is actively attempting to connect a payroll account through Link. To monitor for account connection errors: 1. Subscribe to the [`accounts.failed`](/api-reference/accounts-webhooks/failed) webhook. 2. Subscribe to the [`accounts.updated`](/api-reference/accounts-webhooks/updated) webhook and use the optional `config` parameter to receive an account object in the webhook's delivery payload. 3. When you receive the `accounts.failed` webhook or are encountering account connection issues, check the account object in payload of the `accounts.updated` webhook. If the `status` value of the `connection` object is `error`, proceed to the troubleshooting steps below. > [!NOTE] > > The `accounts.updated` webhook is always sent when the `accounts.failed` webhook is sent. ## Account connection errors ### `account_disabled` > [tab] Common causes > > An account may be disabled or taken offline for a variety of reasons, such as account inactivity. > [tab] User message > > Your employment account appears to be disabled. Please make sure your account is active in the \[Company name] system and try again. > [tab] API message > > This user's employment account appears to be suspended or disabled. > [tab] Troubleshooting > > Advise the user to contact their payroll provider for further clarification. ![](https://mintcdn.com/argyle/0_py1wv-xzxlL1Oi/images/account-connection-errors/image_1.png?fit=max\&auto=format\&n=0_py1wv-xzxlL1Oi\&q=85\&s=57d3ae0f9bf605bb84ce1c7f8b3d8b98) ### `account_inaccessible` > [tab] Common causes > > The users's payroll account could not be connected. This may happen if the account is inactive, onboarding is not complete, or the Terms of Service have not been accepted. > [tab] User message > > Your account setup isn't finished. Log in to \[Company name], accept the terms of service, and complete your onboarding, then return here. > [tab] API message > > This user's account is not currently accessible. Our team has been notified and is investigating. > [tab] Troubleshooting > > Ask the user to: > > 1. Log in directly to their payroll account. > 2. Ensure their account is active, onboarding is fully complete, and all Terms of Service are accepted. > 3. Once everything is up to date, ask the user to try again. ![](https://mintcdn.com/argyle/NK4HkfiJ6Kk1HQgi/images/account-connection-errors/image_2.png?fit=max\&auto=format\&n=NK4HkfiJ6Kk1HQgi\&q=85\&s=b32dd6d2c73408a3c4a19d56e7614787) ### `account_incomplete` > [!NOTE] > > The [accounts.failed](/api-reference/accounts-webhooks/failed) webhook is sent when this error occurs. > [tab] Common causes > > The user has not finished setting up an account within their payroll system. > [tab] User message > > Your \[Company name] account isn't active. Log in to \[Company name] and finish setting up your account, then return here. > [tab] API message > > This user's employment account is not yet active. > [tab] Troubleshooting > > Advise the user to complete the onboarding or account set-up process in their payroll system, or contact their payroll provider for additional help. ![](https://mintcdn.com/argyle/NK4HkfiJ6Kk1HQgi/images/account-connection-errors/image_3.png?fit=max\&auto=format\&n=NK4HkfiJ6Kk1HQgi\&q=85\&s=4c4456330fdc868e1d5d4bca9a884615) ### `account_nonunique` > [!NOTE] > > The [accounts.failed](/api-reference/accounts-webhooks/failed) webhook is sent when this error occurs. > [tab] Common causes > > The personal details provided by the user during the Login help process of certain Items was a match for multiple account records stored by the payroll platform, resulting in an error. > [tab] User message > > The information you provided is not unique, and multiple matching records were found. For assistance, please contact your employer's HR or Payroll department. > [tab] API message > > The information provided by the user is not unique. Multiple records match their details. They should contact their employer's HR or Payroll department for assistance. > [tab] Troubleshooting > > Advise the user to double-check what personal details they currently or originally used to log in directly to the payroll platform, or contact their employer's HR or Payroll department for assistance. ![](https://mintcdn.com/argyle/0_py1wv-xzxlL1Oi/images/account-connection-errors/image_4.png?fit=max\&auto=format\&n=0_py1wv-xzxlL1Oi\&q=85\&s=a01ce90461c86eba4bc2317c3da754bb) ### `account_not_found` > [!NOTE] > > The [accounts.failed](/api-reference/accounts-webhooks/failed) webhook is sent when this error occurs. > [tab] Common causes > > The personal details provided by the user during the Login help process of certain Items did not match an account record stored by the payroll platform. > [tab] User message > > No matching record found. Please review your entries and try again. > [tab] API message > > The user did not provide correct personal details to verify their identity and locate their record. > [tab] Troubleshooting > > Advise the user to double-check what personal details they currently or originally used to log in directly to the payroll platform. ![](https://mintcdn.com/argyle/0_py1wv-xzxlL1Oi/images/account-connection-errors/image_5.png?fit=max\&auto=format\&n=0_py1wv-xzxlL1Oi\&q=85\&s=253bedf3a1eadbb54a4f7f2457366caf) ### `all_employers_connected` > [tab] Common causes > > The user has already connected all accounts associated with the recovery details (name, phone number, and/or email) they provided during the **Login help** process of certain Items. > [tab] User message > > All your \[Company name] employers are connected. Check your details or select another employer or payroll provider. > [tab] API message > > The user attempted to connect an account that is already connected. > [tab] Troubleshooting > > Advise the user to double-check what personal details they currently or originally used to log in directly to the payroll platform for the intended employer. ![](https://mintcdn.com/argyle/0_py1wv-xzxlL1Oi/images/account-connection-errors/image_6.png?fit=max\&auto=format\&n=0_py1wv-xzxlL1Oi\&q=85\&s=67cb0580ddccdc72c0936911ccb34267) ### `auth_method_temporarily_unavailable` > [!NOTE] > > The [accounts.failed](/api-reference/accounts-webhooks/failed) webhook is sent when this error occurs. > [tab] Common causes > > The selected connection method is currently unavailable. > [tab] User message > > We can't complete the connection using this method right now. Try logging in with an alternative method. > [tab] API message > > The authentication method the user selected is temporarily unavailable. > [tab] Troubleshooting > > Users will be directed to an alternative login option to establish a connection. If they are still unable to connect, advise them to wait and retry later to see if the original method has become available. ![](https://mintcdn.com/argyle/D587Ireo7wqxclC_/images/account-connection-errors/image_40.png?fit=max\&auto=format\&n=D587Ireo7wqxclC_\&q=85\&s=666455dac5037767143cbf98373cf1ca) ### `auth_required` > [tab] Common causes > > An account has become disconnected and needs to be [re-authenticated](/workflows/reconnecting-accounts). > [tab] User message > > Please reconnect your \[Company name] account to continue sharing data with \[Your company name]. > [tab] API message > > This user's connection has expired and requires re-authentication. > [tab] Troubleshooting > > Follow the steps in our [Reconnecting Accounts Guide](/workflows/reconnecting-accounts) to allow the user to return to Link and reconnect their disconnected account. ![](https://mintcdn.com/argyle/0_py1wv-xzxlL1Oi/images/account-connection-errors/image_7.png?fit=max\&auto=format\&n=0_py1wv-xzxlL1Oi\&q=85\&s=824713e6d666d28125a21ddcc54f4688) ### `connection_unavailable` > [!NOTE] > > The [accounts.failed](/api-reference/accounts-webhooks/failed) webhook is sent when this error occurs. > [tab] Common causes > > A new connection attempt was unsuccessful because the account was unavailable. > [tab] User message > > This service is currently experiencing connectivity issues. Please try again or use another connection method. > [tab] API message > > The platform this user is attempting to connect to is currently unavailable. See the Coverage page in Argyle Console for additional information. > [tab] Troubleshooting > > Find which Item was unavailable in Link by filtering the [Connections](https://console.argyle.com/connections) section of Console by **Attempted** status. Search for and select the Item within the [Coverage](https://console.argyle.com/coverage) section of Console to read more about issues the underlying platform is experiencing. The API's [`/items`](/api-reference/items) endpoint also provides information on when issues occur, and when they are expected to be resolved. ![](https://mintcdn.com/argyle/0_py1wv-xzxlL1Oi/images/account-connection-errors/image_8.png?fit=max\&auto=format\&n=0_py1wv-xzxlL1Oi\&q=85\&s=7f8b3ad5fd59c92439631e365f76c272) ### `credentials_managed_by_organization` > [!NOTE] > > The [accounts.failed](/api-reference/accounts-webhooks/failed) webhook is sent when this error occurs. > [tab] Common causes > > The credentials provided by the user during the **Login help** process of certain Items could not be adjusted in a self-service way because their credentials are centrally managed by their organization's IT department for security reasons. > [tab] User message > > Only your IT administrator can reset your password. Ask them to reset it, then log in with your new password. > [tab] API message > > The user's credentials are managed by their organization. > [tab] Troubleshooting > > Advise the user to reach out to their organization's IT department for help recovering their user ID or resetting their password. ![](https://mintcdn.com/argyle/NK4HkfiJ6Kk1HQgi/images/account-connection-errors/image_9.png?fit=max\&auto=format\&n=NK4HkfiJ6Kk1HQgi\&q=85\&s=fa29f8df5814982b2e9bce352dbd8104) ### `existing_account_found` > [tab] Common causes > > The user attempted to connect an already-connected account during the **Login help** process of certain Items. > [tab] User message > > This account is already connected. Check your details or select another employer or payroll provider. > [tab] API message > > The user attempted to connect an account that is already connected. > [tab] Troubleshooting > > Advise the user to double-check what personal details they currently or originally used to log in directly to the payroll platform for the intended employer. ![](https://mintcdn.com/argyle/0_py1wv-xzxlL1Oi/images/account-connection-errors/image_10.png?fit=max\&auto=format\&n=0_py1wv-xzxlL1Oi\&q=85\&s=d22816ee581979f201827df83a666405) ### `expired_credentials` > [!NOTE] > > The [accounts.failed](/api-reference/accounts-webhooks/failed) webhook is sent when this error occurs. > [tab] Common causes > > Some payroll platforms require users to periodically update their login credentials. > [tab] User message > > Your login credentials have expired. Please reset the password for your \[Company name] account and try again. > [tab] API message > > This user provided credentials which are out of date so a password reset is required. > [tab] Troubleshooting > > Follow the steps in the [expired credentials](/workflows/reconnecting-accounts#expired-credentials) section of our Reconnecting Accounts Guide, or ask the user to visit their payroll system directly to change their login credentials. ![](https://mintcdn.com/argyle/0_py1wv-xzxlL1Oi/images/account-connection-errors/image_11.png?fit=max\&auto=format\&n=0_py1wv-xzxlL1Oi\&q=85\&s=4f74f1500d06124c1678b266198a483c) ### `full_auth_required` > [tab] Common causes > > This error is manually set by Argyle after investigating a previous error. > [tab] User message > > We were unable to connect your \[Company name] account. Please try to connect again. > [tab] API message > > This user's connection has expired and requires re-authentication. > [tab] Troubleshooting > > Follow the steps in our [Reconnecting Accounts Guide](/workflows/reconnecting-accounts) to allow the user to return to Link and reconnect their disconnected account. The user will need to re-enter their login credentials. ![](https://mintcdn.com/argyle/0_py1wv-xzxlL1Oi/images/account-connection-errors/image_12.png?fit=max\&auto=format\&n=0_py1wv-xzxlL1Oi\&q=85\&s=630312f6fddca21a22b2c6e99187bb77) ### `insufficient_account_data` > [!NOTE] > > The [accounts.failed](/api-reference/accounts-webhooks/failed) webhook is sent when this error occurs. > [tab] Common causes > > The user's employment account has paystubs and tax documents available but lacks essential profile information (e.g., name, employment status) needed for a full verification. > [tab] User message > > Your employment account doesn't have the necessary data to proceed. Please try connecting a different account. > [tab] API message > > This user's employment account does not contain sufficient data to proceed. The user should be prompted to connect an alternative account. > [tab] Troubleshooting > > If the account is missing critical data that you need, prompt the user to connect a different employment account that may have the necessary information. ![](https://mintcdn.com/argyle/D587Ireo7wqxclC_/images/account-connection-errors/image_41.png?fit=max\&auto=format\&n=D587Ireo7wqxclC_\&q=85\&s=5d84978a5ee8e0431422ee0a399623e0) ### `invalid_account_type` > [!NOTE] > > The [accounts.failed](/api-reference/accounts-webhooks/failed) webhook is sent when this error occurs. > [tab] Common causes > > The user may have entered login credentials for the employer or payroll provider that are not related to their payroll credentials. > [tab] User message > > This is an unsupported account type (e.g. a rider account instead of a driver account). Please log in with credentials for your employment-related account with \[Company name]. > [tab] API message > > This user provided credentials for the wrong account type (e.g., a passenger account rather than a driver account, or an admin account rather than an employee account). > [tab] Troubleshooting > > Confirm that the user entered their correct payroll login credentials. If so, ask them if they are able to log in to their payroll system directly. ![](https://mintcdn.com/argyle/0_py1wv-xzxlL1Oi/images/account-connection-errors/image_13.png?fit=max\&auto=format\&n=0_py1wv-xzxlL1Oi\&q=85\&s=3ead3d35fb42ad2177c878e447782a46) ### `invalid_auth` > [!NOTE] > > The [accounts.failed](/api-reference/accounts-webhooks/failed) webhook is sent when this error occurs. > [tab] Common causes > > The user entered invalid login credentials to their payroll system, or was unable to successfully complete its multi-factor authentication (MFA) process. > [tab] User message > > Check your credentials. If you recently changed your two-step verification method, make sure it's configured correctly in \[Company name]. > [tab] API message > > This user's account connection was unsuccessful due to invalid credentials or due to failed or misconfigured multi-factor authentication (MFA). > [tab] Troubleshooting > > Check whether the user was presented with or had trouble completing an MFA process. If so, advise them to check their MFA settings directly in their payroll platform before trying again. If not, confirm that the user entered the correct login credentials by asking them or having them try logging in directly to the payroll platform. ![](https://mintcdn.com/argyle/NK4HkfiJ6Kk1HQgi/images/account-connection-errors/image_14.png?fit=max\&auto=format\&n=NK4HkfiJ6Kk1HQgi\&q=85\&s=70e054734f189b4c4747d01fed619b4a) ### `invalid_credentials` > [!NOTE] > > The [accounts.failed](/api-reference/accounts-webhooks/failed) webhook is sent when this error occurs. > [tab] Common causes > > The user may have entered login credentials for the employer or payroll provider that are not related to their payroll credentials. > [tab] User message > > Invalid credentials. Try again or get help logging in. > [tab] API message > > This user provided invalid credentials. > [tab] Troubleshooting > > Confirm that the user entered their correct payroll login credentials. Ask the user if they are able to log in to their payroll system directly. If so, advise the user to change their password and try again. ![](https://mintcdn.com/argyle/0_py1wv-xzxlL1Oi/images/account-connection-errors/image_15.png?fit=max\&auto=format\&n=0_py1wv-xzxlL1Oi\&q=85\&s=1e510fff584272824d87ccfa3be093a3) ### `invalid_employer_identifier` > [!NOTE] > > The [accounts.failed](/api-reference/accounts-webhooks/failed) webhook is sent when this error occurs. > [tab] Common causes > > The user entered invalid login information related to the employer, such as an invalid company ID. > [tab] User message > > Invalid Company details. Try again or get help logging in. > [tab] API message > > This user provided invalid company/employer identifier. > [tab] Troubleshooting > > Confirm that the user entered their correct payroll login credentials and employer-related identifier(s). ![](https://mintcdn.com/argyle/D587Ireo7wqxclC_/images/account-connection-errors/image_42.png?fit=max\&auto=format\&n=D587Ireo7wqxclC_\&q=85\&s=831e6bf6a72dbe16bab9fc9f8dbab122) ### `invalid_login_method` > [!NOTE] > > The [accounts.failed](/api-reference/accounts-webhooks/failed) webhook is sent when this error occurs. > [tab] Common causes > > This platform currently supports login methods for this payroll account that are different than the one attempted by the user when trying to connect. > [tab] User message > > Your Company ID cannot be used with selected login method. Please use a different login method. > [tab] API message > > This user tried to log in using an authentication method that is not supported by employer. > [tab] Troubleshooting > > Advise the user to select a different available login method. Specific employers sometimes restrict logins to a default method or SSO, despite the payroll platform supporting additional login methods. ![](https://mintcdn.com/argyle/0_py1wv-xzxlL1Oi/images/account-connection-errors/image_16.png?fit=max\&auto=format\&n=0_py1wv-xzxlL1Oi\&q=85\&s=2567ecc44f3e14d40c09d389660064ea) ### `invalid_login_url` > [!NOTE] > > The [accounts.failed](/api-reference/accounts-webhooks/failed) webhook is sent when this error occurs. > [tab] Common causes > > Some payroll platforms will successfully authenticate users when they use valid login credentials but throw an error because the wrong employer or payroll provider was selected. > [tab] User message > > You have successfully logged in, but no corresponding user could be found. Search for your employer or payroll provider. > [tab] API message > > The user provided the correct login credentials, but no corresponding account was found. The user should try again by selecting the appropriate Link item for their employer or payroll provider. > [tab] Troubleshooting > > Advise the user to connect their account using a Link item that represents their specific employer or payroll provider. ![](https://mintcdn.com/argyle/0_py1wv-xzxlL1Oi/images/account-connection-errors/image_17.png?fit=max\&auto=format\&n=0_py1wv-xzxlL1Oi\&q=85\&s=d8f9a6526cc8bf11550e418ef1463821) ### `invalid_mfa` > [tab] Common causes > > This user did not provide the correct multi-factor authentication (MFA) response that was requested by the platform. > [tab] User message > > Multi-factor authentication was not successful. Please try again. > [tab] API message > > This user did not provide the correct multi-factor authentication response. > [tab] Troubleshooting > > Confirm the user received the MFA request. If so, see if the user encountered problems completing it. Advise them to check their MFA settings directly in their payroll platform to confirm which MFA method is configured. Lastly, see if the issue persists when the user logs in directly to their payroll account. ![](https://mintcdn.com/argyle/KruW4zEDZXEu3HJD/images/account-connection-errors/image_18.png?fit=max\&auto=format\&n=KruW4zEDZXEu3HJD\&q=85\&s=92e83c28a4946feb3c04069c94606a9b) ### `invalid_store_identifier` > [!NOTE] > > The [accounts.failed](/api-reference/accounts-webhooks/failed) webhook is sent when this error occurs. > [tab] Common causes > > The user entered invalid login information related to their store or club, such as an invalid store number. > [tab] User message > > Invalid Store/Club Number. Try again or get help logging in. > [tab] API message > > This user provided invalid store/club number. > [tab] Troubleshooting > > Confirm that the user entered their correct payroll login credentials and store-related identifier(s). ![](https://mintcdn.com/argyle/D587Ireo7wqxclC_/images/account-connection-errors/image_43.png?fit=max\&auto=format\&n=D587Ireo7wqxclC_\&q=85\&s=f7c76d9d730bd3452aa3713958117fca) ### `known_employer_redirect` > [tab] Common causes > > The user was successfully redirected to their employer’s login screen after providing information that identified their employer. > [tab] User message > > No error message. User was redirected to Link's login screen. > [tab] API message > > This user was redirected to a specific employer login after starting with the generic flow because a known employer was identified. > [tab] Troubleshooting > > Advise the user to enter their credentials to complete the login process. ![](https://mintcdn.com/argyle/DaPM86XFQjcgymtA/images/account-connection-errors/image_48.png?fit=max\&auto=format\&n=DaPM86XFQjcgymtA\&q=85\&s=4f10a85e198f21f9b8daf0b69d0b2716) ### `login_attempts_exceeded` > [!NOTE] > > The [accounts.failed](/api-reference/accounts-webhooks/failed) webhook is sent when this error occurs. > [tab] Common causes > > The platform temporarily disabled login attempts for this payroll account due to entering invalid credentials too many times. > [tab] User message > > Too many failed login attempts. Wait a few hours, or reset your password in \[Company name] to unlock now. > [tab] API message > > This user provided invalid credentials too many times, causing them to be temporarily unable to attempt further logins. > [tab] Troubleshooting > > Advise the user to wait a few hours before attempting to connect their account again. ![](https://mintcdn.com/argyle/NK4HkfiJ6Kk1HQgi/images/account-connection-errors/image_19.png?fit=max\&auto=format\&n=NK4HkfiJ6Kk1HQgi\&q=85\&s=ad11355fa68f6a5cc76dcc79bca6970e) ### `login_cancelled_by_the_user` > [tab] Common causes > > The user exited Link’s login screen before submitting credentials during a multi-step login flow used by certain Items. > [tab] User message > > No error message. User moved to a different page or exited Link. > [tab] API message > > The user canceled the login process during the credential entry step. > [tab] Troubleshooting > > Advise the user to re-attempt the connection and complete the login process. ![](https://mintcdn.com/argyle/DaPM86XFQjcgymtA/images/account-connection-errors/image_49.png?fit=max\&auto=format\&n=DaPM86XFQjcgymtA\&q=85\&s=de4fd4d03b6fcf34c2a1752966f911dd) ### `login_gov_not_linked` > [!NOTE] > > The [accounts.failed](/api-reference/accounts-webhooks/failed) webhook is sent when this error occurs. > [tab] Common causes > > The user's Login.gov single sign-on is not linked to the platform or employer they are trying to connect. > [tab] User message > > Your Login.gov account is not linked to \[Company name]. Please log in to \[Company name], configure your Login.gov access, and try again. > [tab] API message > > Account connection failed because the user's Login.gov SSO is not linked to this platform or employer. > [tab] Troubleshooting > > Advise the user to log in to the platform or employer directly, configure their Login.gov access, and retry the account connection. ![](https://mintcdn.com/argyle/AYGFFq4bV78E-21W/images/account-connection-errors/image_51.png?fit=max\&auto=format\&n=AYGFFq4bV78E-21W\&q=85\&s=24bf0580ffd28c5215e91f1c4458b8c0) ### `mfa_attempts_exceeded` > [!NOTE] > > The [accounts.failed](/api-reference/accounts-webhooks/failed) webhook is sent when this error occurs. > [tab] Common causes > > The platform permanently disabled login attempts for this payroll account due to entering an invalid MFA too many times. It only can be resolved by the user resetting MFA directly on the payroll system. > [tab] User message > > Too many failed two-step verification attempts. Log in to \[Company name] and reset your 2FA in Security settings, then return here. > [tab] API message > > This user failed multi-factor authentication too many times, causing them to be unable to attempt further logins until multi-factor authentication method is reset. > [tab] Troubleshooting > > Advise the user to reset their MFA method on the platform's website or app, and then re-attempt account connection. ![](https://mintcdn.com/argyle/NK4HkfiJ6Kk1HQgi/images/account-connection-errors/image_20.png?fit=max\&auto=format\&n=NK4HkfiJ6Kk1HQgi\&q=85\&s=a27264eb5db1a5a105cb9cc7b4933b24) ### `mfa_cancelled_by_the_user` > [tab] Common causes > > The user exited the MFA screen during an account connection. > [tab] User message > > No error message. Users return to the login screen after exiting the MFA screen. > [tab] API message > > This user canceled the Multi-Factor Authentication (MFA) step. > [tab] Troubleshooting > > The user may have exited the MFA process after entering an incorrect phone number or other typo error. Have the user retry the connection and ensure they are providing the correct MFA information for the account. ![](https://mintcdn.com/argyle/0_py1wv-xzxlL1Oi/images/account-connection-errors/image_21.png?fit=max\&auto=format\&n=0_py1wv-xzxlL1Oi\&q=85\&s=c21ab684c920b155c832455414fd3f84) ### `mfa_exhausted` > [!NOTE] > > The [accounts.failed](/api-reference/accounts-webhooks/failed) webhook is sent when this error occurs. > [tab] Common causes > > The platform requires a full re-authentication for this payroll account due to unsuccessfully completing MFA multiple times. > [tab] User message > > Your account is locked after too many failed two-step verification attempts. Log in to \[Company name] to unlock it, then return here. > [tab] API message > > This user failed multi-factor authentication too many times, requiring them to re-authenticate. > [tab] Troubleshooting > > Advise the user to sign in directly to their payroll platform and unlock or reset their MFA method, then retry the connection. ![](https://mintcdn.com/argyle/NK4HkfiJ6Kk1HQgi/images/account-connection-errors/image_22.png?fit=max\&auto=format\&n=NK4HkfiJ6Kk1HQgi\&q=85\&s=4e920c3b575b3d0f2c6b7d86a20fe8f1) ### `mfa_not_configured` > [!NOTE] > > The [accounts.failed](/api-reference/accounts-webhooks/failed) webhook is sent when this error occurs. > [tab] Common causes > > The payroll platform requires multi-factor authentication (MFA) to access payroll data. > [tab] User message > > Two-step verification isn't set up on your \[Company name] account. Log in to \[Company name] and set up 2FA in Account settings, then return here. > [tab] API message > > This user has not configured multi-factor authentication for their employment account, restricting access to the user's employment data. > [tab] Troubleshooting > > Advise the user to sign in directly to their payroll platform and configure an MFA method, then retry the connection. ![](https://mintcdn.com/argyle/NK4HkfiJ6Kk1HQgi/images/account-connection-errors/image_23.png?fit=max\&auto=format\&n=NK4HkfiJ6Kk1HQgi\&q=85\&s=972eded3a909975f890dd3525dc1901f) ### `mfa_timeout` > [!NOTE] > > The [accounts.failed](/api-reference/accounts-webhooks/failed) webhook is sent when this error occurs. > [tab] Common causes > > The user did not complete MFA within the given time period. > [tab] User message > > Your multi-factor authentication (MFA) session has expired. Please log in again to complete the MFA process. > [tab] API message > > This user did not complete multi-factor authentication. > [tab] Troubleshooting > > Advise the user to retry and complete the MFA prompt in one session. If they do not receive the expected prompt or code, advise them to check which MFA method is configured in their payroll platform. ![](https://mintcdn.com/argyle/0_py1wv-xzxlL1Oi/images/account-connection-errors/image_24.png?fit=max\&auto=format\&n=0_py1wv-xzxlL1Oi\&q=85\&s=c5b3774330640c3e762146dbefe0dbc8) ### `multi_driver_account` > [!NOTE] > > The [accounts.failed](/api-reference/accounts-webhooks/failed) webhook is sent when this error occurs. > [tab] Common causes > > This error occurs when a gig rideshare account is connected that has multiple drivers associated with it. Argyle only supports single-driver accounts due to data privacy. > [tab] User message > > This account type is not supported because it contains information for multiple drivers. > [tab] API message > > The user attempted to connect an unsupported account type - the account contains multiple driver information. > [tab] Troubleshooting > > The user will need to connect a different account such as a personal account that is associated with only one driver. ![](https://mintcdn.com/argyle/D587Ireo7wqxclC_/images/account-connection-errors/image_44.png?fit=max\&auto=format\&n=D587Ireo7wqxclC_\&q=85\&s=c111f06af7b43cdff6e38bd59cc7247c) ### `ongoing_refresh_disabled` > [!NOTE] > > The [accounts.updated](/api-reference/accounts-webhooks/updated) webhook is sent when this error occurs. > [tab] Common causes > > Ongoing refresh was [manually disabled](/api-reference/accounts/disable-account-updates) via the API for this account. > [tab] User message > > Please reconnect your \[Company name] account to continue sharing data with \[Your company name]. > [tab] API message > > Ongoing refresh was disabled for this account. To resume ongoing refresh the user needs to reconnect the account. > [tab] Troubleshooting > > After ongoing refresh is disabled, the user will experience this account connection error if they return to the account in Link. Ongoing refresh will be re-enabled if the user selects **Reconnect**. ![](https://mintcdn.com/argyle/0_py1wv-xzxlL1Oi/images/account-connection-errors/image_25.png?fit=max\&auto=format\&n=0_py1wv-xzxlL1Oi\&q=85\&s=e9f8ff43ea4bb4d37496f32d702f6f06) ### `passkey_limit_reached` > [tab] Common causes > > The user has reached the maximum number of passkeys allowed on the platform. > [tab] User message > > Your payroll account has the maximum number of passkeys. Remove a passkey you don't use in your account settings, then try again. > [tab] API message > > The user's payroll account has reached the maximum number of registered passkeys. The user must remove at least one passkey and try again. > [tab] Troubleshooting > > Advise the user to remove a passkey then retry their account connection. ![](https://mintcdn.com/argyle/D587Ireo7wqxclC_/images/account-connection-errors/image_45.png?fit=max\&auto=format\&n=D587Ireo7wqxclC_\&q=85\&s=49f401f2299c3cb94fdc3a36c47831a1) ### `personal_data_access_not_granted` > [!NOTE] > > The [accounts.failed](/api-reference/accounts-webhooks/failed) webhook is sent when this error occurs. > [tab] Common causes > > Recently created accounts or accounts that have not been active for an extended period of time may be required to grant permission to access or share their personal data. > [tab] User message > > Your employment account could not be connected. Please make sure you have granted \[Company name] permission to access your personal data. > [tab] API message > > The user has not authorized access to their personal data. > [tab] Troubleshooting > > Advise the user to log in to their account directly to grant data access. ![](https://mintcdn.com/argyle/1lz3K7T8O9U_KBdn/images/account-connection-errors/image_50.png?fit=max\&auto=format\&n=1lz3K7T8O9U_KBdn\&q=85\&s=16d6e0db6e84caa0400ffd98e881265a) ### `physical_mfa_unsupported` > [!NOTE] > > The [accounts.failed](/api-reference/accounts-webhooks/failed) webhook is sent when this error occurs. > [tab] Common causes > > The user attempted to use a **physical** multi-factor authentication method that Argyle does not support. > [tab] User message > > A physical security key isn't supported here. Log in to \[Company name], disable it, and set up a supported 2FA method, then return here. > [tab] API message > > This user's employment account uses a physical multi-factor authentication method that Argyle does not currently support. > [tab] Troubleshooting > > Ask the user to update their settings or switch to an alternative multi-factor authentication method and try again. ![](https://mintcdn.com/argyle/NK4HkfiJ6Kk1HQgi/images/account-connection-errors/image_26.png?fit=max\&auto=format\&n=NK4HkfiJ6Kk1HQgi\&q=85\&s=68b8f17ec0d103526dbc2306717492d2) ### `platform_temporarily_unavailable` > [!NOTE] > > The [accounts.failed](/api-reference/accounts-webhooks/failed) webhook is sent when this error occurs. > [tab] Common causes > > The account's underlying payroll system is experiencing connection issues. New connections are temporarily unavailable. > [tab] User message > > We're having trouble connecting right now. Please check back in a few hours and try again. > [tab] API message > > The platform this user is attempting to connect to is temporarily unavailable. > [tab] Troubleshooting > > Advise the user to wait a few hours and then re-attempt to connect their account. > > When the platform once again becomes available, the account's error status will be switched from this error to the `full_auth_required` error. You can use this to automate when to [return the user to Link](/workflows/reconnecting-accounts) to re-attempt their account connection. ![](https://mintcdn.com/argyle/0_py1wv-xzxlL1Oi/images/account-connection-errors/image_27.png?fit=max\&auto=format\&n=0_py1wv-xzxlL1Oi\&q=85\&s=292e1a7d149a8c54760e998180154744) ### `platform_unavailable` > [!NOTE] > > The [accounts.failed](/api-reference/accounts-webhooks/failed) webhook is sent when this error occurs. > [tab] Common causes > > The underlying payroll system limits connections to business hours. > [tab] User message > > \[Company name] system is currently unavailable. Please try again during the service hours (Eastern time): Monday - Friday 5AM - 1AM, Saturday 5AM - 11PM, Sunday 8AM - 11PM. > [tab] API message > > The platform this user is attempting to connect to is currently unavailable. See the [Coverage](/workflows/reconnecting-accounts) page in Console for additional information. > [tab] Troubleshooting > > Advise the user to re-attempt the connection when normal service resumes: (Eastern time): Monday - Friday 5AM - 1AM, Saturday 5AM - 11PM, Sunday 8AM - 11PM. ![](https://mintcdn.com/argyle/0_py1wv-xzxlL1Oi/images/account-connection-errors/image_28.png?fit=max\&auto=format\&n=0_py1wv-xzxlL1Oi\&q=85\&s=caf747246a91a9e4ed0f73d61431d970) ### `service_unavailable` > [!NOTE] > > The [accounts.failed](/api-reference/accounts-webhooks/failed) webhook is sent when this error occurs. > [tab] Common causes > > The payroll system may be offline due to planned maintenance or is experiencing service interruptions. > [tab] User message > > \[Company name] system is currently unavailable. Please try again later. > [tab] API message > > The platform this user is attempting to connect to is currently unavailable. See the Coverage page in Argyle Console for additional information. > [tab] Troubleshooting > > Use Console's [Coverage](https://console.argyle.com/coverage) page or the [Items API endpoint](/api-reference/items) to view the Item's health status and any additional details. If there are underlying issues, advise the user that service will resume shortly and to await further updates. If there are no known issues, ask the user to re-attempt the account connection. ![](https://mintcdn.com/argyle/0_py1wv-xzxlL1Oi/images/account-connection-errors/image_29.png?fit=max\&auto=format\&n=0_py1wv-xzxlL1Oi\&q=85\&s=2318345aa48d3ddf1f43790b7cb47ddd) ### `session_limit_reached` > [!NOTE] > > The [accounts.failed](/api-reference/accounts-webhooks/failed) webhook is sent when this error occurs. > [tab] Common causes > > Some platforms impose limits on the number of active sessions. If a user has reached this limit by being logged into the platform on another device or window, Argyle will not initiate a new connection to avoid disconnecting the user from their other active sessions. > [tab] User message > > \[Company name] limits active connections. Sign out of the \[Company name] app, wait 10 minutes, then return here. > [tab] API message > > This user's account connection was unsuccessful due to the platform's limit on active sessions. > [tab] Troubleshooting > > Advise the user to sign out from any other devices or sessions where the platform is currently active. ![](https://mintcdn.com/argyle/NK4HkfiJ6Kk1HQgi/images/account-connection-errors/image_30.png?fit=max\&auto=format\&n=NK4HkfiJ6Kk1HQgi\&q=85\&s=3e9d6e67447caba0e7ffd6e9ddf78138) ### `system_error` > [!NOTE] > > The [accounts.failed](/api-reference/accounts-webhooks/failed) webhook is sent when this error occurs. > [tab] Common causes > > An unexpected error occurred, such as an invalid session or unavailable service. > [tab] User message > > We've encountered an unexpected error. Please try again later. > [tab] API message > > Argyle encountered a problem connecting to this account. Our team has been notified and is investigating. > [tab] Troubleshooting > > No action needed. We have automatically been notified and will investigate. Reach out to our customer support team for more information. ![](https://mintcdn.com/argyle/0_py1wv-xzxlL1Oi/images/account-connection-errors/image_31.png?fit=max\&auto=format\&n=0_py1wv-xzxlL1Oi\&q=85\&s=b3930be1987abbb5cdf9bde8ed949512) ### `temporary_credentials` > [!NOTE] > > The [accounts.failed](/api-reference/accounts-webhooks/failed) webhook is sent when this error occurs. > [tab] Common causes > > The user attempted to connect an account with a temporary password. > [tab] User message > > You're using a temporary password. Please log in to \[Company name] directly to set a permanent password, then return here to connect. > [tab] API message > > The user provided a temporary password. A permanent password must be set via the payroll provider's website before continuing. > [tab] Troubleshooting > > Advise the user to set a permanent password on their platform using the temporary password. Have the user try again once they are able to log in directly to the platform with their permanent password. ![](https://mintcdn.com/argyle/fvoE1rgQjlBBzrQl/images/account-connection-errors/image_47.png?fit=max\&auto=format\&n=fvoE1rgQjlBBzrQl\&q=85\&s=eeeea53abee7464cfed958046ea3594e) ### `tos_required` > [!NOTE] > > The [accounts.failed](/api-reference/accounts-webhooks/failed) webhook is sent when this error occurs. > [tab] Common causes > > The payroll system requires the user to accept the Terms of Service to allow access to the payroll account or its data. > [tab] User message > > You need to accept \[Company name]'s updated terms before connecting. Log in to \[Company name] to accept them, then return here. > [tab] API message > > This user has not accepted the Terms of Service presented by their payroll provider, preventing access to their employment account. > [tab] Troubleshooting > > Advise the user to log in directly to their payroll system and accept the Terms of Service, or reach out to their payroll provider for further clarification. ![](https://mintcdn.com/argyle/NK4HkfiJ6Kk1HQgi/images/account-connection-errors/image_32.png?fit=max\&auto=format\&n=NK4HkfiJ6Kk1HQgi\&q=85\&s=a00ecb06fd1e3a1539b2266dec3e325b) ### `trial_connections_exhausted` > [!NOTE] > > The [accounts.failed](/api-reference/accounts-webhooks/failed) webhook is sent when this error occurs. > [tab] Common causes > > This account could not be connected because you've reached your limit for free account connections in Argyle's trial mode. > [tab] User message > > Connection is currently unavailable. Please reach out to \[Company name] for help. > [tab] API message > > This account could not be connected because you've reached your limit for free account connections in trial mode. Reach out to Argyle or visit Argyle Console to enable full access and connect unlimited accounts. > [tab] Troubleshooting > > Contact us or visit Console to enable full access and connect unlimited accounts. ![](https://mintcdn.com/argyle/0_py1wv-xzxlL1Oi/images/account-connection-errors/image_33.png?fit=max\&auto=format\&n=0_py1wv-xzxlL1Oi\&q=85\&s=9fa8307a3f949883408db3a0afed8acb) ### `trial_period_expired` > [!NOTE] > > The [accounts.failed](/api-reference/accounts-webhooks/failed) webhook is sent when this error occurs. > [tab] Common causes > > This user's payroll account was a trial account on the payroll system's platform, and is currently disabled because the trial period has expired. > [tab] User message > > Your employment account is a trial account that has expired. Please log in to \[Company name] system to reactivate your account and try again. > [tab] API message > > This user's employment account is in a trial account, and is currently disabled because the trial period has expired. > [tab] Troubleshooting > > Advise the user to contact their payroll provider for further clarification. ![](https://mintcdn.com/argyle/0_py1wv-xzxlL1Oi/images/account-connection-errors/image_34.png?fit=max\&auto=format\&n=0_py1wv-xzxlL1Oi\&q=85\&s=40f71966cb73ce755b015758b7bb8b85) ### `unrecognized_employer_email` > [!NOTE] > > The [accounts.failed](/api-reference/accounts-webhooks/failed) webhook is sent when this error occurs. > [tab] Common causes > > The user entered an email address during login with a domain address that is not associated with the selected employer. > [tab] User message > > The email provided does not match the employer. Please use your work email associated with \[Company name] to log in. > [tab] API message > > This user provided email that does not match the employer. > [tab] Troubleshooting > > Confirm that the user entered an email address during login with a domain address associated with their selected employer. For example, Company A may require emails always ending in `@company-a.com`. > > Often the user may have entered their *personal* email by mistake. ![](https://mintcdn.com/argyle/D587Ireo7wqxclC_/images/account-connection-errors/image_46.png?fit=max\&auto=format\&n=D587Ireo7wqxclC_\&q=85\&s=1e3917271a60ff953b36d49c5196dedf) ### `unsupported_auth_type` > [!NOTE] > > The [accounts.failed](/api-reference/accounts-webhooks/failed) webhook is sent when this error occurs. > [tab] Common causes > > Argyle does not support the user's attempted single sign-on (SSO) method for this particular payroll system. > [tab] User message > > Single sign-on (SSO) login method is not supported. Please use a different login method. > [tab] API message > > This user tried to log in using single sign-on (e.g., Google, Facebook), which Argyle does not currently support. > [tab] Troubleshooting > > Advise the user to re-attempt the connection using text login credentials such as a username/password combination. ![](https://mintcdn.com/argyle/0_py1wv-xzxlL1Oi/images/account-connection-errors/image_35.png?fit=max\&auto=format\&n=0_py1wv-xzxlL1Oi\&q=85\&s=f1c7b508ca20e016b9a5d7e6a54ca8d4) ### `unsupported_business_account` > [!NOTE] > > The [accounts.failed](/api-reference/accounts-webhooks/failed) webhook is sent when this error occurs. > [tab] Common causes > > The user submitted business account credentials instead of their personal credentials needed to access their payroll account. > [tab] User message > > Please log in using a personal account, or search for another payroll provider if you have other sources of income. > [tab] API message > > This user provided credentials for their business account. > [tab] Troubleshooting > > Confirm that the user submitted their personal account credentials, and not their business account credentials. ![](https://mintcdn.com/argyle/0_py1wv-xzxlL1Oi/images/account-connection-errors/image_36.png?fit=max\&auto=format\&n=0_py1wv-xzxlL1Oi\&q=85\&s=8e18de9a74c3549a8e843eba38e51a8c) ### `unsupported_language` > [!NOTE] > > The [accounts.failed](/api-reference/accounts-webhooks/failed) webhook is sent when this error occurs. > [tab] Common causes > > The user's payroll system contains data or documents that are in a language not currently supported by Argyle. > [tab] User message > > Payroll provider's language is not currently supported. > [tab] API message > > The user's account connection failed because the payroll provider's language is currently unsupported. > [tab] Troubleshooting > > Advise the user to switch their payroll system's language settings to English and then re-attempt account connection. ![](https://mintcdn.com/argyle/0_py1wv-xzxlL1Oi/images/account-connection-errors/image_37.png?fit=max\&auto=format\&n=0_py1wv-xzxlL1Oi\&q=85\&s=628f655637c5877834594963aaa0a568) ### `unsupported_mfa_method` > [!NOTE] > > The [accounts.failed](/api-reference/accounts-webhooks/failed) webhook is sent when this error occurs. > [tab] Common causes > > The user's payroll system uses an MFA method that Argyle does not currently support. > [tab] User message > > Your current two-step verification method isn't supported here. Log in to \[Company name], switch to a supported 2FA method in Security settings, then return here. > [tab] API message > > This user's employment account uses a multi-factor authentication method that Argyle does not currently support. > [tab] Troubleshooting > > Advise the user to change or temporarily disable the MFA method. ![](https://mintcdn.com/argyle/NK4HkfiJ6Kk1HQgi/images/account-connection-errors/image_38.png?fit=max\&auto=format\&n=NK4HkfiJ6Kk1HQgi\&q=85\&s=87b604cd998e88e36fe3d6ba3ecce8f7) ### `user_action_timeout` > [!NOTE] > > The [accounts.failed](/api-reference/accounts-webhooks/failed) webhook is sent when this error occurs. > [tab] Common causes > > The user failed to select their current employer or create a new password within the given time period required to connect an account during the Login help process for certain Items. > [tab] User message > > Your session has expired. Please try again. > [tab] API message > > This user did not complete employer selection or new password creation. > [tab] Troubleshooting > > Advise the user to exit the connection process and start over. ![](https://mintcdn.com/argyle/0_py1wv-xzxlL1Oi/images/account-connection-errors/image_39.png?fit=max\&auto=format\&n=0_py1wv-xzxlL1Oi\&q=85\&s=eecac007c5860e6d7efe2c447c20865b) # Accounts Source: https://docs.argyle.com/api-reference/accounts Accounts are payroll connections made through Link. ## The account object # Accounts.added webhook Source: https://docs.argyle.com/api-reference/accounts-webhooks/added openAPI/account-webhooks-added.yaml post /v2/webhooks Sent when account connection events occur. The `accounts.added` webhook is sent when a user submits login credentials through Link. A new account object is created after the login credentials have undergone authentication, regardless of whether the connection was successful (the `accounts.connected` webhook is sent) or unsuccessful (the `accounts.failed` webhook is sent). # Accounts.connected webhook Source: https://docs.argyle.com/api-reference/accounts-webhooks/connected openAPI/accounts-webhooks-connected.yaml post /v2/webhooks 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 Source: https://docs.argyle.com/api-reference/accounts-webhooks/failed openAPI/accounts-webhooks-failed.yaml post /v2/webhooks The accounts.failed webhook is sent when an account connection attempt fails. This includes 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. > [!WARNING] > > 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. # Accounts.removed webhook Source: https://docs.argyle.com/api-reference/accounts-webhooks/removed openAPI/accounts-webhooks-removed.yaml post /v2/webhooks The accounts.removed webhook is sent when a user revokes access to their account or an account is deleted. > [!WARNING] > > When an account is removed, Argyle deletes all resources associated with it, such as paystubs and uploaded documents. Data set-specific `.removed` webhooks are not sent for those resources, so subscribe to the `accounts.removed` webhook to monitor account deletions and revoked access. # Accounts.updated webhook Source: https://docs.argyle.com/api-reference/accounts-webhooks/updated openAPI/account-webhook-updated.yaml post /v2/webhooks The accounts.updated webhook is sent when a property of an account object changes. > [!WARNING] > > 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. # Delete An Account Source: https://docs.argyle.com/api-reference/accounts/delete-an-account openAPI/accounts.yaml delete /v2/accounts/{id} Deletes an account object. **Caution** - Deleting an account object will delete all resources associated with the account, such as paystubs or uploaded documents. # Disable Account Updates Source: https://docs.argyle.com/api-reference/accounts/disable-account-updates openAPI/accounts.yaml post /v2/accounts/{id}/disable-ongoing-refresh Disables ongoing refresh for an individual account. > [!NOTE] > > 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. # List All Accounts Source: https://docs.argyle.com/api-reference/accounts/list-all-accounts openAPI/accounts.yaml get /v2/accounts Returns a paginated list of all account objects. # Retrieve An Account Source: https://docs.argyle.com/api-reference/accounts/retrieve-an-account openAPI/accounts.yaml get /v2/accounts/{id} Retrieves an account object. # Bank Accounts Source: https://docs.argyle.com/api-reference/bank-accounts Bank account information. ## Aggregation status codes The `aggregation_status_code` returned in the bank account object provides information on either: * The connection status of the individual bank account * An error the user encountered, and how to resolve > [accordion] Most common aggregation status codes (refreshed nightly) > > | Code | Description | Required Action | > | - | - | - | > | 0 | Success | No issues encountered. | > | 103 | Bad login credentials | Have the user enter new login credentials via a [Connect URL](/api-reference/connect-url). | > | 108 | User prompt encountered | Have the user log in to their bank account and resolve the pop-up banner, typically by accepting new **Terms and Conditions** or acknowledging other account alerts. | > | 109 | Credentials expired - new password required | Have the user log in to their bank account and set a new password, then use a [Connect URL](/api-reference/connect-url) to have the user enter the new login credentials. | > | 169 | Duplicate account | Have the user keep one account and delete the duplicate(s) via a [Connect URL](/api-reference/connect-url). | > | 185 | Security challenge encountered | Use a [Connect URL](/api-reference/connect-url) to have the user answer the **Multi-Factor Authentication (MFA)** questions or enter the **One-Time Passcode (OTP)** sent by the financial institution. | > | 187 | Incorrect security challenge answers | Use a [Connect URL](/api-reference/connect-url) to have the user answer the **Multi-Factor Authentication (MFA)** questions. | > | 945 | OAuth migration (account migrated but not consented) | Prompt the user to re-authenticate via a [Connect URL](/api-reference/connect-url). Otherwise, have the user delete the account and add it again under the same bank with the OAuth connection indicated by the [financial institutions endpoint](/api-reference/financial-institutions). | > | 946 | Account not found (account may have been closed) | Prompt the user to authenticate the right account via a [Connect URL](/api-reference/connect-url). Otherwise, have the user delete the account via a [Connect URL](/api-reference/connect-url) and then find and add an active account. | > | 947 | Token expired or refresh required | A new token is needed; issue a new [Connect URL](/api-reference/connect-url) for the user. | > | 948 | OAuth migration (account migrated but not authenticated) | Prompt the user to re-authenticate via a [Connect URL](/api-reference/connect-url). Otherwise, have the user delete the account and add it again under the same bank with the OAuth connection indicated by the [financial institutions endpoint](/api-reference/financial-institutions). | > | 949 | Account unrecoverable | Have the user delete the account and re-enter via a [Connect URL](/api-reference/connect-url) to re-add the account. | > | 147, 148, 173, 176, 181, 190, 900, 901, 903, 904, 906, 907, 940, 950 | Additional support required | Contact Argyle support. | # List all bank accounts Source: https://docs.argyle.com/api-reference/bank-accounts/list-all-bank-accounts get /v2/open-banking/bank-accounts Returns a paginated list of the user's bank accounts. # Retrieve a bank account Source: https://docs.argyle.com/api-reference/bank-accounts/retrieve-a-bank-account get /v2/open-banking/bank-accounts/{bank_account_id} Retrieves a bank account. # Bank Connection Errors Source: https://docs.argyle.com/api-reference/bank-connection-errors Common causes and troubleshooting. ## Overview Banking verification errors can occur while a borrower connects a financial institution, while account data is aggregated, or while Argyle generates a banking report. To monitor for bank connection errors: 1. Subscribe to the [`verifications.updated`](/api-reference/verifications-webhooks/updated) webhook and set `include_resource = true` so the webhook payload contains the full verification object in `data.resource`. 2. When you receive the `verifications.updated` webhook or are encountering bank connection issues, check the verification object's `status`. If the `status.state` value is `PAUSED`, check the `errors` array in the `status` object. 3. Proceed to the troubleshooting steps below for the bank connection error that matches the `code` value. ## Bank connection errors ### `account_closed` > [tab] API message > > The selected account could not be found or is no longer available at the banking institution. > [tab] Troubleshooting > > Ask the borrower to confirm they selected an active bank account and retry. ### `account_not_found` > [tab] API message > > The selected account could not be found or is no longer available at the banking institution. > [tab] Troubleshooting > > Ask the borrower to confirm they selected an active bank account and retry. ### `account_unrecoverable` > [tab] API message > > The borrower needs to reconnect their account to restore access and complete verification. > [tab] Troubleshooting > > Contact the borrower and ask them to reconnect their account. ### `aggregation_in_progress` > [tab] API message > > The bank account is still being aggregated, so the requested report cannot be generated yet. > [tab] Troubleshooting > > Wait for aggregation to complete, then retry report generation. ### `generic_error` > [tab] API message > > A connection error occurred while trying to verify the account. > [tab] Troubleshooting > > Ask the borrower to try again later. ### `institution_not_supported` > [tab] API message > > The selected banking institution does not currently support connections. > [tab] Troubleshooting > > Ask the borrower to choose another supported institution or use another verification method. ### `invalid_credentials` > [tab] API message > > The borrower provided invalid banking login credentials. > [tab] Troubleshooting > > Ask the borrower to check their credentials are valid or reset their password and try again. ### `mfa_issue_encountered` > [tab] API message > > A multi-factor authentication or security verification step was not completed successfully. > [tab] Troubleshooting > > Ask the borrower to retry and complete every verification prompt in one session. ### `no_accounts_connected` > [tab] API message > > The borrower did not connect an eligible bank account, so the requested banking report could not be generated. > [tab] Troubleshooting > > Ask the borrower to retry and connect an account of type: checking, savings, money market, cd, or investment account. ### `one_time_passcode_issue` > [tab] API message > > There is a temporary issue preventing a successful connection to the borrower's banking institution right now. > [tab] Troubleshooting > > Ask the borrower to wait a few minutes and try again. ### `report_generation_failed` > [tab] API message > > We could not generate the requested banking report. > [tab] Troubleshooting > > Retry report generation. If it fails again, escalate to Argyle support. ### `temporary_connection_issue` > [tab] API message > > There is a temporary issue preventing a successful connection to the borrower's banking institution right now. > [tab] Troubleshooting > > Ask the borrower to wait a few minutes and try again. ### `token_invalid_or_expired` > [tab] API message > > The borrower needs to reconnect their account to restore access and complete verification. > [tab] Troubleshooting > > Contact the borrower and ask them to reconnect their account. ### `user_action_required_at_institution` > [tab] API message > > The borrower must sign in directly at their banking institution and complete an account action before reconnecting. > [tab] Troubleshooting > > Ask the borrower to complete the required steps and then reconnect. # Banking Overview Guide Source: https://docs.argyle.com/api-reference/banking-overview Implementation guide for banking reports. > [!WARNING] > > This workflow has been deprecated in favor of the current verification workflow for payroll, banking, and Doc VOI. See the [Verifications Guide](/verifications/overview) to learn more. ## Overview Verify assets and income and generate verification reports by allowing users to directly connect their financial institutions. ![Verify assets and income with Argyle banking reports.](https://mintcdn.com/argyle/EtHVUNI_SMseJQur/images/argyle-guides/api-ref/banking-reports/1-banking.png?fit=max\&auto=format\&n=EtHVUNI_SMseJQur\&q=85\&s=e3e171f6dad5485eae24082b36fa81a9) ## Supported report types * [Verification of Assets (VOA)](https://res.cloudinary.com/argyle-media/image/upload/v1749582203/docs-2025/VOA_Banking_Report.pdf) * [Verification of Income (VOI)](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/VOI_Banking_Report.pdf) * [Verification of Assets & Income (VOAI)](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/VOAI_Banking_Report.pdf) ## Workflow Argyle's [Postman collection](/api-guide/postman) contains examples of the banking endpoints mentioned below. ### Create an Argyle user > [!NOTE] > > The Sandbox testing environment for banking supports a maximum of 500 users. To stay within this limit, implement user-management workflows and remove inactive users when they are no longer needed. 1. [Create](/api-reference/users#create) or [update](/api-reference/users#update) an Argyle user. 2. In the request body, include `first_name`, `last_name`, and `address`. Also provide at least one identity field (`ssn` or `birth_date`) and at least one contact field (`email` or `phone_number`). These fields are only required for banking reports. > [accordion] User fields for banking reports > > * The top-level (root) object should contain user details (user being the borrower in most cases). > > * The `external_metadata` object should contain details about the person or entity making the lending decision. > > The `external_metadata` object is **optional**. > > > [accordion] Example user fields for banking reports > > > > ```json theme={} > > { > > "first_name": "Bob", > > "last_name": "Jones", > > "email": "bob@email.com", > > "phone_number": "555-111-2222", // must be 10 or 11 digits (with or without hyphens) — e.g. 5551112222 or 555-111-2222 or 15551112222 or 1-555-111-2222 > > "ssn": "123456789", // must be 9 digits (with or without hyphens) — e.g. 123456789 or 123-45-6789 > > "address": { > > "city": "New York", > > "line1": "759 Victoria Plaza", > > "line2": null, > > "state": "New York", > > "country": "US", > > "postal_code": "10014" > > }, > > "birth_date": { > > "year": 1980, // integer (must be 1900 or later) > > "month": 12, // integer (must be between 1 and 12) > > "day": 3 // integer (must be between 1 and 31) > > }, > > "external_metadata": { // this object & all its properties are optional > > "open_banking": { > > "end_user": { > > "name": "Loan Officer", > > "address": "759 Victoria Plaza", > > "city": "New York", > > "state": "NY", > > "zip": "10014", > > "phone": "7778889999" // must be 10 or 11 digits (with or without hyphens) — e.g. 5551112222 or 555-111-2222 or 15551112222 or 1-555-111-2222 > > } > > } > > } > > } > > ``` ### Create connection link > [tab] URL (Share or Embed) > > 1. [Create](/api-reference/connect-url#create) a Connect URL — a temporary link that allows the user to securely authorize access to their bank data. > > 2. In the request body, make sure to specify via the `webhook` field where to receive [Connect Event](/api-reference/banking-overview#connect-events) webhooks. > > > [!NOTE] > > > > Each [environment](/api-guide/overview#environments) (Sandbox and Production) requires its own webhook. Subscriptions do not transfer between environments. > > 3. Share the Connect URL with the user directly, or embed the bank connection experience within your application. For new embedded banking UI implementations, use the banking SDK. Hosted or no-SDK banking flows must be enabled by Argyle before use. Reach out to your Argyle customer success manager before using this implementation path. > [tab] Invite (Email or Phone) > > 1. Contact your Argyle customer success manager to manually register a webhook URL where you will receive [Connect Events](/api-reference/banking-overview#connect-events). > > > [!NOTE] > > > > Each [environment](/api-guide/overview#environments) (Sandbox and Production) requires its own webhook. Subscriptions do not transfer between environments. > > 2. Review the following customization options. > > > [accordion] Customize the invite and banking experience. > > > > * Go to the [Flows](https://console.argyle.com/flows) section of Console. Select "New Flow" and "Email/SMS Template" — (alternatively, an existing "Email/SMS Template" can be edited.) > > * In the "Landing page" flow step, make sure the "Connect bank account" toggle is ON. > > * If you want to customize the banking experience, your Argyle customer success manager will provide an `Experience ID` that can be entered at the bottom of the same page under "Integration reference". > > * Save the Flow in Console and copy the `Flow ID` (will be used in the next step). > > > [accordion] Your Argyle customer success manager can help provide the following customizations: > > > > * Your company name and logo shown to borrowers can be adjusted. > > * Which financial institutions are shown by default on the home screen. > > * After the borrower connects a financial institution, they will be shown a list of detected accounts (e.g. checking, savings, 401k). > > > [accordion] You can exclude any of the following account types from being selectable by borrowers: > > > > * 457 > > * 529 > > * 401a > > * 401k > > * 403b > > * Brokerage Account > > * CD > > * Checking > > * Credit Card > > * Crypto Currency > > * Education Savings > > * Employee Stock Purchase Plan > > * Health Savings Account > > * Investment > > * Investment Tax Deferred > > * IRA > > * Keogh > > * Line of Credit > > * Loan > > * Money Market > > * Mortgage > > * Non Taxable Brokerage Account > > * Pension > > * Profit Sharing Plan > > * Rollover > > * Roth > > * Roth 401k > > * Savings > > * SEP IRA > > * Simple IRA > > * Student Loan > > * Thrift Savings Plan > > * UGMA > > * Unknown > > * UTMA > > * Variable Annuity > > 3. [Send an invite](/api-reference/invites#send-invite) to the user. > > * In the request body, only `user_id` and `flow_id` are required. > * `user_id` is returned after creating an Argyle user. > * `flow_id` is obtained after customizing the invite and banking experience. > * By default the name, email, and phone number provided when [creating an Argyle user](/api-reference/banking-overview#create-an-argyle-user) will be used. You can optionally override any of these contact values by also specifying them in the request body: > > ```json theme={} > // Example request body: > { > "user_id": "{{ID of the user}}", // required > "flow_id": "{{Flow ID}}", // required > "first_name": "Bobby", // optional > "last_name": "J", // optional > "email": "bobby@email.com", // optional > "phone_number": "555-333-4444" // optional > } > ``` ### Generate a banking report 1. When you receive a Connect Event webhook with `"event_type": "done"` a banking report can be generated — this event signifies the user has connected their banking accounts and successfully authorized the related connections. 2. [Generate](/api-reference/banking-reports#generate) a banking report and specify the [report type](/api-reference/banking-overview#supported-report-types) in the request. 3. (Optional) Specify via the `webhook` field where to receive the [Connect Event](/api-reference/banking-overview#connect-events) webhook notifying you that the report has been generated. 4. Save the `file_url` and `json_url` values returned in the response after generating a report. > [!NOTE] > > If the user only connected account types (e.g. Line of credit) that are not eligible for the specified report type, the API will return a **400 (Bad Request)** response: > > ```json theme={} > { > "detail": "INVALID_ARGUMENT: Code: 5030, error: No matching account types apply" > } > ``` ### Retrieve report PDFs and JSONs 1. When you receive a Connect Event webhook with `"event_name": "done"` a banking report has been successfully generated and can be retrieved. 2. To retrieve a PDF version of the report, call **GET** `{file_url}` — make sure to include [Argyle authentication headers](/api-guide/overview#authentication). 3. To retrieve a JSON version of the report, call **GET** `{json_url}` — make sure to include [Argyle authentication headers](/api-guide/overview#authentication). ### Day 1 Certainty® and AIM For mortgage use cases, the reference number for Day 1 Certainty® or AIM is provided in the `portfolio` field returned after calling **GET** `{json_url}`. In Encompass®, this reference number can be submitted in the **Finicity Borrower** field: ![Submit GSE reference numbers to the Finicity borrower field in Encomapss.](https://mintcdn.com/argyle/EtHVUNI_SMseJQur/images/argyle-guides/api-ref/banking-reports/2-banking.png?fit=max\&auto=format\&n=EtHVUNI_SMseJQur\&q=85\&s=fe36a7864cd4a41164e94014a5278ad7) ## Connect events Connect Event webhooks are sent: * When the user completes certain steps of the connection process. * When a report is being and has been successfully generated. *Most common Connect Event webhooks (examples):* > [accordion] The user opened the bank connection experience. > > ```json theme={} > { > "user": "01975aea-3882-d5fb-7eb5-e4821a573167", > "event_type": "started", > "event_id": "1749577051464-49bbb425bbe60e0fdfd14da0", > "payload": {} > } > ``` > [accordion] The user selected a financial institution. > > ```json theme={} > { > "user": "01975c4e-fee2-0162-a341-e5f61359da49", > "event_type": "institutionSupported", > "event_id": "1749604002888-f1342c3918d21aee221d5388", > "payload": { > "institution": "102168" > } > } > ``` > [accordion] The user attempted to submit credentials. > > ```json theme={} > { > "user": "01975c4e-fee2-0162-a341-e5f61359da49", > "event_type": "adding", > "event_id": "1749604018215-941d6b8cd2ec7f1d3353ccab", > "payload": { > "institution": "102168", > "oauth": "false" > } > } > ``` > [accordion] The user submitted invalid credentials. > > ```json theme={} > { > "user": "01975c4e-fee2-0162-a341-e5f61359da49", > "event_type": "invalidCredentials", > "event_id": "1749604019315-a7f974879a932f939dd45532", > "payload": { > "institution": "102168" > } > } > ``` > [accordion] The user submitted valid credentials. > > ```json theme={} > { > "user": "01975c4e-fee2-0162-a341-e5f61359da49", > "event_type": "adding", > "event_id": "1749604149048-d2ffdf7f0954f9b7029e219d", > "payload": { > "institution": "102168", > "oauth": "false" > } > } > ``` > [accordion] Eligible accounts were found. > > ```json theme={} > { > "user": "01975c4e-fee2-0162-a341-e5f61359da49", > "event_type": "discovered", > "event_id": "1749604157634-d425a8628178de589cc447e7", > "payload": { > "accounts": [ > { > "id": 8057734470, > "number": "xx2121", > "name": "401K", > "balance": 9005, > "type": "401k", > "status": "pending", > "institution_login": 8029207213 > }, > { > "id": 8057734471, > "number": "xx2020", > "name": "IRA", > "balance": 7030, > "type": "ira", > "status": "pending", > "institution_login": 8029207213 > }, > { > "id": 8057734472, > "number": "xx3333", > "name": "Credit Card", > "balance": -1952.71, > "type": "creditCard", > "status": "pending", > "institution_login": 8029207213 > }, > { > "id": 8057734474, > "number": "xx2222", > "name": "Savings", > "balance": 22327.3, > "type": "savings", > "status": "pending", > "institution_login": 8029207213 > } > ], > "mfa": null, > "institution": "102168" > } > } > ``` > [accordion] The user selected and saved eligible account(s). > > ```json theme={} > { > "user": "01975c4e-fee2-0162-a341-e5f61359da49", > "event_type": "added", > "event_id": "1749604256032-f2402c85f88e2188534d5b2b", > "payload": { > "institution": "102168", > "accounts": [ > { > "id": "8057734474", > "number": "xx2222", > "real_account_number_last4": "2222", > "account_number_display": "2222", > "name": "Savings", > "balance": 22327.3, > "type": "savings", > "status": "active", > "user": "01975c4e-fee2-0162-a341-e5f61359da49", > "institution": "102168", > "balance_date": "2025-06-11T01:09:17.000Z", > "created_date": "2025-06-11T01:09:17.000Z", > "last_updated_date": "2025-06-11T01:10:55.000Z", > "currency": "USD", > "institution_login": "8029207213", > "display_position": "1", > "financialinstitution_account_status": null, > "account_nickname": "Savings", > "market_segment": "personal" > } > ], > "oauth": false > } > } > ``` > [accordion] The user successfully submitted their accounts. — event\_type: done > > ```json theme={} > { > "user": "01975c4e-fee2-0162-a341-e5f61359da49", > "event_type": "done", > "event_id": "1749604309359-1248d979c904efc4519431f8", > "payload": {} > } > ``` > [accordion] Report generation is in progress. > > ```json theme={} > { > "user": "01975c4e-fee2-0162-a341-e5f61359da49", > "event_name": "inProgress", > "id": "kkc7xyd800ur", > "type": "voa", > "status": "inProgress", > "portfolio_id": "eumj6fqkqzw6-3-port", > "report_custom_fields": null > } > ``` > [accordion] Report generation has successfully completed. — event\_name: done > > ```json theme={} > { > "user": "01975c4e-fee2-0162-a341-e5f61359da49", > "event_name": "done", > "id": "kkc7xyd800ur", > "type": "voa", > "status": "success", > "portfolio_id": "eumj6fqkqzw6-3-port", > "report_custom_fields": null > } > ``` ## Related endpoints * The [reports endpoint](/api-reference/reports) can be used to retrieve reports by user or report ID. * The [bank accounts endpoint](/api-reference/bank-accounts) can be used to retrieve a list of the user's bank accounts. * The [financial institutions endpoint](/api-reference/financial-institutions) can be used to search for supported financial institutions. ## Testing profiles > [!NOTE] > > When you're ready to begin testing, contact your Argyle Customer Success Manager to enable banking permissions. > [!NOTE] > > The Sandbox testing environment for banking supports a maximum of 500 users. To stay within this limit, implement user-management workflows and remove inactive users when they are no longer needed. The following sample test profiles can be connected to: * **Sandbox** — the `FinBank Profiles A` or `FinBank Profiles B` financial institutions * **Production** — the `FinBank Billable` or `FinBank Oauth Billable` financial institutions | Username | Password | Account Types | Supported Products | | - | - | - | - | | profile\_02 | profile\_02 | Savings, IRA, 401k, Credit Card | voa, voi, voai | | profile\_03 | profile\_03 | Checking, Personal Investment, 401K, Roth, Savings (Joint Account owners) | voa, voi, voai | | profile\_04 | profile\_04 | Checking, 403B, 529, Rollover, Mortgage | voa, voi, voai | | profile\_05 | profile\_05 | Checking, Investment, Stocks, UGMA, UTMA (Joint Account owners) | voa, voi, voai | | profile\_06 | profile\_06 | Checking, Retirement, KEOGH, 457, Credit Card | voa, voi, voai | | profile\_07 | profile\_07 | Checking, Stocks, CD, Investment Tax-Deferred, Employee Stock | voa, voi, voai | | profile\_08 | profile\_08 | Checking, Primary Savings, Money Market, 401A, Line of credit | voa, voi, voai | | profile\_09 | profile\_09 | Checking, Savings, Checking Failed Report. Errors include 102, 103, 185 | voa \*(failed report)\*voi \*(failed report)\*voai *(failed report)* | For specific scenario testing, the following sample test users are also available: | | Sue Wealthy | River Paycheck | Alex Student | | - | - | - | - | | Username | sue\_wealthy | river\_paycheck | alex\_student | | Password | profile\_700 | profile\_703 | profile\_704 | | Description | Sue is working as a Product Manager with a good steady income, a mortgage, and multiple investment accounts. She has a loan account and leases a car. Sue travels a few times a year. She has typical expenses like groceries, clothes, entertainment, gym membership, car expenses, and she has a pet. | River works in construction. He rents an apartment and has typical expenses like groceries, clothes, entertainment, household and car expenses. He has some savings but no investments, no loans and no credit cards. In some months, River's expenses exceed his income. | Alex is working full-time with a good salary but she is still paying off her student loan. She makes regular monthly repayments, but she still has over \$30,000 to pay off. Alex has typical expenses like groceries, clothes, entertainment, household, and car expenses. She has limited savings and she has started an investment account. | # Banking Reports Source: https://docs.argyle.com/api-reference/banking-reports Generate asset and income reports based on bank data. > [!NOTE] > > For new banking report implementations, use [Banking Verifications](/verifications/verification-types/banking). These endpoints are documented for existing integrations. See [Verifications vs. Data APIs](/overview/verifications-vs-data-apis) to choose your implementation path. **Example reports:** > [accordion] Verification of Assets (VOA) — PDF and JSON > > [PDF](https://res.cloudinary.com/argyle-media/image/upload/v1749582203/docs-2025/VOA_Banking_Report.pdf) > > Report PDF > > ![Image of Verification of Assets (VOA) banking report.](https://mintcdn.com/argyle/EtHVUNI_SMseJQur/images/argyle-guides/api-ref/banking-reports/banking-voa.png?fit=max\&auto=format\&n=EtHVUNI_SMseJQur\&q=85\&s=90dfe8c33ce68adc18dd6bd993febceb) > > The JSON example below shows selected fields. > > [Download complete JSON](/examples/reports/banking-voa.json) > > ```json theme={} > { > "id": "m22kz9tzmz3t", > "type": "voa", > "status": "success", > "created_date": "2025-06-10T18:57:22.000Z", > "assets": { > "type": null, > "available_balance": 18349.6, > "current_balance": 22327.3, > "two_month_average": 21995.27, > "six_month_average": null, > "beginning_balance": 20942.02 > }, > "consolidated_available_balance": 18349.6, > "institutions": [ > { > "id": 102168, > "name": "FinBank Profiles - B", > "accounts": [ > { > "id": 8057635035, > "name": "Savings", > "type": "savings", > "balance": 22327.3 > } > ] > } > ] > } > ``` > [accordion] Verification of Income (VOI) — PDF and JSON > > [PDF](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/VOI_Banking_Report.pdf) > > Report PDF > > ![Image of Verification of Income (VOI) banking report.](https://mintcdn.com/argyle/CvJPgig9j-lpaCnS/images/argyle-guides/api-ref/banking-reports/banking-voi-2026.png?fit=max\&auto=format\&n=CvJPgig9j-lpaCnS\&q=85\&s=41456c3aa6d6c473a3d6cbc3de24e0b5) > > The JSON example below shows selected fields. > > [Download complete JSON](/examples/reports/banking-voi.json) > > ```json theme={} > { > "id": "bdmczjhxc8vj-voi", > "type": "voi", > "status": "success", > "created_date": "2026-09-03T23:03:00.000Z", > "income": [ > { > "confidence_type": "HIGH", > "income_estimate": { > "estimated_gross_annual": 115731, > "net_annual": 81703.67, > "projected_gross_annual": 130005, > "projected_net_annual": 89052.02, > "average_monthly_net": 6808.64, > "average_monthly_gross": 9644.25 > } > } > ] > } > ``` > [accordion] Verification of Assets & Income (VOAI) — PDF and JSON > > [PDF](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/VOAI_Banking_Report.pdf) > > Report PDF > > ![Image of Verification of Assets & Income (VOAI) banking report.](https://mintcdn.com/argyle/ghfim0fZqG69QDy3/images/argyle-guides/api-ref/banking-reports/banking-voai-2026.png?fit=max\&auto=format\&n=ghfim0fZqG69QDy3\&q=85\&s=b518f57c8342a1f77f1752b843cc7b42) > > The JSON example below shows selected fields. > > [Download complete JSON](/examples/reports/banking-voai.json) > > ```json theme={} > { > "id": "q3senvchs15n", > "type": "voaHistory", > "status": "success", > "created_date": "2026-09-16T21:04:48.000Z", > "assets": { > "current_balance": 14911.0, > "two_month_average": 10745.1, > "six_month_average": 9592.05, > "beginning_balance": 38693.34 > }, > "consolidated_available_balance": 14911.0, > "institutions": [ > { > "id": 102105, > "name": "FinBank Profiles - A", > "accounts": [ > { > "id": 9035542498, > "name": "Checking", > "type": "checking", > "balance": 14911.0, > "income_streams": [ > { > "id": "q3senvchs15n1", > "name": "abc", > "status": "ACTIVE", > "confidence": 100, > "cadence": { > "start_date": "2025-09-30T12:00:00.000Z", > "stop_date": null, > "days": 13 > } > } > ] > } > ] > } > ] > } > ``` ## The report object # Generate a banking report Source: https://docs.argyle.com/api-reference/banking-reports/generate-a-banking-report post /v2/open-banking/reports/{type} Generates a new banking report and returns a report object. > [!NOTE] > > For new banking report implementations, use [Banking Verifications](/verifications/verification-types/banking). This endpoint is documented for existing integrations. # Connect URL Source: https://docs.argyle.com/api-reference/connect-url openAPI/open-banking.yaml post /v2/open-banking/connect Create session links for bank authentications. Connect URLs are temporary, user-specific links that redirect users to securely authenticate and authorize access to their bank data. # Create a Connect URL Source: https://docs.argyle.com/api-reference/connect-url/create-a-connect-url post /v2/open-banking/connect Creates a new Connect URL for the specified user. # Deposit Destinations Source: https://docs.argyle.com/api-reference/deposit-destinations Where paychecks are sent, and how they are allocated. ## The deposit destination object # List All Deposit Destinations Source: https://docs.argyle.com/api-reference/deposit-destinations/list-all-deposit-destinations get /v2/deposit-destinations Returns a paginated list of all deposit destination objects. # Retrieve A Deposit Destination Source: https://docs.argyle.com/api-reference/deposit-destinations/retrieve-a-deposit-destination get /v2/deposit-destinations/{id} Retrieves a deposit destination object. # Document Verifications Source: https://docs.argyle.com/api-reference/documents-overview Implementation guide for document-based income verifications. > [!WARNING] > > This workflow has been deprecated in favor of the current verification workflow for payroll, banking, and Doc VOI. See the [Verifications Guide](/verifications/overview) to learn more. ## Overview Receive Freddie Mac monthly income calculations from uploaded paystubs and W2s. * Upload paystubs and W-2s when borrower cannot connect via Argyle with a direct payroll login * Generate an Argyle Doc VOI report with rep & warrant determination for income and employment ![Argyle Doc VOI report PDF](https://mintcdn.com/argyle/EtHVUNI_SMseJQur/images/argyle-guides/api-ref/document-verifications/1-documents.png?fit=max\&auto=format\&n=EtHVUNI_SMseJQur\&q=85\&s=47c994109741c21d13bfa75c60a90cb5) ## Supported report types * [Verification of Income (Doc VOI)](https://res.cloudinary.com/argyle-media/image/upload/v1764784423/docs-2025/doc_voi_example.pdf) ## Workflow Argyle's [Postman collection](/api-guide/postman) contains examples of the document upload and verification endpoints mentioned below. ### Subscribe to webhook 1. Subscribe to the [verifications.updated](/api-reference/verifications-webhooks/updated) webhook. > [!NOTE] > > When subscribing, it is recommended to set `include_resource` to `true` to receive the full verification object in the webhook payload, which includes the verification's status `state`. ### Request a verification 1. Order a verification through the [`/verifications`](/api-reference/verifications/order-a-verification) API endpoint. In your request, at minimum you are required to provide: * Borrower details: first name, last name, and ssn * Employment details: employer name(s), employment status, hire date, and termination date (for previous employments) > [!NOTE] > > One year and one month of previous employment history is required. 2. After ordering a verification through this legacy workflow, an Argyle user will be created automatically. The `user` id will be returned in the API response. > [!NOTE] > > For current Doc VOI implementations, use the [Doc VOI Guide](/verifications/verification-types/document-voi). The current flow supports ordering a new Doc VOI verification for an existing user when refreshing a report with additional documents. ### Upload documents 3. Upload documents for the `user` through the [`/user-uploads`](/api-reference/user-uploads#upload) API endpoint. > [!NOTE] > > Most recent paystub and previous year W-2s or December paystubs for each employment are typically required. \ > *— Contact your Argyle customer success manager for more information.* ### Retrieve Doc VOI report 1. When a `verifications.updated` webhook is received and the status `state` is `COMPLETED`, a Doc VOI report can be retrieved via: * [`file_url`](/api-reference/verifications/retrieve-a-verification) — retrieves PDF report * [`json_url`](/api-reference/verifications/retrieve-a-verification) — retrieves report in JSON format ## Testing ### Sandbox > [accordion] Successful verification with GSE-eligible monthly income > > 1. Order a verification and use the following for the `employments` array: > ```json theme={} > "employments": [ > { > "employer": "Warehouse Services Inc", > "status": "active", > "hire_date": "2023-02-01", > "termination_date": null > } > ], > ``` > > 2. Upload the following documents: > > > [!NOTE] > > > > Do not adjust file names. > > * [Warehouse\_Services\_Inc\_paystub.pdf](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/Warehouse_Services_Inc_paystub.pdf) > * [Warehouse\_Services\_Inc\_paystub\_2025.pdf](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/Warehouse_Services_Inc_paystub_2025.pdf) > * [Warehouse\_Services\_Inc\_paystub\_2024.pdf](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/Warehouse_Services_Inc_paystub_2024.pdf) > [accordion] Successful verification with monthly income that is not GSE-eligible > > 1. Order a verification and use the following for the `employments` array: > ```json theme={} > "employments": [ > { > "employer": "Warehouse Services Inc", > "status": "active", > "hire_date": "2023-02-01", > "termination_date": null > } > ], > ``` > > 2. Upload the following documents: > > > [!NOTE] > > > > Do not adjust file names. > > * [Warehouse\_Services\_Inc\_ineligible.pdf](https://res.cloudinary.com/argyle-media/image/upload/docs-2025/Warehouse_Services_Inc_paystub_ineligible.pdf) > * [Warehouse\_Services\_Inc\_paystub\_2025.pdf](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/Warehouse_Services_Inc_paystub_2025.pdf) > * [Warehouse\_Services\_Inc\_paystub\_2024.pdf](https://res.cloudinary.com/argyle-media/image/upload/docs-2025/Warehouse_Services_Inc_paystub_2024.pdf) > [accordion] Verification that enters the PAUSED state (more data required) > > 1. Order a verification and use the following for the `employments` array: > ```json theme={} > "employments": [ > { > "employer": "Warehouse Services Inc", > "status": "active", > "hire_date": "2023-02-01", > "termination_date": null > } > ], > ``` > > 2. Upload only the following documents: > > > [!NOTE] > > > > Do not adjust the file name. > > * [Warehouse\_Services\_Inc\_paystub.pdf](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/Warehouse_Services_Inc_paystub.pdf) ### Production > [!NOTE] > > Production testing can be done with real documents. If needed, the below test documents can also be used. > [accordion] Successful verification with GSE-eligible monthly income > > 1. Order a verification and use the following for the `employments` array: > ```json theme={} > "employments": [ > { > "employer": "Warehouse Services Inc", > "status": "active", > "hire_date": "2023-02-01", > "termination_date": null > } > ], > ``` > > 2. Upload the following documents: > > > [!NOTE] > > > > Do not adjust file names. > > * [sandbox\_Warehouse\_Services\_Inc\_paystub.pdf](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/sandbox_Warehouse_Services_Inc_paystub.pdf) > * [sandbox\_Warehouse\_Services\_Inc\_paystub\_2025.pdf](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/sandbox_Warehouse_Services_Inc_paystub_2025.pdf) > * [sandbox\_Warehouse\_Services\_Inc\_paystub\_2024.pdf](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/sandbox_Warehouse_Services_Inc_paystub_2024.pdf) > [accordion] Successful verification with monthly income that is not GSE-eligible > > 1. Order a verification and use the following for the `employments` array: > ```json theme={} > "employments": [ > { > "employer": "Warehouse Services Inc", > "status": "active", > "hire_date": "2023-02-01", > "termination_date": null > } > ], > ``` > > 2. Upload the following documents: > > > [!NOTE] > > > > Do not adjust file names. > > * [sandbox\_Warehouse\_Services\_Inc\_paystub\_ineligible.pdf](https://res.cloudinary.com/argyle-media/image/upload/docs-2025/sandbox_Warehouse_Services_Inc_paystub_ineligible.pdf) > * [sandbox\_Warehouse\_Services\_Inc\_paystub\_2025.pdf](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/sandbox_Warehouse_Services_Inc_paystub_2025.pdf) > * [sandbox\_Warehouse\_Services\_Inc\_paystub\_2024.pdf](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/sandbox_Warehouse_Services_Inc_paystub_2024.pdf) > [accordion] Verification that enters the PAUSED state (more data required) > > 1. Order a verification and use the following for the `employments` array: > ```json theme={} > "employments": [ > { > "employer": "Warehouse Services Inc", > "status": "active", > "hire_date": "2023-02-01", > "termination_date": null > } > ], > ``` > > 2. Upload only the following documents: > > > [!NOTE] > > > > Do not adjust the file name. > > * [sandbox\_Warehouse\_Services\_Inc\_paystub.pdf](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/sandbox_Warehouse_Services_Inc_paystub.pdf) ## FAQs > [accordion] File types & max file size accepted for uploaded documents? > > * PDF, JPEG, PNG, HEIC file types accepted > * 16MB max file size > [accordion] If correct document are uploaded, will monthly calculations and GSE eligibility always be given? > > * No, additional criteria may not be met.*— For example, calculations and rep & warrant relief is not given when there is excessive fluctuation in income over time.* > [accordion] How long is income rep & warrant relief given? > > * 120 days > [accordion] How long is employment rep & warrant relief given? > > * Variable. > * Exact amount is 14 days from the pay date of the most recent paystub.*— For example, if today is July 31, 2025 and the most recent paystub uploaded had a pay date of July 21, 2025, only 4 days of employment rep & warrant relief would be given.* # Employer Search Source: https://docs.argyle.com/api-reference/employer-search Use the employer search endpoint to create free-text employer search inputs in your applications. * The endpoint returns a list of [Items](/api-reference/items) that best match the user's query. * Visually display the Item results in your search dropdown. Search results can be continuously updated real-time as the user enters their employer name letter-by-letter. * When the user selects the Item that represents their employer, the Item's `id` returned by the endpoint can be used to directly connect users to that specific Item in Link using the [direct login](/workflows/account-connections#direct-login) method. > [!NOTE] > > Visit our [Employer Search Guide](/overview/employer-search) for an in-depth overview, example search demo, and Github sample project. ## The employer search object # List All Employers Source: https://docs.argyle.com/api-reference/employer-search/list-all-employers get /v2/employer-search Returns a paginated list of all Item objects, representing the most relevant search results. # Employments Source: https://docs.argyle.com/api-reference/employments Individual employments associated with a user or account. ## The employment object # List All Employments Source: https://docs.argyle.com/api-reference/employments/list-all-employments get /v2/employments Returns a paginated list of all employment objects. > [!NOTE] > > Either `user` or `account` query parameter must be used. # Financial Institutions Source: https://docs.argyle.com/api-reference/financial-institutions Explore supported financial institutions for banking connections. # List all institutions Source: https://docs.argyle.com/api-reference/financial-institutions/list-all-institutions get /v2/open-banking/institutions Returns a paginated list of supported financial institutions. # Retrieve an institution Source: https://docs.argyle.com/api-reference/financial-institutions/retrieve-an-institution get /v2/open-banking/institutions/{institution_id} Retrieves a financial institution. # Gigs Source: https://docs.argyle.com/api-reference/gigs Retrieve information specific to gig employments. ## The gig object # Gigs.added webhook Source: https://docs.argyle.com/api-reference/gigs-webhooks/added openAPI/gigs-webhooks-added.yaml post /v2/webhooks The `gigs.added` webhook is sent only when an account's data is refreshed (does not include initial data retrieval) and a new gig is retrieved. Sent when gigs are added, updated, or removed. If you need to access to gig data as soon as it is available: * 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 during initial data retrieval for a newly connected account. * The `gigs.fully_synced` webhook is sent when all gigs have been retrieved during initial data retrieval for a newly connected account. Because some accounts can contain thousands of gigs, we recommend subscribing to the `gigs.partially_synced` webhook when especially time-sensitive. The `gigs.fully_synced` webhook will only be sent when all gig data has been retrieved, which may take up to several hours in these cases. # Gigs.fully_synced webhook Source: https://docs.argyle.com/api-reference/gigs-webhooks/fully-synced openAPI/gigs-webhooks-fully-synced.yaml post /v2/webhooks The `gigs.fully_synced` webhook is sent when all gigs have been retrieved from a newly connected payroll account. # Gigs.partially_synced webhook Source: https://docs.argyle.com/api-reference/gigs-webhooks/partially-synced openAPI/gigs-webhooks-partially-synced.yaml post /v2/webhooks The gigs.partially_synced webhook is sent after the requested range of historical gig data has been retrieved. By default, the historical period is 30 days and starts from the date [when the account was added](/api-reference/accounts-webhooks/added). > [!TIP] > > You can subscribe to this webhook multiple times with different numbers of specified days. > [!NOTE] > > 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.removed webhook Source: https://docs.argyle.com/api-reference/gigs-webhooks/removed openAPI/gigs-webhooks-removed.yaml post /v2/webhooks 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.updated webhook Source: https://docs.argyle.com/api-reference/gigs-webhooks/updated openAPI/gigs-webhooks-updated.yaml post /v2/webhooks 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`. # List All Gigs Source: https://docs.argyle.com/api-reference/gigs/list-all-gigs get /v2/gigs Returns a paginated list of all gig objects. # Retrieve A Gig Source: https://docs.argyle.com/api-reference/gigs/retrieve-a-gig get /v2/gigs/{id} Retrieves a gig object. # Identities Source: https://docs.argyle.com/api-reference/identities Profile and employment information. ## The identity object # Identities.added webhook Source: https://docs.argyle.com/api-reference/identities-webhooks/added openAPI/identities-webhooks-added.yaml post /v2/webhooks The `identities.added` webhook is sent when a new identity object is created, typically during initial data retrieval. Sent when an identity object is created or updated. # Identities.updated webhook Source: https://docs.argyle.com/api-reference/identities-webhooks/updated openAPI/identities-webhooks-updated.yaml post /v2/webhooks The `identities.updated` webhook is sent when there is any change to a property value of an [identity object](/api-reference/identities#object). # List All Identities Source: https://docs.argyle.com/api-reference/identities/list-all-identities get /v2/identities Returns a paginated list of all identity objects. # Retrieve An Identity Source: https://docs.argyle.com/api-reference/identities/retrieve-an-identity get /v2/identities/{id} Retrieves an identity object. # Invites Source: https://docs.argyle.com/api-reference/invites Email or text users a URL connecting them to Link. > [!NOTE] > > If integrating via verifications, use [`POST /v2/sessions`](/api-reference/verifications/create-a-session). 1. Adjust the invite text or branding through [Invite settings](https://console.argyle.com/settings/invite-template) in Console. 2. Send invites to users via email, SMS, or both. 3. Re-send an invite if a user needs to [return to Link](/console/flows/email-sms-templates#reconnecting-existing-users), or lost their original invite. ## The invite object # List All Invites Source: https://docs.argyle.com/api-reference/invites/list-all-invites get /v2/invites Returns an object containing all invite objects. # Re-send an invite Source: https://docs.argyle.com/api-reference/invites/re-send-an-invite post /v2/invites/{id} Re-sends a previously sent invite. Updates the `updated_at` and `invited_at` time. # Retrieve An Invite Source: https://docs.argyle.com/api-reference/invites/retrieve-an-invite get /v2/invites/{id} Retrieves an invite object. # Revoke An Invite Source: https://docs.argyle.com/api-reference/invites/revoke-an-invite post /v2/invites/{id}/revoke Invalidates a previously sent invite. If a user clicks a revoked invite URL, the landing page will notify the user the invite has expired. # Send An Invite Source: https://docs.argyle.com/api-reference/invites/send-an-invite post /v2/invites Immediately sends an invite via email, SMS, or both. Returns an invite object in the response. # Item Filters Source: 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 Source: https://docs.argyle.com/api-reference/item-filters/create-an-item-filter post /v2/item-filters Creates an Item filter using field coverage or Item status properties. 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 # Delete An Item Filter Source: https://docs.argyle.com/api-reference/item-filters/delete-an-item-filter delete /v2/item-filters/{id} Deletes an Item filter. # List All Item Filters Source: https://docs.argyle.com/api-reference/item-filters/list-all-item-filters get /v2/item-filters Returns a paginated list of all Item filters. # Replace An Item Filter Source: https://docs.argyle.com/api-reference/item-filters/replace-an-item-filter put /v2/item-filters/{id} Replaces the filters of an Item filter with a new set of filters. # Retrieve An Item Filter Source: https://docs.argyle.com/api-reference/item-filters/retrieve-an-item-filter get /v2/item-filters/{id} Retrieves an Item filter. # Items Source: https://docs.argyle.com/api-reference/items Users connect their payroll accounts through **Items** in Link. Our [Items guide](/overview/data-structure/items) provides more information on how to retrieve: * Which data fields an Item supports, and how often an Item is re-scanned for new data. * Whether an Item is `healthy` and supports new connections or is experiencing issues. * What data limits or other constraints the Item's underlying payroll system has, if any. ## The Item object # Items.removed webhook Source: https://docs.argyle.com/api-reference/items-webhooks/removed openAPI/items-webhooks-removed.yaml post /v2/webhooks 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. # Items.updated webhook Source: https://docs.argyle.com/api-reference/items-webhooks/updated openAPI/items-webhooks-updated.yaml post /v2/webhooks The `items.updated` webhook is sent when there is any change to a property value of an [Item object](/api-reference/items#object). The `config` parameter is **required** when subscribing to the `items.updated` webhook. Sent when Items are updated or removed. > [!NOTE] > > Subscribing to all webhooks at once [via Console](/console/management/webhooks#subscribing-to-webhooks) or [via the API](/api-guide/webhooks#subscribing-to-webhooks) will not create subscriptions to Items webhooks, which must be subscribed to individually with specific Items listed within the `config` parameter. # List All Items Source: https://docs.argyle.com/api-reference/items/list-all-items get /v2/items Returns a paginated list of all Item objects. # Migrate a Link Item ID Source: https://docs.argyle.com/api-reference/items/migrate-a-link-item-id post /v2/item-migrations 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. # Retrieve An Item Source: https://docs.argyle.com/api-reference/items/retrieve-an-item get /v2/items/{id} Retrieves an Item object. # API Reference Source: https://docs.argyle.com/api-reference/overview Find the API endpoint you need. Use this section for endpoint schemas, examples, webhooks, and errors. For implementation guidance, start with [Guides](/guides) or [Verticals](/verticals). > [card] [Verifications](/api-reference/verifications/order-a-verification) > > Order and track payroll, banking, Doc VOI, and government verification reports. > [card] [Payroll Data Sets](/api-reference/identities) > > Retrieve identities, paystubs, payroll documents, and work records from connected payroll accounts. > [card] [Supporting APIs](/api-reference/users) > > Create users, manage accounts and invites, inspect coverage, and handle errors. > [card] [Webhooks](/api-reference/verifications-webhooks/updated) > > Track verification, account, and data changes and manage webhook subscriptions. # List All Accounts Source: https://docs.argyle.com/api-reference/partners-data-sets/list-all-accounts openAPI/verifications-partners.yaml get /partners/v2/accounts Returns a paginated list of all payroll account objects. # List all bank accounts Source: https://docs.argyle.com/api-reference/partners-data-sets/list-all-bank-accounts openAPI/verifications-partners.yaml get /partners/v2/bank-accounts Returns a paginated list of the user's bank accounts. # List all payroll documents Source: https://docs.argyle.com/api-reference/partners-data-sets/list-all-payroll-documents openAPI/verifications-partners.yaml get /partners/v2/payroll-documents Returns a paginated list of all payroll document objects. # List all paystubs Source: https://docs.argyle.com/api-reference/partners-data-sets/list-all-paystubs openAPI/verifications-partners.yaml get /partners/v2/paystubs Returns a paginated list of all paystub objects. You must provide at least one of the following query parameters: `account`, `user`, or `employment`. # Retrieve a bank account Source: https://docs.argyle.com/api-reference/partners-data-sets/retrieve-a-bank-account openAPI/verifications-partners.yaml get /partners/v2/bank-accounts/{bank_account_id} Retrieves a bank account. # Retrieve a payroll document Source: https://docs.argyle.com/api-reference/partners-data-sets/retrieve-a-payroll-document openAPI/verifications-partners.yaml get /partners/v2/payroll-documents/{id} Retrieves a payroll document object. # Retrieve a paystub Source: https://docs.argyle.com/api-reference/partners-data-sets/retrieve-a-paystub openAPI/verifications-partners.yaml get /partners/v2/paystubs/{id} Retrieves a paystub object. # Retrieve An Account Source: https://docs.argyle.com/api-reference/partners-data-sets/retrieve-an-account openAPI/verifications-partners.yaml get /partners/v2/accounts/{id} Retrieves a payroll account object. # Receipts Source: https://docs.argyle.com/api-reference/partners-receipts openAPI/verifications-partners.yaml post /partners/v2/receipts Returns a PDF listing all billable transactions associated with the user. When `loan_number` is sent, the receipt can cover every borrower on that loan, depending on your contract. > [!WARNING] > > Receipt generation is only available in Production. The receipts endpoint is not supported in Sandbox. ## Example receipt ![Example Argyle billing receipt.](https://mintcdn.com/argyle/QY9l-CtcSx2-TuFM/images/api-ref/receipts/1-receipt.png?fit=max\&auto=format\&n=QY9l-CtcSx2-TuFM\&q=85\&s=804d00bd65e198993550746587ea0943) # Cancel a verification Source: https://docs.argyle.com/api-reference/partners-verifications/cancel-a-verification openAPI/verifications-partners.yaml post /partners/v2/verifications/{id}/cancel Cancels a verification order. Only verifications in the `PENDING` or `PAUSED` state can be cancelled. # Create a session Source: https://docs.argyle.com/api-reference/partners-verifications/create-a-session openAPI/verifications-partners.yaml post /partners/v2/sessions Create a connection session, send an invite, or create an invite link. * For an embedded session, provide `verification`. The response returns a `link` to launch or embed the frontend experience. The `link` expires after one hour. * For an invite, first create the user and at least one active verification. Set `type` to `invite` and provide `user`. Include `configuration.email`, `configuration.phone_number`, or both to send the invite by email or SMS. Omit both to create a link you can share yourself. The invite link expires after 180 days or when revoked. > [!NOTE] > > This endpoint is for payroll and banking verifications only. # Create a user Source: https://docs.argyle.com/api-reference/partners-verifications/create-a-user openAPI/verifications-partners.yaml post /partners/v2/users Creates a new user object for partner verification workflows. # List all verifications Source: https://docs.argyle.com/api-reference/partners-verifications/list-all-verifications openAPI/verifications-partners.yaml get /partners/v2/verifications Returns a paginated list of all verification objects. # Order a verification Source: https://docs.argyle.com/api-reference/partners-verifications/order-a-verification openAPI/verifications-partners.yaml post /partners/v2/verifications Orders a new verification. [Create a user](/verifications/platform-partners#create-the-user) or update an existing user with the required details before ordering payroll, banking, or document verifications. # Refresh a verification Source: https://docs.argyle.com/api-reference/partners-verifications/refresh-a-verification openAPI/verifications-partners.yaml post /partners/v2/verifications/refresh Creates a new payroll, banking, or Doc VOI verification without requiring the user to reconnect or upload additional documents. For payroll and banking, a valid connection must already exist. For Doc VOI, the new report is generated from the user's existing uploaded documents. The new verification inherits `loan.division` from the original verification. # Retrieve a verification Source: https://docs.argyle.com/api-reference/partners-verifications/retrieve-a-verification openAPI/verifications-partners.yaml get /partners/v2/verifications/{id} Retrieves a verification. # Update a user Source: https://docs.argyle.com/api-reference/partners-verifications/update-a-user openAPI/verifications-partners.yaml patch /partners/v2/users/{id} Updates a user object. # Update a verification Source: https://docs.argyle.com/api-reference/partners-verifications/update-a-verification openAPI/verifications-partners.yaml patch /partners/v2/verifications/{id} Updates verification metadata or employments. After a verification is updated, it will re-enter the `PROCESSING` state. # Upload a document Source: https://docs.argyle.com/api-reference/partners-verifications/upload-a-document openAPI/verifications-partners.yaml post /partners/v2/user-uploads Upload a document via the API. Upload a document via the API. > [!NOTE] > > Can be used in combination with [OCR processing](/integrations/ocr/ocrolus). # Verifications.connection_added webhook Source: https://docs.argyle.com/api-reference/partners-webhooks/connection-added openAPI/verifications-partners-webhooks-connection-added.yaml post /partners/v2/webhooks Sent when a new payroll account or banking institution is connected after a verification is completed or cancelled. # Create a webhook Source: https://docs.argyle.com/api-reference/partners-webhooks/create-a-webhook openAPI/webhooks.yaml post /partners/v2/webhooks Creates a webhook subscription. For webhook verification and retry behavior, see the [Webhooks guide](/api-guide/webhooks). # Verifications.creation_failed webhook Source: https://docs.argyle.com/api-reference/partners-webhooks/creation-failed openAPI/verifications-partners-webhooks-creation-failed.yaml post /partners/v2/webhooks The `verifications.creation_failed` webhook is sent when Argyle fails to create a verification. # Delete a webhook Source: https://docs.argyle.com/api-reference/partners-webhooks/delete-a-webhook openAPI/webhooks.yaml delete /partners/v2/webhooks/{id} Deletes a webhook subscription. # List all webhooks Source: https://docs.argyle.com/api-reference/partners-webhooks/list-all-webhooks openAPI/webhooks.yaml get /partners/v2/webhooks Returns a paginated list of webhook subscriptions. # Retrieve a webhook Source: https://docs.argyle.com/api-reference/partners-webhooks/retrieve-a-webhook openAPI/webhooks.yaml get /partners/v2/webhooks/{id} Retrieves a webhook subscription. # Verifications.updated webhook Source: https://docs.argyle.com/api-reference/partners-webhooks/updated openAPI/verifications-partners-webhooks-updated.yaml post /partners/v2/webhooks The verifications.updated webhook is sent when a verification's status changes. > [accordion] The verifications.updated webhook is sent for the following status codes: > > | Verification state | `status.code` | Data source | > | - | - | - | > | `PENDING` | `invite_sent` | Payroll and Banking | > | `PROCESSING` | `authenticated` | Payroll and Banking | > | `PROCESSING` | `documents_processing` | Documents | > | `PROCESSING` | `report_generating` | Payroll | > | `PROCESSING` | `awaiting_certification` | Payroll | > | `PAUSED` | `connection_attempted` | Payroll and Banking | > | `PAUSED` | `more_data_required` | Documents | > | `PAUSED` | `syncing_error` | Payroll and Banking | > | `CANCELLED` | `system_error` | Payroll and Banking | > | `CANCELLED` | `argyle_timeout` | Payroll, Documents, and Banking | > | `COMPLETED` | `completed` | Payroll, Documents, and Banking | > | `COMPLETED` | `completed_with_errors` | Payroll, Documents, and Banking | Set `config.include_resource = true` to receive the full verification object in the webhook you receive and inspect the `status.code`. # Payroll Documents Source: https://docs.argyle.com/api-reference/payroll-documents Retrieve metadata and PDF's of paystubs, tax forms, and other payroll documents. ## The payroll document object Additional scanned information from 1099 and W-2 documents retrieved from connected payroll accounts is returned in the payroll document object. * For scanned paystub information, use the [Paystubs API endpoint](/api-reference/paystubs). * For uploaded document information, use the [User Uploads API endpoint](/api-reference/user-uploads/overview). # Payroll Documents.added webhook Source: https://docs.argyle.com/api-reference/payroll-documents-webhooks/added openAPI/payroll-documents-webhooks-added.yaml post /v2/webhooks The `payroll_documents.added` webhook is sent when a new [payroll document](/api-reference/payroll-documents#object) is retrieved from a connected account. Sent when payroll document events occur. # Payroll Documents.ocr_completed webhook Source: https://docs.argyle.com/api-reference/payroll-documents-webhooks/ocr-completed openAPI/payroll-documents-webhooks-ocr-completed.yaml post /v2/webhooks 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 Source: https://docs.argyle.com/api-reference/payroll-documents-webhooks/ocr-failed openAPI/payroll-documents-webhooks-ocr-failed.yaml post /v2/webhooks 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). # Payroll Documents.removed webhook Source: https://docs.argyle.com/api-reference/payroll-documents-webhooks/removed openAPI/payroll-documents-webhooks-removed.yaml post /v2/webhooks 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.updated webhook Source: https://docs.argyle.com/api-reference/payroll-documents-webhooks/updated openAPI/payroll-documents-webhooks-updated.yaml post /v2/webhooks 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). # List All Payroll Documents Source: https://docs.argyle.com/api-reference/payroll-documents/list-all-payroll-documents get /v2/payroll-documents Returns a paginated list of all payroll document objects. # Retrieve A Payroll Document Source: https://docs.argyle.com/api-reference/payroll-documents/retrieve-a-payroll-document get /v2/payroll-documents/{id} Retrieves a payroll document object. # Paystubs Source: https://docs.argyle.com/api-reference/paystubs The digital equivalent of a traditional paystub. ## The paystub object # Paystubs.added webhook Source: https://docs.argyle.com/api-reference/paystubs-webhooks/added openAPI/paystubs-webhooks-added.yaml post /v2/webhooks The `paystubs.added` webhook is sent only when an account's data is [refreshed](/overview/ongoing-refresh) (does not include initial data retrieval) and a new paystub is retrieved. Sent when paystubs are added or updated. If you need to access to paystubs as soon as they are available: * 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 during initial data retrieval for a newly connected account. * The `paystubs.fully_synced` webhook is sent when all paystubs have been retrieved during initial data retrieval for a newly connected account. # Paystubs.fully_synced webhook Source: https://docs.argyle.com/api-reference/paystubs-webhooks/fully-synced openAPI/paystubs-webhooks-fully-synced.yaml post /v2/webhooks The `paystubs.fully_synced` webhook is sent when all paystubs have been retrieved from a newly connected payroll account. # Paystubs.partially_synced webhook Source: https://docs.argyle.com/api-reference/paystubs-webhooks/partially-synced openAPI/paystubs-webhooks-partially-synced.yaml post /v2/webhooks The paystubs.partially_synced webhook is sent after the requested range of historical paystub data has been retrieved. Set `config.days_synced` to specify the number of days of paystub history you need. The default is 30 days, counted backward from the date [when the account was added](/api-reference/accounts-webhooks/added). The history window uses each paystub's payment date (`paystub_date`), not the start or end date of its pay period. > [!NOTE] > > 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)). * This webhook is not sent when no paystubs are available within the requested window. For example, if `config.days_synced` is `90` and the most recent paystub's payment date is 100 days before the account was added, the webhook will not be sent. * 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. Handle full synchronization and set a timeout so your application does not wait indefinitely for this webhook. See [Retrieving paystubs](/overview/data-delivery#retrieving-paystubs) for the complete flow. # Paystubs.updated webhook Source: https://docs.argyle.com/api-reference/paystubs-webhooks/updated openAPI/paystubs-webhooks-updated.yaml post /v2/webhooks 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`. # List All Paystubs Source: https://docs.argyle.com/api-reference/paystubs/list-all-paystubs get /v2/paystubs Returns a paginated list of all paystub objects. # Retrieve A Paystub Source: https://docs.argyle.com/api-reference/paystubs/retrieve-a-paystub get /v2/paystubs/{id} Retrieves a paystub object. # Ratings Source: https://docs.argyle.com/api-reference/ratings Achievement and task summary details for gig employments. ## The rating object # Ratings.added webhook Source: https://docs.argyle.com/api-reference/ratings-webhooks/added openAPI/ratings-webhooks-added.yaml post /v2/webhooks The `ratings.added` webhook is sent when a new ratings object has been added for a user. Sent when a rating has been added or updated. # Ratings.updated webhook Source: https://docs.argyle.com/api-reference/ratings-webhooks/updated openAPI/ratings-webhooks-updated.yaml post /v2/webhooks The `ratings.updated` webhook is sent when there is any change to a property value of a [ratings object](/api-reference/ratings#object). # List All Ratings Source: https://docs.argyle.com/api-reference/ratings/list-all-ratings get /v2/ratings Returns a paginated list of all rating objects. # Retrieve A Rating Source: https://docs.argyle.com/api-reference/ratings/retrieve-a-rating get /v2/ratings/{id} Retrieves a rating object. # Receipts Source: https://docs.argyle.com/api-reference/receipts post /v2/receipts Returns a PDF listing all billable transactions associated with the user. When `loan_number` is sent, the receipt can cover every borrower on that loan, depending on your contract. > [!WARNING] > > Receipt generation is only available in Production. The receipts endpoint is not supported in Sandbox. ## Example receipt ![Example Argyle billing receipt.](https://mintcdn.com/argyle/QY9l-CtcSx2-TuFM/images/api-ref/receipts/1-receipt.png?fit=max\&auto=format\&n=QY9l-CtcSx2-TuFM\&q=85\&s=804d00bd65e198993550746587ea0943) # Reports Source: https://docs.argyle.com/api-reference/reports Generate PDF summaries based on Argyle's data sets. > [!NOTE] > > For new report implementations, use [Verifications](/verifications/overview). The classic Reports API is documented here for existing payroll integrations. If you need individual payroll records or your own income calculations, see [Verifications vs. Data APIs](/overview/verifications-vs-data-apis). Before [generating a report](/api-reference/reports/generate-a-report): * To ensure full data availability, we recommend subscribing to the [`reports.ready`](/api-reference/reports-webhooks/ready) webhook, which is sent when sufficient data has been retrieved to generate a verification report. * Depending on the data retrieval speed limits of the underlying payroll platform, it can take from a few seconds up to several minutes after a new account connection before enough data has been synced to generate a complete report. * Visit [Data Delivery and Readiness](/overview/data-delivery) for more information on the timing of data retrieval. After [generating a report](/api-reference/reports/generate-a-report): * A new report object is created. Its `file_url` property contains a link to the PDF report, and the `accounts` array lists which accounts were used to generate the report. * The PDF report will also appear and can be downloaded within Console. When VOIE+ is enabled, `voie-mortgage` reports include Freddie Mac's monthly income calculations when available. See the [VOIE+ PDF and JSON examples](/verifications/reports-and-source-documents#voie-plus). **Example reports:** > [accordion] Verification of Employment (VOE) — PDF and JSON > > [PDF](https://res.cloudinary.com/argyle-media/image/upload/v1746481161/docs-2025/voe_example.pdf) > > Report PDF > > ![Image of Argyle's Verification of Employment (VOE) report.](https://mintcdn.com/argyle/QY9l-CtcSx2-TuFM/images/api-ref/reports2/2-voe.png?fit=max\&auto=format\&n=QY9l-CtcSx2-TuFM\&q=85\&s=6c206b7a1dad09a13ec8d3e9f4ea3008) > > ```json theme={} > { > "report_id": "6c3fa756-2e76-43e1-55f6-e29fc6ae535d", > "type": "voe", > "user_id": "018051aa-f7a9-a0db-2f38-6cfa325e9d69", > "external_id": "March Connection", > "created_at": "2023-03-26T09:19:08.916Z", > "last_synced_at": "2023-03-24T12:41:21.576Z", > "metadata": {}, > "employments": [ > { > "employment": "0186a27d-e5c6-735a-a359-6315b34d544c", > "account": "0187c66e-e7e5-811c-b006-2232f00f426a", > "last_synced_at": "2023-03-24T12:41:21.576Z", > "source": "Worknight", > "first_name": "Bob", > "last_name": "Jones", > "full_name": "Bob Jones", > "ssn": "522-09-1191", > "employer": "Whole Goods", > "employer_address": { > "line1": "852 North W St", > "line2": null, > "city": "New York", > "state": "NY", > "postal_code": "10014", > "country": "US" > }, > "status": "active", > "employment_type": "full-time", > "job_title": "Store Manager", > "start_date": "2020-08-28", > "original_hire_date": "2020-08-28", > "end_date": null, > "length_of_work": { > "years": "2", > "months": "6" > }, > "last_pay_period_end_date": "2023-03-22", > "last_paystub_date": "2023-03-24" > }, > { > "employment": "0185a31d-e2c8-991c-a251-5977e36a418c", > "account": "018728a2-2fe0-cdb4-9486-70b2fe9834f9", > "last_synced_at": "2023-03-01T05:10:59.558Z", > "source": "Bullseye", > "first_name": "Bob", > "last_name": "Jones", > "full_name": "Bob Jones", > "ssn": "522-09-1191", > "employer": "Bullseye", > "employer_address": { > "line1": "119 Green Ridge", > "line2": null, > "city": "New York", > "state": "NY", > "postal_code": "10014", > "country": "US" > }, > "status": "active", > "employment_type": "part-time", > "job_title": "Clerk", > "start_date": "2020-06-29", > "original_hire_date": "2020-06-29", > "end_date": null, > "length_of_work": { > "years": "2", > "months": "9" > }, > "last_pay_period_end_date": "2023-02-23", > "last_paystub_date": "2023-02-24" > } > ] > } > ``` > [accordion] Verification of Income and Employment (VOIE) — PDF and JSON > > [PDF](https://res.cloudinary.com/argyle-media/image/upload/v1749501632/docs-2025/voie_example_argyle.pdf) > > Report PDF > > ![Image of Argyle's Verification of Income and Employment (VOIE) report.](https://mintcdn.com/argyle/QY9l-CtcSx2-TuFM/images/api-ref/reports2/1-voie.png?fit=max\&auto=format\&n=QY9l-CtcSx2-TuFM\&q=85\&s=2abf3c9ca559e53db7bf43dcd5eb2d59) > > ```json theme={} > { > "report_id": "6da4c9a3-2e63-95e5-8be3-f9a52ddc489a", > "type": "voie", > "user_id": "018051aa-f7a9-a0db-2f38-6cfa325e9d69", > "external_id": "March Connection", > "created_at": "2023-03-26T09:20:06.081Z", > "last_synced_at": "2023-03-24T12:41:25.069Z", > "metadata": {}, > "employments": [ > { > "employment": "0186a27d-e5c6-735a-a359-6315b34d544c", > "account": "018728a3-afee-5288-8e8a-c68ceb591359", > "last_synced_at": "2023-03-24T12:41:25.069Z", > "source": "Worknight", > "first_name": "Bob", > "last_name": "Jones", > "full_name": "Bob Jones", > "birth_date": "1980-10-10", > "ssn": "522-09-1191", > "phone_number": "+18009000010", > "email": "bob@email.com", > "employee_address": { > "line1": "342 Fence Rd", > "line2": null, > "city": "New York", > "state": "NY", > "postal_code": "10014", > "country": "US" > }, > "employer": "Whole Goods", > "employer_address": { > "line1": "852 North W St", > "line2": null, > "city": "New York", > "state": "NY", > "postal_code": "10014", > "country": "US" > }, > "status": "active", > "employment_type": "full-time", > "job_title": "Store Manager", > "base_pay": { > "amount": "75372.62", > "currency": "USD", > "period": "annual" > }, > "pay_cycle": "monthly", > "start_date": "2020-08-28", > "original_hire_date": "2020-08-28", > "end_date": null, > "length_of_work": { > "years": "2", > "months": "6" > }, > "last_pay_period_end_date": "2023-03-22", > "last_paystub_date": "2023-03-24", > "income": [ > { > "period": "2023", > "currency": "USD", > "gross_pay": { > "total": "25124.20", > "base": "25124.20", > "overtime": "0.00", > "commission": "0.00", > "bonus": "0.00", > "other": "0.00" > }, > "reimbursements": "8.13", > "deductions": "816.53", > "taxes": "5715.75", > "fees": "0.00", > "net_pay": "18600.05" > }, > { > "period": "2022", > "currency": "USD", > "gross_pay": { > "total": "82866.32", > "base": "81653.65", > "overtime": "0.00", > "commission": "881.09", > "bonus": "331.58", > "other": "0.00" > }, > "reimbursements": "4.35", > "deductions": "3266.12", > "taxes": "14948.85", > "fees": "0.00", > "net_pay": "64655.70" > } > ], > "monthly_income": { > "argyle": { > "total": "7102.33", > "base": "6902.55", > "overtime": "165.94", > "bonus": "5.22", > "commission": "28.62", > "other": "0.00" > } > }, > "callouts": [] > }, > { > "employment": "0185a31d-e2c8-991c-a251-5977e36a418c", > "account": "018728a2-2fe0-cdb4-9486-70b2fe9834f9", > "last_synced_at": "2023-03-01T05:10:59.558Z", > "source": "Bullseye", > "first_name": "Bob", > "last_name": "Jones", > "full_name": "Bob Jones", > "birth_date": "1980-10-10", > "ssn": "522-09-1191", > "phone_number": "+18009000010", > "email": "bob@email.com", > "employee_address": { > "line1": "342 Fence Rd", > "line2": null, > "city": "New York", > "state": "NY", > "postal_code": "10014", > "country": "US" > }, > "employer": "Bullseye", > "employer_address": { > "line1": "119 Green Ridge", > "line2": null, > "city": "New York", > "state": "NY", > "postal_code": "10014", > "country": "US" > }, > "status": "active", > "employment_type": "part-time", > "job_title": "Clerk", > "base_pay": { > "amount": "61030.57", > "currency": "USD", > "period": "annual" > }, > "pay_cycle": "monthly", > "start_date": "2020-06-29", > "original_hire_date": "2020-06-29", > "end_date": null, > "length_of_work": { > "years": "2", > "months": "9" > }, > "last_pay_period_end_date": "2023-02-23", > "last_paystub_date": "2023-02-24", > "income": [ > { > "period": "2023", > "currency": "USD", > "gross_pay": { > "total": "20848.92", > "base": "20343.52", > "overtime": "0.00", > "commission": "0.00", > "bonus": "505.40", > "other": "0.00" > }, > "reimbursements": "0.00", > "deductions": "915.48", > "taxes": "4475.58", > "fees": "0.00", > "net_pay": "15457.86" > }, > { > "period": "2022", > "currency": "USD", > "gross_pay": { > "total": "68070.08", > "base": "66116.44", > "overtime": "0.00", > "commission": "777.54", > "bonus": "1176.10", > "other": "0.00" > }, > "reimbursements": "18.40", > "deductions": "2034.40", > "taxes": "13274.18", > "fees": "0.00", > "net_pay": "52779.90" > } > ], > "monthly_income": { > "argyle": { > "total": "5683.51", > "base": "5512.92", > "overtime": "0.00", > "bonus": "119.51", > "commission": "51.08", > "other": "0.00" > } > }, > "callouts": [] > } > ], > "income_totals": [ > { > "period": "2023", > "currency": "USD", > "gross_pay": { > "total": "45973.12", > "base": "45467.72", > "overtime": "0.00", > "commission": "0.00", > "bonus": "505.40", > "other": "0.00" > }, > "reimbursements": "8.13", > "deductions": "1732.01", > "taxes": "10191.33", > "fees": "0.00", > "net_pay": "34057.91" > }, > { > "period": "2022", > "currency": "USD", > "gross_pay": { > "total": "150936.4", > "base": "147770.09", > "overtime": "0.00", > "commission": "1658.63", > "bonus": "1507.68", > "other": "0.00" > }, > "reimbursements": "22.75", > "deductions": "5300.52", > "taxes": "28223.03", > "fees": "0.00", > "net_pay": "117435.60" > } > ] > } > ``` ## The report object # Reports.generated webhook Source: https://docs.argyle.com/api-reference/reports-webhooks/generated openAPI/reports-webhooks-generated.yaml post /v2/webhooks The `reports.generated` webhook is sent when a report has been successfully [generated](/api-reference/reports#generate) and can be retrieved. # Reports.ready webhook Source: https://docs.argyle.com/api-reference/reports-webhooks/ready openAPI/reports-webhooks-ready.yaml post /v2/webhooks The reports.ready webhook is sent when a verification report can be generated. The webhook is sent once sufficient data has been retrieved from a connected payroll account. It is also sent after an [account reconnection](/workflows/reconnecting-accounts) once all new data has been retrieved. > [!NOTE] > > This webhook may be sent multiple times if the user connects multiple accounts. > > * The [accounts.connected](/api-reference/accounts-webhooks/connected) and [accounts.failed](/api-reference/accounts-webhooks/failed) webhooks can be used to track multiple account connections. > * Compare them to the accounts listed in the `reports.ready` webhook payload to determine when to generate a report. Sent when reports can be or have been generated. # Delete A Report Source: https://docs.argyle.com/api-reference/reports/delete-a-report delete /v2/reports/{id} Deletes a report object. # Generate A Report Source: https://docs.argyle.com/api-reference/reports/generate-a-report post /v2/reports/{type} Generates a new report and returns a report object. > [!NOTE] > > For new report implementations, use the [Verifications API](/api-reference/verifications/order-a-verification). This endpoint is documented for existing payroll integrations. If you need individual payroll records instead of a report, see [Verifications vs. Data APIs](/overview/verifications-vs-data-apis). > [!WARNING] > > 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. # List All Reports Source: https://docs.argyle.com/api-reference/reports/list-all-reports get /v2/reports Returns a paginated list of all report objects. # Retrieve A Report Source: https://docs.argyle.com/api-reference/reports/retrieve-a-report get /v2/reports/{id} Retrieves a report object. # Shifts Source: https://docs.argyle.com/api-reference/shifts Retrieve information on work shifts and hours spent on individual tasks. ## The shift object # Shifts.added webhook Source: https://docs.argyle.com/api-reference/shifts-webhooks/added openAPI/shifts-webhooks-added.yaml post /v2/webhooks The `shifts.added` webhook is sent only when an account's data is [refreshed](/overview/ongoing-refresh) (does not include initial data retrieval) and a new shift is retrieved. Sent when shifts are added, updated, or removed. If you need to access to shift data as soon as it is available: * 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 during initial data retrieval for a newly connected account. * The `shifts.fully_synced` webhook is sent when all shifts have been retrieved during initial data retrieval for a newly connected account. Because some accounts can contain hundreds of shifts, we recommend subscribing to the `shifts.partially_synced` webhook when especially time-sensitive. The `shifts.fully_synced` webhook will only be sent when all shift data has been retrieved, which may take up to several hours in these cases. # Shifts.fully_synced webhook Source: https://docs.argyle.com/api-reference/shifts-webhooks/fully-synced openAPI/shifts-webhooks-fully-synced.yaml post /v2/webhooks The `shifts.fully_synced` webhook is sent when all shifts have been retrieved from a newly connected payroll account. # Shifts.partially_synced webhook Source: https://docs.argyle.com/api-reference/shifts-webhooks/partially-synced openAPI/shifts-webhooks-partially-synced.yaml post /v2/webhooks The shifts.partially_synced webhook is sent after the requested range of historical shift data has been retrieved. By default, the historical period is 30 days and starts from the date [when the account was added](/api-reference/accounts-webhooks/added). > [!TIP] > > You can subscribe to this webhook multiple times with different numbers of specified days. > [!NOTE] > > * 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.removed webhook Source: https://docs.argyle.com/api-reference/shifts-webhooks/removed openAPI/shifts-webhooks-removed.yaml post /v2/webhooks 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.updated webhook Source: https://docs.argyle.com/api-reference/shifts-webhooks/updated openAPI/shifts-webhooks-updated.yaml post /v2/webhooks 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`. # List All Shifts Source: https://docs.argyle.com/api-reference/shifts/list-all-shifts get /v2/shifts Returns a paginated list of all shift objects. # Retrieve A Shift Source: https://docs.argyle.com/api-reference/shifts/retrieve-a-shift get /v2/shifts/{id} Retrieves a shift object. # User Forms Source: https://docs.argyle.com/api-reference/user-forms User form submissions. User forms are response forms (see [Step 4](/workflows/account-connections#search)) that users can submit as a fallback when they cannot find their employer or payroll provider. ## The user form object # User Forms.removed webhook Source: https://docs.argyle.com/api-reference/user-forms-webhooks/user-forms-removed openAPI/user-forms-webhooks-removed.yaml post /v2/webhooks The `user_forms.removed` webhook is only sent when an account is deleted. Sent when [user form](/api-reference/user-forms#object) events occur. User forms are response forms (see [Step 4](/workflows/account-connections#search)) that users can submit as a fallback when they cannot find their employer or payroll provider. # User Forms.submitted webhook Source: https://docs.argyle.com/api-reference/user-forms-webhooks/user-forms-submitted openAPI/user-forms-webhooks.yaml post /v2/webhooks The `user_forms.submitted` webhook is sent when a response form is submitted. The `user_forms.submitted` webhook is sent when a response form is submitted. # List All User Forms Source: https://docs.argyle.com/api-reference/user-forms/list-all-user-forms get /v2/user-forms Returns a paginated list of all user form objects. # Retrieve A User Form Source: https://docs.argyle.com/api-reference/user-forms/retrieve-a-user-form get /v2/user-forms/{id} Retrieves a user form object. # User Tokens Source: https://docs.argyle.com/api-reference/user-tokens Create user tokens for direct embedded Link initializations. > [!NOTE] > > [Payroll verifications](/verifications/overview) return a session `link` URL when creating a session. Use that URL to initialize embedded Link with `connectUrl` or launch Hosted Link directly. For more information, visit the [Verifications Guide](/verifications/overview) and [Link Initialization Guide](/link/initialization). # Create A User Token Source: https://docs.argyle.com/api-reference/user-tokens/create-a-user-token post /v2/user-tokens 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. # User Uploads Source: https://docs.argyle.com/api-reference/user-uploads Upload and retrieve documents. * Upload documents via the API. * Retrieve documents uploaded via the API. * Retrieve documents [manually uploaded through Link](/workflows/document-processing). * Retrieve [OCR data](/integrations/ocr/ocrolus#retrieving-ocr-data) and [authenticity information](/integrations/ocr/ocrolus#api) for uploaded documents. ## The user upload object For upload endpoint details, see [Upload A Document](/api-reference/user-uploads/upload-a-document). # User Uploads.added webhook Source: https://docs.argyle.com/api-reference/user-uploads-webhooks/added openAPI/user-uploads-webhooks-added.yaml post /v2/webhooks The `user_uploads.added` webhook is sent each time a document is uploaded to Link. This webhook is only sent after the user selects "Submit" for first-time uploads. Sent when document upload events occur. # User Uploads.ocr_authenticity webhook Source: https://docs.argyle.com/api-reference/user-uploads-webhooks/ocr-authenticity openAPI/user-uploads-webhooks-ocr-authenticity.yaml post /v2/webhooks The `user_uploads.ocr_authenticity` webhook is sent once per uploaded file when [Ocrolus authenticity](/api-reference/user-uploads#object-metadata-ocr_documents) data is available. # User Uploads.ocr_completed webhook Source: https://docs.argyle.com/api-reference/user-uploads-webhooks/ocr-completed openAPI/user-uploads-webhooks-ocr-completed.yaml post /v2/webhooks The `user_uploads.ocr_completed` webhook is sent once per uploaded file when [Ocrolus OCR](/api-reference/user-uploads#object-metadata-ocr_documents) data is available. - 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 `ocr_documents` on the [User Upload object](/api-reference/user-uploads/overview). # User Uploads.ocr_failed webhook Source: https://docs.argyle.com/api-reference/user-uploads-webhooks/ocr-failed openAPI/user-uploads-webhooks-ocr-failed.yaml post /v2/webhooks The `user_uploads.ocr_failed` webhook is sent once per uploaded file when Ocrolus OCR processing could not be completed. [OCR errors](/integrations/ocr/ocrolus#ocr-errors) are returned in `ocr_documents` on the [User Upload object](/api-reference/user-uploads/overview). # User Uploads.removed webhook Source: https://docs.argyle.com/api-reference/user-uploads-webhooks/removed openAPI/user-uploads-webhooks-removed.yaml post /v2/webhooks 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. # List All User Uploads Source: https://docs.argyle.com/api-reference/user-uploads/list-all-user-uploads get /v2/user-uploads Returns a paginated list of all user upload objects. # Retrieve A User Upload Source: https://docs.argyle.com/api-reference/user-uploads/retrieve-a-user-upload get /v2/user-uploads/{id} Retrieves a user upload object. # Upload A Document Source: https://docs.argyle.com/api-reference/user-uploads/upload-a-document post /v2/user-uploads Upload a document via the API. Upload a document via the API. > [!NOTE] > > Can be used in combination with [OCR processing](/integrations/ocr/ocrolus). # Users Source: https://docs.argyle.com/api-reference/users Users connect their payroll accounts using Link. ## The user object # Users.fully_synced webhook Source: https://docs.argyle.com/api-reference/users-webhooks/fully-synced openAPI/users-webhooks.yaml post /v2/webhooks The users.fully_synced webhook is sent after initial data retrieval completes for every newly connected payroll account. ### Multiple accounts * At least one account connection must succeed for this webhook to be sent. * If a user connects another account after the webhook has already been sent, it is sent again when data retrieval for the new account completes. ### Reconnections > [!WARNING] > > The `users.fully_synced` webhook is **not sent** when a user reconnects an existing account. For account reconnections, choose the webhook that matches your integration: * **Verifications API:** Subscribe to the [`verifications.updated`](/api-reference/verifications-webhooks/updated) webhook with `config.include_resource = true`.\ In `data.resource.status`, a report is ready when: * `state` is `COMPLETED` * `code` is `completed` or `completed_with_errors` * **Reports API:** Subscribe to the [`reports.ready`](/api-reference/reports-webhooks/ready) webhook to know when sufficient data is available after reconnection and a report can be requested. After requesting it, subscribe to the [`reports.generated`](/api-reference/reports-webhooks/generated) webhook to know when it can be retrieved. # Create A User Source: https://docs.argyle.com/api-reference/users/create-a-user post /v2/users Creates a new user object. Includes a new [user token](/link/user-tokens) in the response. # Delete A User Source: https://docs.argyle.com/api-reference/users/delete-a-user delete /v2/users/{id} Deletes a user object. Deleting a user object will also delete all accounts and resources associated with the user. # List All Users Source: https://docs.argyle.com/api-reference/users/list-all-users get /v2/users Returns a paginated list of all user objects. # Retrieve A User Source: https://docs.argyle.com/api-reference/users/retrieve-a-user get /v2/users/{id} Retrieves a user object. # Update A User Source: https://docs.argyle.com/api-reference/users/update-a-user patch /v2/users/{id} Updates a user object. > [!NOTE] > > For Banking, updates to user properties including [`external_metadata.open_banking.end_user`](/api-reference/users/update-a-user#body-external-metadata-open-banking-end-user) will be reflected in future banking reports. > > Setting a field to `null` or an empty string will update the Argyle user object but may cause future banking reports to continue to display the previous value. # Vehicles Source: https://docs.argyle.com/api-reference/vehicles Work vehicle information. ## The vehicle object # Vehicles.added webhook Source: https://docs.argyle.com/api-reference/vehicles-webhooks/added openAPI/vehicles-webhooks-added.yaml post /v2/webhooks The `vehicles.added` webhook is sent when a new vehicle object is added, either during an initial scan or when an account's data is [refreshed](/overview/ongoing-refresh). Sent when vehicles are added, updated, or removed. # Vehicles.removed webhook Source: https://docs.argyle.com/api-reference/vehicles-webhooks/removed openAPI/vehicles-webhooks-removed.yaml post /v2/webhooks 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. # Vehicles.updated webhook Source: https://docs.argyle.com/api-reference/vehicles-webhooks/updated openAPI/vehicles-webhooks-updated.yaml post /v2/webhooks The `vehicles.updated` webhook is sent when there is any change to a property value of a [vehicle object](/api-reference/vehicles#object). # List All Vehicles Source: https://docs.argyle.com/api-reference/vehicles/list-all-vehicles get /v2/vehicles Returns a paginated list of all vehicle objects. # Retrieve A Vehicle Source: https://docs.argyle.com/api-reference/vehicles/retrieve-a-vehicle get /v2/vehicles/{id} Retrieves a vehicle object. # Verifications.connection_added webhook Source: https://docs.argyle.com/api-reference/verifications-webhooks/connection-added openAPI/verifications-webhooks-connection-added.yaml post /v2/webhooks Sent when a new payroll account or banking institution is connected after a verification is completed or cancelled. # Verifications.creation_failed webhook Source: https://docs.argyle.com/api-reference/verifications-webhooks/creation-failed openAPI/verifications-webhooks-creation-failed.yaml post /v2/webhooks The `verifications.creation_failed` webhook is sent when Argyle fails to create a verification. Sent when creating a verification fails. # Verifications.updated webhook Source: https://docs.argyle.com/api-reference/verifications-webhooks/updated openAPI/verifications-webhooks-updated.yaml post /v2/webhooks The verifications.updated webhook is sent when a verification's status changes. > [accordion] The verifications.updated webhook is sent for the following status codes: > > | Verification state | `status.code` | Data source | > | - | - | - | > | `PENDING` | `invite_sent` | Payroll and Banking | > | `PROCESSING` | `authenticated` | Payroll and Banking | > | `PROCESSING` | `documents_processing` | Documents | > | `PROCESSING` | `report_generating` | Payroll | > | `PROCESSING` | `awaiting_certification` | Payroll | > | `PAUSED` | `connection_attempted` | Payroll and Banking | > | `PAUSED` | `more_data_required` | Documents | > | `PAUSED` | `syncing_error` | Payroll and Banking | > | `CANCELLED` | `system_error` | Payroll and Banking | > | `CANCELLED` | `argyle_timeout` | Payroll, Documents, and Banking | > | `COMPLETED` | `completed` | Payroll, Documents, and Banking | > | `COMPLETED` | `completed_with_errors` | Payroll, Documents, and Banking | Set `config.include_resource = true` to receive the full verification object in the webhook you receive and inspect the `status.code`. # Cancel a verification Source: https://docs.argyle.com/api-reference/verifications/cancel-a-verification openAPI/verifications.yaml post /v2/verifications/{id}/cancel Cancels a verification order. Only verifications in the `PENDING` or `PAUSED` state can be cancelled. # Create a session Source: https://docs.argyle.com/api-reference/verifications/create-a-session openAPI/verifications.yaml post /v2/sessions Create a connection session, send an invite, or create an invite link. * For an embedded session, provide `verification`. The response returns a `link` to launch or embed the frontend experience. The `link` expires after one hour. * For an invite, first create the user and at least one active verification. Set `type` to `invite` and provide `user`. Include `configuration.email`, `configuration.phone_number`, or both to send the invite by email or SMS. Omit both to create a link you can share yourself. The invite link expires after 180 days or when revoked. > [!NOTE] > > This endpoint is for payroll and banking verifications only. # List all verifications Source: https://docs.argyle.com/api-reference/verifications/list-all-verifications openAPI/verifications.yaml get /v2/verifications Returns a paginated list of all verification objects. # Order a verification Source: https://docs.argyle.com/api-reference/verifications/order-a-verification openAPI/verifications.yaml post /v2/verifications Orders a new verification. [Create a user](/verifications/quickstart#create-a-user) or update an existing user with the required details before ordering payroll, government, banking, or document verifications. # Refresh a verification Source: https://docs.argyle.com/api-reference/verifications/refresh-a-verification openAPI/verifications.yaml post /v2/verifications/refresh Creates a new payroll, banking, or Doc VOI verification without requiring the user to reconnect or upload additional documents. For payroll and banking, a valid connection must already exist. For Doc VOI, the new report is generated from the user's existing uploaded documents. The new verification inherits `loan.division` from the original verification. # Retrieve a verification Source: https://docs.argyle.com/api-reference/verifications/retrieve-a-verification openAPI/verifications.yaml get /v2/verifications/{id} Retrieves a verification. # Update a verification Source: https://docs.argyle.com/api-reference/verifications/update-a-verification openAPI/verifications.yaml patch /v2/verifications/{id} Updates verification metadata or employments. After a verification is updated, it will re-enter the `PROCESSING` state. # Create a webhook Source: https://docs.argyle.com/api-reference/webhooks/create-a-webhook openAPI/webhooks.yaml post /v2/webhooks Creates a webhook subscription. For webhook verification and retry behavior, see the [Webhooks guide](/api-guide/webhooks). # Delete a webhook Source: https://docs.argyle.com/api-reference/webhooks/delete-a-webhook openAPI/webhooks.yaml delete /v2/webhooks/{id} Deletes a webhook subscription. # List all webhooks Source: https://docs.argyle.com/api-reference/webhooks/list-all-webhooks openAPI/webhooks.yaml get /v2/webhooks Returns a paginated list of webhook subscriptions. # Retrieve a webhook Source: https://docs.argyle.com/api-reference/webhooks/retrieve-a-webhook openAPI/webhooks.yaml get /v2/webhooks/{id} Retrieves a webhook subscription. # Argyle Changelog Source: https://docs.argyle.com/changelog See what we’re building and launching, and subscribe to get updates. **November 5, 2026** HCMToGo support expands Argyle’s coverage. ## [Coverage enhancements](/changelog/2026-11-05) [![Coverage update illustration](/images/changelog-generic/coverage.png)](/changelog/2026-11-05) **HCMToGo**, the mobile app employees use to access the UKG Ready payroll and HR platform through partner and white-label providers, is now supported, expanding Argyle’s coverage to approximately **34,000 employers** across PEOs, payroll bureaus, and reseller networks. A new **UKG Ready** connection option also allows users to connect through the platform directly. * HCMToGo can be accessed via the Item ID `item_000149212` * UKG Ready can be accessed via the Item ID `item_000289539` **October 29, 2026** Refreshing a Link session will require a token for the same user. ## [Link token renewal](/changelog/2026-10-29) [![Link update illustration](/images/changelog-generic/link.png)](/changelog/2026-10-29) Starting **November 30, 2026**, a [user token](https://docs.argyle.com/link/user-tokens) will no longer be usable to refresh a different user’s Link session. Using a token for a different user will return an `invalid_user_token` error. When a user token expires (or five minutes before expiration on Web), the `onTokenExpired` [callback](https://docs.argyle.com/link/reference/callbacks#ontokenexpired) is triggered. It provides an update function for replacing the current session’s token without closing and re-initializing Link. Alternatively, you can create a new user token for existing users through the API’s [create a user token endpoint](https://docs.argyle.com/api-reference/user-tokens/create-a-user-token) and use the returned token to initialize a new Link session. When refreshing a token, use the existing user. *If your token refresh flow already uses the same user, no changes are required.* **October 28, 2026** Partner details added to verifications endpoints and webhooks. ## [API enhancements](/changelog/2026-10-28) [![API update illustration](/images/changelog-generic/api.png)](/changelog/2026-10-28) A new `partner` object has been added to the [verifications endpoints](https://docs.argyle.com/api-reference/verifications/list-all-verifications) and verification webhook payloads for verifications ordered through a partner. It contains the partner’s `id` and includes its `name` when available. This update applies to client and partner integrations. Existing `channel` values are unchanged. **October 27, 2026** Freddie Mac's monthly income calculations, alongside direct-source payroll data. ## [Introducing Direct VOIE+](/changelog/2026-10-27) [![Freddie Mac's monthly income calculations, alongside direct-source payroll data.](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/direct-voie-plus-changelog.png)](/changelog/2026-10-27) Direct VOIE+ is now available, adding monthly income calculations from Freddie Mac’s AIM Check API alongside the payroll data applicants share through Argyle. * **Assess financing options sooner:** Use Freddie Mac’s monthly income calculations to help structure loans earlier in the origination process. * **Reduce underwriting rework:** Spot differences between initial income estimates and Freddie Mac’s calculations before the file reaches underwriting. * **Keep your existing workflow:** Use Direct VOIE+ across Console, API, and Encompass without changing how you order verifications. *Contact your Argyle Customer Success Manager to enable Direct VOIE+ for your organization.* **October 27, 2026 Sandbox** Create test users for income and employment scenarios. ## [Console enhancements](/changelog/2026-10-27-sandbox) [![Create test users for income and employment scenarios.](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/custom-sandbox-changelog.png)](/changelog/2026-10-27-sandbox) You can now create custom Sandbox test users when previewing embedded flows in [Console Flows](https://console.argyle.com/flows). With **Sandbox mode** enabled, describe the income or employment scenario you want to test under **Create custom user** when testing embedded Flows. You’ll receive a username, test password, and guidance on which employer or payroll provider to select in Sandbox. Custom users are saved to your organization, so your team can reuse the same scenarios during testing. **October 26, 2026** Spanish language support on landing pages. ## [Link updates](/changelog/2026-10-26) [![Spanish language support on landing pages.](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/changelog-spanish-landing-page.png)](/changelog/2026-10-26) We’ve expanded Spanish language support to Argyle landing pages: * Applicants can now switch between English and Spanish using a language toggle. The landing page automatically opens in Spanish when the browser is set to Spanish. * The selected language carries through to payroll and banking connections, with no need to select it again. *No configuration is required.* **October 21, 2026** Order payroll and banking verifications in Console. ## [Verifications in Console](/changelog/2026-10-21) [![Order payroll and banking verifications in Console.](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/console-verifications.gif)](/changelog/2026-10-21) The new [**Verifications**](https://console.argyle.com/verifications) page in Console brings payroll, banking, and Doc VOI results together for mortgage teams. * **Order payroll and banking verifications** from a single form, with income, employment, and asset verification options. * **Track orders by borrower or verification** with Consumer and Verification views, plus search and filters for status, report type, data source, and more. * **Review reports and supporting documents** for each borrower, including results from verifications ordered through our API, Encompass, or other partner systems. See our [Console Verifications guide](https://docs.argyle.com/console/verifications) for more details. **October 13, 2026** Income identification improvements in Banking VOI and VOAI reports. ## [Integration enhancements](/changelog/2026-10-13) [![Income identification improvements in Banking VOI and VOAI reports](/images/changelog/2026-10-13/changelog-cover-banking.png)](/changelog/2026-10-13) **Expected release: November 3, 2026** We’re updating our [Banking VOI and Banking VOAI reports](https://docs.argyle.com/verifications/reports-and-source-documents#example-reports) to better distinguish income from personal transfers, refunds, and other non-income deposits. ✔️ **Refined income confidence:** P2P, cash, and check deposits are evaluated using payer information and deposit patterns. **Deposits with limited supporting information are less likely to receive High confidence**, while recognizable paycheck and gig-platform income can remain High. ✔️ **Improved non-income filtering:** Better recognition of refunds, reimbursements, loan disbursements, and earned-wage advances reduces the likelihood that these deposits are counted as income. ✔️ **Clearer income stream names:** Cash and ATM deposit streams with an unidentified payer use more descriptive names that include the deposit category, making them easier to review. **October 1, 2026** 1099 document authenticity is now available. ## [API enhancements](/changelog/2026-10-01) [![API update illustration](/images/changelog-generic/api.png)](/changelog/2026-10-01) Argyle’s existing OCR support for [1099 document uploads](https://docs.argyle.com/workflows/document-processing) now includes [authenticity analysis](https://docs.argyle.com/integrations/ocr/ocrolus) for 1099-MISC, 1099-K, 1099-R, and SSA-1099 forms. Authenticity scores and detailed authenticity information are available alongside existing OCR data. Results can be retrieved through the API or viewed in Console, including authenticity summaries. The existing `user_uploads.ocr_authenticity` webhook also provides notifications when results are available. **October 1, 2026 Legal** Updates to Customer Terms and consumer documents ## [Updates to Customer Terms and consumer documents](/changelog/2026-10-01-legal) [![Platform update illustration](/images/changelog-generic/breaking.png)](/changelog/2026-10-01-legal) We updated the Open Payroll Customer Terms and the documents they incorporate — the Data Protection Addendum, Support Policy, Service Levels and Subprocessor List — to cover upcoming releases for tax documents and employer outreach, to address customers that are consumer reporting agencies, and to describe how fees work for requests submitted through or delivered into third-party platforms, point-of-sale systems and loan origination systems. We also updated our consumer-facing documents, including the Consumer Terms, Privacy Notice, Cookie Policy and Messaging Policy, and retired the separate CCPA Notice, whose state-law disclosures now sit within the Privacy Notice. The updated versions are dated October 1, 2026 and are available at [argyle.com/legal](http://argyle.com/legal). **September 28, 2026** OnPay support expands Argyle’s coverage. ## [Coverage enhancements](/changelog/2026-09-28) [![Coverage update illustration](/images/changelog-generic/coverage.png)](/changelog/2026-09-28) **OnPay**, a payroll and HR platform for small and medium-sized businesses, is now available, expanding Argyle’s coverage by **300,000+ employees**. * OnPay can be accessed via the Item ID `item_000028957` **September 16, 2026** Wholesale lenders can now send broker-branded borrower invites through Argyle’s Verifications API and Encompass® TPO Connect. ## [Broker-branded invites for wholesale mortgage](/changelog/2026-09-16) Wholesale lenders can now send broker-branded borrower invites through [Argyle’s Verifications API](https://docs.argyle.com/verifications/wholesale-mortgage) and [Encompass® TPO Connect](https://docs.argyle.com/integrations/pos-los/encompass/tpo-connect). * **Broker-branded communication:** Email and SMS invites identify the broker, with contact details available in the email and landing page. * **API support:** Add broker details once per borrower using `external_metadata.broker`. The default wholesale flow provides broker-specific messaging without creating a separate flow for every broker. * **TPO Connect ordering:** Brokers can order payroll, asset, and document-based income verifications using the lender’s Argyle setup. Encompass Automated Service Ordering (ASO) also supports initial orders on broker-originated loans. ![Broker-branded email and SMS invites](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2026-09-16/wholesale-broker-invites.webp?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=21ff46c55f3c229b4e668a3d1dc86ffb) **September 15, 2026** Real-time feedback on document uploads. ## [Link updates](/changelog/2026-09-15) [![Real-time feedback on document uploads](/images/changelog/2026-09-15/doc-upload_feedback.webp)](/changelog/2026-09-15) You can now enable two checks for document uploads via Link: * **Incorrect document type** — If a user uploads a different document type from the one requested, Link rejects the upload and directs them to submit the correct type. This check is available for paystub, W-2, and 1099 requests. * **Paystub recency** — Set how recent a paystub must be (30 days by default). Older paystubs are rejected, and users are directed to submit a more recent one. Both checks work with PDFs and images, and can be enabled for individual Link flows under **Document upload settings** in Console’s [Flow Editor](https://console.argyle.com/flows). **September 9, 2026** Get notified when users add connections after a verification. ## [New connection notifications](/changelog/2026-09-09) [![Image](/images/changelog/2026-09-09/new_payroll_data.png)](/changelog/2026-09-09) **Monitor new connections after verifications** * A new `verifications.connection_added` webhook is now available for [clients](https://docs.argyle.com/api-reference/verifications-webhooks/connection-added) and [partners](https://docs.argyle.com/api-reference/partners-webhooks/connection-added). It is sent when a user adds a new payroll account or connects a new banking institution after a verification reaches `COMPLETED` or `CANCELLED`. * For verifications initiated through Encompass or Consumer Connect, an email notification is also sent when a new connection is added. * In Encompass, a one-click option to refresh the verification with the newly connected data is shown. **Track additional account data availability** * The optional `data.resource.availability` object in [account webhook](https://docs.argyle.com/api-reference/accounts-webhooks/added) payloads now includes `shifts` and `user_uploads` for `accounts.added`, `accounts.updated`, `accounts.connected`, and `accounts.failed`. **August 24, 2026** Skyward support expands Argyle’s coverage. ## [Coverage enhancements](/changelog/2026-08-24) [![Coverage update illustration](/images/changelog-generic/coverage.png)](/changelog/2026-08-24) **Skyward**, one of the largest education platforms in the U.S. and a provider of K–12 HR and payroll software, is now available through Argyle, expanding coverage to more than **1,200 organizations**, including hundreds of school districts and municipalities across the country. * Skyward can be accessed via the Item ID `item_000283932` **August 19, 2026** Send emails from your own domain. ## [Custom sending domain](/changelog/2026-08-19) [![Console update illustration](/images/changelog-generic/console.png)](/changelog/2026-08-19) Emails sent to consumers through Argyle can now come from an address on your own domain, such as `verifications@yourcompany.com`, instead of an Argyle email address. *Custom sender domains are currently available on request. Contact your Argyle Customer Success Manager to enable the feature, then follow the setup guide to configure it in Console.* **August 12, 2026** Send verification invites by email or SMS. ## [Verification invites](/changelog/2026-08-12) [![API update illustration](/images/changelog-generic/api.png)](/changelog/2026-08-12) Verification invites can now be created through the [Verifications API](https://docs.argyle.com/api-reference/verifications-guide#invites). * After ordering one or more verifications, [create a session](https://docs.argyle.com/api-reference/verifications/create-a-session) with `type: invite` and provide the user’s email address, phone number, or both. **July 20, 2026** Improved invite and landing page guidance. ## [Link updates](/changelog/2026-07-20) We’ve improved invites and landing pages to provide more guidance throughout the verification process: * Email and SMS invites now list all requested verifications, including income, employment, and assets. * As users complete each verification, or if they encounter an issue, the landing page directs them to the next required step or another available option. * If users try to exit before all requested verifications are complete, they are prompted to optionally complete any remaining verifications. ![Image](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2026-07-20/link_ux.webp?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=a20c67c9e579491514d47890794b28e6) **July 15, 2026** Franchise coverage expands with 1,500+ additional Items. ## [Coverage enhancements](/changelog/2026-07-15) [![Coverage update illustration](/images/changelog-generic/coverage.png)](/changelog/2026-07-15) **Argyle has expanded its franchise coverage, with an additional 1,500+ Items added for corporate and franchise employers across 14 major brands**, including Burger King, Dairy Queen, Domino’s, Dunkin’, KFC, Little Caesars, McDonald’s, Panera Bread, Pizza Hut, Planet Fitness, Popeyes, Subway, Taco Bell, and Wendy’s. **July 14, 2026** ExponentHR support expands Argyle’s coverage. ## [Coverage enhancements](/changelog/2026-07-14) [![Coverage update illustration](/images/changelog-generic/coverage.png)](/changelog/2026-07-14) **ExponentHR**, an HR, payroll, and benefits platform serving **300,000+ employees**, is now available through Argyle. * ExponentHR can be accessed via the Item ID `item_000278120` [Archive ](/changelog/archive) # API enhancements Source: https://docs.argyle.com/changelog/2019-12-31 Account errors have been introduced. December 31, 2019 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b)   [Account errors](https://argyle.com/docs/legacy/guides/troubleshooting/account-connection-errors) have been introduced. # API breaking changes Source: https://docs.argyle.com/changelog/2020-01-09 Activity data enhancements. January 9, 2020 API Breaking ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) Activity data enhancements. `activity.income` will now returns strings instead of json decimals. `activity.lat` and `activity.lng` will now be strings instead of decimals. # API enhancements Source: https://docs.argyle.com/changelog/2020-05-13 New account connection statuses and error codes. May 13, 2020 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) New account connection statuses and error codes. New and improved [account connection statuses](https://argyle.com/docs/api-reference/accounts#object-connection-status) and [error codes](https://argyle.com/docs/api-reference/account-connection-errors) were added. An [`auth_required`](https://argyle.com/docs/api-reference/account-connection-errors#authrequired) error code was added. This error means that a previously linked account disconnected from the work platform, and user needs to re-authenticate. # Link updates Source: https://docs.argyle.com/changelog/2020-10-13 Deposit switching is now supported. October 13, 2020 Link ![Link updates](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2020-10-13/1-deposit-switching.gif?s=f169906a69107d959270d0963c5262b1) Deposit switching is now supported. With this latest update, users can now update their direct deposit information and distribute their pay to a bank account of your choosing. See our [Deposit Switching Guide](https://argyle.com/docs/workflows/deposit-switching) for more information. # API enhancements Source: https://docs.argyle.com/changelog/2020-10-25 Introducing a new employments endpoint. October 25, 2020 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) Introducing a new employments endpoint. A new [employments endpoint](https://argyle.com/docs/legacy/api-reference/employments) has been added. Employment objects contain employment information including employment status, employment type, hire date, and termination dates. The employment endpoint supersedes the employment-related fields returned in the [profiles endpoint](https://argyle.com/docs/legacy/api-reference/profiles). An `employer` field has also been added to all data set endpoints: profiles, employments, finances, reputations, documents, vehicles, payouts, activities. The `employer` field lists the company or entity that employs the user. # API enhancements Source: https://docs.argyle.com/changelog/2020-10-28 Introducing a new Link Items endpoint. October 28, 2020 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) Introducing a new Link Items endpoint. A new [Link Items endpoint](https://argyle.com/docs/legacy/api-reference/link-items) has been added. The endpoint lists information about Items (the employers and payroll providers that users can select in Link), such as the Item's [health status](https://argyle.com/docs/legacy/api-reference/link-items#object-status) and [type](https://argyle.com/docs/legacy/api-reference/link-items#object-type). # API enhancements Source: https://docs.argyle.com/changelog/2020-11-08 Pay Data Structure Guide is now available. November 8, 2020 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) A new [Pay Data Structure Guide](https://argyle.com/docs/legacy/api-reference/pay-data-structure) is now available. This guide details how the [payouts endpoint](https://argyle.com/docs/legacy/api-reference/payouts) and [income-totals endpoint](https://argyle.com/docs/legacy/api-reference/income-totals) are structured. # API enhancements Source: https://docs.argyle.com/changelog/2020-11-10 New source field added to accounts endpoint. November 10, 2020 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) New source field added to accounts endpoint. A new `source` field has been added to the [accounts endpoint](https://argyle.com/docs/legacy/api-reference/accounts). This new field lists the payroll platform from which the account's data was sourced. # Link updates Source: https://docs.argyle.com/changelog/2020-11-22 Control Link UI when outside elements are selected. November 22, 2020 Link ![Link update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/link.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=b6ea923ffd5a9eaa46c5b7425326d751) Control Link UI when outside elements are selected. A new [Global UI Setting](https://argyle.com/docs/legacy/guides/argyle-link/customize#global-ui-settings) — "Close on outside click" — has been added that controls Link's behavior when users click outside of Link's UI element (Web only). # API enhancements Source: https://docs.argyle.com/changelog/2020-11-30 New features object added to Link Items endpoint November 30, 2020 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) New features object added to Link Items endpoint. A new `features` object has been added to the [Link Items endpoint](https://argyle.com/docs/legacy/api-reference/link-items#object-features). This object contains information on the Item's deposit switch capabilities. # API enhancements Source: https://docs.argyle.com/changelog/2020-12-01 New document_id field added to payouts endpoint. December 1, 2020 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) A new [document\_id](https://argyle.com/docs/legacy/api-reference/payouts#object-document_id) field has been added to the payouts endpoint. This document ID can be used to retrieve the original PDF of the payout by using `GET /documents/{id}` # Link updates Source: https://docs.argyle.com/changelog/2020-12-21 New DDS configuration parameter added. December 21, 2020 Link ![Link update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/link.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=b6ea923ffd5a9eaa46c5b7425326d751) New DDS configuration parameter added. The **Add bank account** button can be hidden during a deposit switch by setting the new `allow_add_allocation` [DDS config parameter](https://argyle.com/docs/legacy/api-reference/dds-configurations) to `false`. # Console enhancements Source: https://docs.argyle.com/changelog/2021-01-06 Sandbox testing has been enhanced. January 6, 2021 Console ![Console update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/console.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=8902f7b196ea043075ebcbb91c725787) Sandbox testing has been enhanced. We've added new ways to test Argyle using [Sandbox mode](https://argyle.com/docs/legacy/guides/getting-started/sandbox-mode/overview), which is available in Console or via the API. # API enhancements Source: https://docs.argyle.com/changelog/2021-01-07 New account error is now available. January 7, 2021 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) New account error is now available. An `unsupported_mfa_method` error has been added to the [accounts endpoint](https://argyle.com/docs/legacy/api-reference/accounts#object-pay_distribution). This error is shown when the platform uses a multi-factor authentication (mfa) method currently not supported by Link. # Link updates Source: https://docs.argyle.com/changelog/2021-01-10 Smart deposit switch routing has been enhanced. January 10, 2021 Link ![Link update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/link.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=b6ea923ffd5a9eaa46c5b7425326d751) Smart deposit switch routing has been enhanced. For deposit switches, if only `amount_allocation` or only `percent_allocation` is included in your [DDS configuration](https://argyle.com/docs/legacy/api-reference/dds-configurations), users will only be shown Link Items that support the respective allocation type. # API enhancements Source: https://docs.argyle.com/changelog/2021-01-26 New deposit switch object added to accounts endpoint and Link Item filter added. January 26, 2021 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) New deposit switch object added to accounts endpoint and Link Item filter added. A `pay_distribution` object was added to the `availability` object of the [accounts endpoint](https://argyle.com/docs/legacy/api-reference/accounts#object-availability). This object shows the status of a deposit switch, or any associated error and error message. Link Items can also now be [filtered](https://argyle.com/docs/legacy/api-reference/link-items#list-features.pay_distribution_update.max_allocations) by their max allocations. # API enhancements Source: https://docs.argyle.com/changelog/2021-02-27 New employment status has been added. February 27, 2021 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) New employment status has been added. `inactive` has been added as a possible `status` value in the [employments endpoint](https://argyle.com/docs/legacy/api-reference/employments#object-status). # API enhancements Source: https://docs.argyle.com/changelog/2021-02-28 New bank account type value was added. February 28, 2021 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) New bank account type value was added. `other` has been added as a possible value for `account_type` for bank accounts within the [pay allocations endpoint](https://argyle.com/docs/legacy/api-reference/pay-allocations#object-account_type). # API enhancements Source: https://docs.argyle.com/changelog/2021-03-02 New Link Item field added to Activities endpoint. March 2, 2021 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) New Link Item field added to Activities endpoint. A new `link_item` field has been added to the [activities endpoint](https://argyle.com/docs/legacy/api-reference/activities#object-link_item). # API enhancements Source: https://docs.argyle.com/changelog/2021-03-03 New available date field added to the documents endpoint. March 3, 2021 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) New available date field added to the documents endpoint. A new `available_date` field has been added to the [documents endpoint](https://argyle.com/docs/legacy/api-reference/documents#object-available_date). This field represents the timestamp when the document was made available to the employee. # API enhancements Source: https://docs.argyle.com/changelog/2021-03-08 Users can now be created via the API. March 8, 2021 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) Users can now be created via the API. Users and an associated user token can now be [created](https://argyle.com/docs/legacy/api-reference/users#create) through Argyle's API without needing to initiate Link. You can also now provide external metadata when creating or [updating](https://argyle.com/docs/legacy/api-reference/users#update) users via the API. # API enhancements Source: https://docs.argyle.com/changelog/2021-03-16 Metadata and error messages have been added. March 16, 2021 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) Metadata and error messages have been added. A `metadata` object has been added to the profiles, employments, reputations, documents, vehicles, activities, and pay allocations endpoints. A new `error_message` field has also been added to the `pay_distribution` and `connection` objects returned by the [accounts endpoint](https://argyle.com/docs/legacy/api-reference/accounts). # Console enhancements Source: https://docs.argyle.com/changelog/2021-03-17 Console 2.0 is live! March 17, 2021 Console ![Console update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/console.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=8902f7b196ea043075ebcbb91c725787) Console 2.0 is live! [Console](https://console.argyle.com/dashboard) has been redesigned top to bottom, with several major enhancements that make it easier to understand your users' employment data and manage your Argyle implementation: * The Data Viewer tab, now called Users, displays more information about your users and allows you to sort and filter (e.g. by employer or connection date). * A simplified one-page layout for user profiles allows you to view all employment data on the same tab, rather than across separate tabs for Payouts, Documents, etc. * The new API Keys tab allows you to create multiple keys for your Argyle environment. # API enhancements Source: https://docs.argyle.com/changelog/2021-03-21 New deposit switch errors added. March 21, 2021 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) The [accounts endpoint](https://argyle.com/docs/api-reference/accounts#object-direct_deposit_switch) now returns the following deposit switch errors: * `unsupported_by_employer` * `unknown_bank_account_types` * `missing_allocation_type` # API enhancements Source: https://docs.argyle.com/changelog/2021-04-11 Invites via Argyle's API is now available. April 11, 2021 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) Sending invites via the API (previously available only in Console) is now available via the [invites endpoint](https://argyle.com/docs/api-reference/invites). # API enhancements Source: https://docs.argyle.com/changelog/2021-04-13 Accounts object now returned in accounts webhooks' payloads. April 13, 2021 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) The full [account object](https://argyle.com/docs/api-reference/accounts#object) is now returned in the payload of the following account webhooks: * `accounts.added` * `accounts.updated` * `accounts.connected` * `accounts.failed` To receive the full account object in these webhooks, use `"include_resource: true"` in your webhook subscriptions. Additionally, the `linkItems` Link configuration attribute has replaced the now-deprecated `dataPartners` attribute. # API enhancements Source: https://docs.argyle.com/changelog/2021-04-25 New data fields are now available in the employments and payouts endpoints. April 25, 2021 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) The following fields have been added to the [employments endpoint](https://argyle.com/docs/legacy/api-reference/employments): * `base_pay.amount` * `base_pay.period` * `base_pay.currency` * `pay_cycle` * `platforms_ids.employee_id` * `platforms_ids.position_id` * `platforms_ids.platform_user_id` Two new fields have also been added to the [payouts endpoint](https://argyle.com/docs/legacy/api-reference/payouts): * `payout_period.start_date` * `payout_period.end_date` # Console enhancements Source: https://docs.argyle.com/changelog/2021-04-27 Invite enhancements in Console have been introduced. April 27, 2021 Console ![Console update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/console.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=8902f7b196ea043075ebcbb91c725787) When sending email/SMS invites in Console, you can now: * Invite multiple users at once by uploading CSV files. * Add direct deposit switches to invites. * Send invitations in Sandbox mode for testing purposes. Additionally, activities income is now shown in Console. # Console enhancements Source: https://docs.argyle.com/changelog/2021-04-28 Console now supports deposit switches and bulk invites. April 27, 2021 Console ![Console update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/console.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=8902f7b196ea043075ebcbb91c725787) Console now supports: * Adding direct deposit switches to Link flows. * Bulk invites to new users. # Link 3.0 is now available Source: https://docs.argyle.com/changelog/2021-05-05 Visit our Link Upgrade Guide to learn how to upgrade to Link's latest version. May 5, 2021 Link ![Link update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/link.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=b6ea923ffd5a9eaa46c5b7425326d751) Visit our [Link Upgrade Guide](https://argyle.com/docs/link/upgrade) to learn how to upgrade to Link's latest version. # Console enhancements Source: https://docs.argyle.com/changelog/2021-05-11 New invite customizations are now available. May 11, 2021 Console ![Console update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/console.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=8902f7b196ea043075ebcbb91c725787) When using Console to send email/SMS invites, you can now: * Specify which Link items should be shown to users. * Customize the success screen shown after an account connection. Additionally, a new **Invoices tab** is available in Console. This tab displays all monthly invoices, which can also be downloaded as PDFs. # API enhancements Source: https://docs.argyle.com/changelog/2021-05-12 The type of Link item is now an available field. May 12, 2021 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) The `kind` field has been added to the [Link items endpoint](https://argyle.com/docs/legacy/api-reference/link-items#object-kind). # API enhancements Source: https://docs.argyle.com/changelog/2021-05-16 Link items can now be specified when sending invites via the API. May 16, 2021 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) Link Items can now be specified when [sending invites via the API](https://argyle.com/docs/legacy/api-reference/user-invites#send-invite) using the `customization_id` parameter. # API enhancements Source: https://docs.argyle.com/changelog/2021-05-19 New invite template parameters are available. May 19, 2021 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) Four new parameters are now available when [creating invite templates](https://argyle.com/docs/legacy/api-reference/user-invites#create-template) within the `page_config` object: * `page_success_heading` * `page_success_description` * `page_success_show_button` * `page_success_button` # API enhancements Source: https://docs.argyle.com/changelog/2021-05-20 A new reports endpoint has been added. May 20, 2021 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) You can now generate verification of income and employment (VOIE) reports via the API using the new [reports endpoint](https://argyle.com/docs/api-reference/reports). # API enhancements Source: https://docs.argyle.com/changelog/2021-05-26 Achievement fields have been added to the reputations endpoint. May 26, 2021 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) The following fields have been added to the `achievements` object of the [reputations endpoint](https://argyle.com/docs/legacy/api-reference/reputations#object-achievements): * `points` * `metadata` # Link updates Source: https://docs.argyle.com/changelog/2021-05-31 Edit suggestions can now be added to deposit switches. May 31, 2021 Link ![Link update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/link.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=b6ea923ffd5a9eaa46c5b7425326d751) The `enable_suggestions` parameter is now available when defining [DDS configurations](https://argyle.com/docs/legacy/api-reference/dds-configurations). This optional parameter allows you pre-define suggested pay allocations to new bank accounts (i.e. 30% of pay should go to the new bank account). # Link updates Source: https://docs.argyle.com/changelog/2021-06-01 Bank accounts can now be removed through deposit switches. June 1, 2021 Link ![Link update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/link.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=b6ea923ffd5a9eaa46c5b7425326d751) You can now ask users to [remove a designated bank account](https://argyle.com/docs/workflows/deposit-switching#remove-a-bank-account) from their payroll system's direct deposit settings. # API enhancements Source: https://docs.argyle.com/changelog/2021-06-02 Link items can now be searched via Argyle's API. June 2, 2021 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) You can now [search Link items](https://argyle.com/docs/legacy/api-reference/link-items#search) via the API. # Link updates Source: https://docs.argyle.com/changelog/2021-06-08 You can now choose whether to allow editing during deposit switches. June 8, 2021 Link ![Link update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/link.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=b6ea923ffd5a9eaa46c5b7425326d751) The `allow_editing` parameter is now available for [DDS configurations](https://argyle.com/docs/legacy/api-reference/dds-configurations#object-allow_editing). When set to `true` users will be able to adjust their pay allocations during a deposit switch. # API enhancements Source: https://docs.argyle.com/changelog/2021-06-17 Link item logos can now be retrieved via the API. June 17, 2021 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) The `logo_url` field has been added to the [Link items endpoint](https://argyle.com/docs/legacy/api-reference/link-items#object-logo_url). *This field requires authentication.* # API enhancements Source: https://docs.argyle.com/changelog/2021-06-27 New Link item search parameters are now available. June 27, 2021 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) Both `kind` and `kind.not_in` filters are now available when [searching Link items](https://argyle.com/docs/legacy/api-reference/link-items#search). # Link updates Source: https://docs.argyle.com/changelog/2021-06-30 New Link customization parameters are now available. June 30, 2021 Link ![Link update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/link.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=b6ea923ffd5a9eaa46c5b7425326d751) The following parameters have been added to [Link's configuration parameters](https://argyle.com/docs/legacy/api-reference/configuration-parameters): * `excludeCategories` — Allows you to exclude specific Link items categories. * `excludeLinkItems` — Allows you to exclude specific Link items. # API enhancements Source: https://docs.argyle.com/changelog/2021-07-01 Two new deposit switch errors have been added. July 1, 2021 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) The following [deposit switch errors](https://argyle.com/docs/legacy/guides/troubleshooting/direct-deposit-switching-errors) will now be returned in the `error_code` field of the [accounts endpoint](https://argyle.com/docs/legacy/api-reference/accounts#object-error_code): * `unusable_bank_account` * `updated_too_recently` # API enhancements Source: https://docs.argyle.com/changelog/2021-07-07 Four new data fields have been added to the payouts endpoint. July 7, 2021 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) The following data fields have been added to the [payouts endpoint](https://argyle.com/docs/legacy/api-reference/payouts): * `deduction_list` * `tax_list` * `filing_status` * `fees` # Console enhancements Source: https://docs.argyle.com/changelog/2021-07-12 The Coverage tab has been introduced to Console. July 12, 2021 Console ![Console update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/console.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=8902f7b196ea043075ebcbb91c725787) Console's new [Coverage tab](https://console.argyle.com/coverage) provides a detailed breakdown of data fields available for all Link Items (employers, payroll providers, gig platforms) that users can connect to in Link, in addition to information like each Link Item's current connection status, support for deposit switching, and more. # API breaking changes Source: https://docs.argyle.com/changelog/2021-08-05 user or account parameters are now required when listing activities. August 5, 2021 API Breaking ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) When [listing activities](https://argyle.com/docs/legacy/api-reference/activities#list) using the activities endpoint, either an `account` or `user` parameter is always required. # Link updates Source: https://docs.argyle.com/changelog/2021-08-12 Analytics are now available for Link. August 12, 2021 Link ![Link update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/link.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=b6ea923ffd5a9eaa46c5b7425326d751) A new `onUIEvent` callback is now available, which can be used to track user actions in Link. For more information, visit our [Link Tracking Guide](https://argyle.com/docs/link/reference/tracking). # Link updates Source: https://docs.argyle.com/changelog/2021-08-25 Connection hints are now available in Link. August 25, 2021 Link ![Link update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/link.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=b6ea923ffd5a9eaa46c5b7425326d751) When users are entering their payroll credentials in Link, single-sign-on (SSO) login methods and other platform-specific hints are shown. Additionally, more Link customizations have been added: * The text of the **Return to search** button on Link's success screen can now be customized through the `backToSearchButtonTitle` attribute. * **Return to search** can now be toggled ON or OFF using the `showBackToSearchButton` attribute. # Console enhancements Source: https://docs.argyle.com/changelog/2021-09-09 Link can now be customized via Console. September 9, 2021 Console ![Console update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/console.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=8902f7b196ea043075ebcbb91c725787) We have introduced [Link Customizer](https://console.argyle.com/flows) to Console. This powerful Console feature let's you customize the appearance of Link in your app or website via a user-friendly interface within Console. *Link Customizer is now called Flows.* # API enhancements Source: https://docs.argyle.com/changelog/2021-11-05 The forms endpoint has been added to Argyle's API. November 5, 2021 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) The [forms endpoint](https://argyle.com/docs/legacy/api-reference/forms) has been added to Argyle's API. Forms are information fields you can optionally enable as a fallback when user's can't find their income source in Link. This allows you to capture data about the user's employer and check it against Argyle's Coverage via the newly introduced Coverage tab in Console. Forms can be added to your Link flows using [Link Customizer](https://console.argyle.com/flows) in Console. # Link updates Source: https://docs.argyle.com/changelog/2021-11-06 Documents can now be uploaded through Link. November 6, 2021 Link ![Link update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/link.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=b6ea923ffd5a9eaa46c5b7425326d751) Paystubs, W-2s, and 1099 documents can now be uploaded through Link. * Document upload can be used as a standalone Link flow or used as a fallback when users cannot find their employer or payroll platform in Link. * Document upload can be enabled through [Link Customizer](https://console.argyle.com/flows) in Console. * Uploaded documents can be viewed and downloaded through Console or retrieved using the [user uploads API endpoint](https://argyle.com/docs/api-reference/user-uploads-webhooks). *Requires Android 26 (Oreo) or above.* # Console enhancements Source: https://docs.argyle.com/changelog/2021-11-07 Subscribing to webhooks through Console is now available. November 7, 2021 Console ![Console update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/console.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=8902f7b196ea043075ebcbb91c725787) Visit the **webhooks** tab of [Console's Developers page](https://console.argyle.com/integrations) to create and manage webhooks. For more information, visit our [Console Webhooks Guide](https://argyle.com/docs/console/management/webhooks). # API enhancements Source: https://docs.argyle.com/changelog/2021-11-08 inactive is now a possible status value for pay allocations. November 8, 2021 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) `inactive` is now a possible `status` value returned by the [pay allocations endpoint](https://argyle.com/docs/legacy/api-reference/pay-allocations#object-status). # Link updates Source: https://docs.argyle.com/changelog/2021-11-18 Percentage allocations are now available for deposit switches. November 18, 2021 Link ![Link update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/link.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=b6ea923ffd5a9eaa46c5b7425326d751) Percentage allocations are now available for deposit switches. Additionally for deposit switches: * The `allow_add_allocation` value is now `false` by default. Setting this parameter to `true` will display the **Add bank account** button. * Titles and subtitles can now be customized through the `payDistributionReviewScreenTitle` and `payDistributionReviewScreenSubtitle` parameters. Lastly, the `showCantFindLinkItemAtTop` parameter can be used to determine whether the **Can't find your employer?** button is shown in Link. # Link updates Source: https://docs.argyle.com/changelog/2021-12-02 Direct logins to incorrect employers have been improved. December 2, 2021 Link ![Link update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/link.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=b6ea923ffd5a9eaa46c5b7425326d751) When using [direct logins](https://argyle.com/docs/workflows/account-connections#direct-login) to specific Link Items, if the user is linked to the wrong employer a **Find more employers** button can be added to the login screen that will return the user to Link's main employer search screen. Additionally, Link's loading screen has been improved. It now lets the user know how long they can expect before their account is connected after they submit login credentials and continuously communicates the account connection's status during the authentication process. # API breaking changes Source: https://docs.argyle.com/changelog/2021-12-03 argyle.io is now argyle.com December 3, 2021 API Breaking ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) We are migrating `argyle.io` to `argyle.com`. The old domain (`argyle.io`) will continue to operate until February 15th, 2022. Make sure to: * Replace all requests going to `argyle.io` with `argyle.com`. * Replace Link SDK and Web Link values to use: * `apiHost = "https://api.argyle.com/v1"` for the Production environment * `apiHost = "https://api-sandbox.argyle.com/v1"` for the Sandbox environment. (Web Link only) Replace Link's plugin script to use: ```html theme={} ``` # API breaking changes Source: https://docs.argyle.com/changelog/2021-12-07 Pagination has been added to Argyle's API. December 7, 2021 API Breaking ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) We are deprecating the `count` parameters for all API endpoints. * The `count` parameter has already been disabled for the activities endpoint. * The `count` parameter will be disabled for the payouts, documents, employments, profiles, vehicles, and reputations endpoints on December 16, 2021. * The `count` parameter will be disabled for the link-items, accounts, webhooks, and pay allocations endpoints on February 15, 2022. When bulk fetching via the API, you can now use the `limit` and `next` parameters. See the [pagination section](https://argyle.com/docs/api-guide/overview#pagination) of our API Guide for more information. # API updates Source: https://docs.argyle.com/changelog/2021-12-13 Argyle's systems are not vulnerable to the log4j critical exploitation bug. December 13, 2021 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) As you may be aware, there was a critical bug exploitation with `log4j`, however, we are happy to inform you that Argyle has not had exposure to this vulnerability and we have taken extra precautions to ensure that all available patches were pushed to production as soon as they were available. In reassurance that we were not affected by the `log4j` bug: * Our API is coded in Python, and the API Gateway we use (Traffik) is written in Go. This vulnerability has not impacted them, and we have conducted an internal penetration test to confirm we were not exposed. * Our broader tech stack contains a small number of Java repositories, and we use Logback instead of log4j. Our Java-based services have not been impacted by this vulnerability. * As for our broader tooling, only Metabase was listed among the vulnerable apps. This was not exposed to the internet, and we have pushed the latest patched version to production. * Finally, our hosted Elastic Cloud solution, which does not contain any user data, has been confirmed as not vulnerable. A new patch has been released, and our production cluster is running on this latest version. # API breaking changes Source: https://docs.argyle.com/changelog/2021-12-14 Known Link Item limitations have been added, and duplicate activity data prevention has been improved. December 14, 2021 API Breaking ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) * The `accounts.pay_distribution_failed` [webhook](https://argyle.com/docs/legacy/api-reference/accounts-webhooks#pay-distribution-failed) will now be sent when the user times out of the credentials submission screen in Link. * Sandbox credentials will now use `argyle.com` instead of `argyle.io`. * We have introduced new logic to prevent duplicate [activities](https://argyle.com/docs/legacy/api-reference/activities) data. In addition, we will be adding a new `activities.removed` webhook on December 16, 2021. * A new `known_limitations` field has been added to the link-items endpoint, for greater transparency around different payroll system limitations. * The `id` of [pay allocations](https://argyle.com/docs/legacy/api-reference/pay-allocations#object-id) will now be returned by the `pay_allocations.updated` [webhook](https://argyle.com/docs/legacy/api-reference/pay-allocations-webhooks#updated). # Link updates Source: https://docs.argyle.com/changelog/2021-12-16 The payroll provider fallback has been added to Link. December 16, 2021 Link ![Link update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/link.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=b6ea923ffd5a9eaa46c5b7425326d751) When users can't find their employer in Link search, they can now search from the payroll providers supported by Link and connect directly to their payroll provider. Additionally: * Show/hide password functionality has been added to Link's login screen. * `Primary` has been renamed to `Remainder` when adjusting amount pay allocations during deposit switches. # API enhancements Source: https://docs.argyle.com/changelog/2021-12-20 Status information has been added for Link items. December 20, 2021 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) We have added two new fields — `status` and `status_details` to the [link-items endpoint](https://argyle.com/docs/legacy/api-reference/link-items). We encourage API polling to proactively get the latest updates on Link item health status changes and issues. In preparation for upcoming features, we are also adding two additional properties to the [pay-allocations endpoint](https://argyle.com/docs/legacy/api-reference/pay-allocations): * `method` (*string*) * `card` (*object*) # Console enhancements Source: https://docs.argyle.com/changelog/2021-12-27 Navigation enhancements are now available in Console. December 27, 2021 Console ![Console update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/console.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=8902f7b196ea043075ebcbb91c725787) * Switching between Sandbox and Production modes in Console is now a simple toggle. * Navigating to your Console instance's account and company details has been improved. * Different functionalities available in Console have been re-organized to be more easily accessible. # API enhancements Source: https://docs.argyle.com/changelog/2022-01-04 Uuid's are replacing string-based Item ID's. January 4, 2022 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) A new `item_id` field has been added to the [link-items endpoint](https://argyle.com/docs/legacy/api-reference/link-items). This field returns the ID's of Link items in `uuid` format (e.g. `0126ba6f-c30b-42a8-bd6e-5d7e13b9bfac`). In the future, Link items will be queryable by their `item_id` values. This change is to accommodate names changes (i.e. Facebook to Meta) and lessens the reliance on string-based ID values. # Link updates Source: https://docs.argyle.com/changelog/2022-01-05 The onError Link callback has been added for Web Link. January 5, 2022 Link ![Link update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/link.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=b6ea923ffd5a9eaa46c5b7425326d751) * The `onError` callback is now available for Web Link. * Additional [Link errors](https://argyle.com/docs/legacy/guides/troubleshooting/link-errors) have also been added. # API enhancements Source: https://docs.argyle.com/changelog/2022-01-12 Item ID's have been added to the link-items endpoint. January 12, 2022 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) * The `item_id` field has been added to the [link-items endpoint](https://argyle.com/docs/legacy/api-reference/link-items). * Items can be [retrieved](https://argyle.com/docs/legacy/api-reference/link-items#retrieve) by this `item_id`. # Link updates Source: https://docs.argyle.com/changelog/2022-01-20 Sandbox test credentials have changed. January 20, 2022 Link ![Link update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/link.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=b6ea923ffd5a9eaa46c5b7425326d751) We have updated the [test credentials](https://argyle.com/docs/overview/sandbox-testing#connect-sample-users) used for sample users in Sandbox. We will continue to support the now deprecated credentials during a limited phase-out period. Please update your tests for the new credentials. # Link updates Source: https://docs.argyle.com/changelog/2022-01-21 Removing user-made allocations from deposit switches. January 21, 2022 Link ![Link update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/link.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=b6ea923ffd5a9eaa46c5b7425326d751) The `allow_add_allocation` [DDS configuration parameter](https://argyle.com/docs/legacy/api-reference/dds-configurations) has been deprecated. This removes the ability for users to create custom allocations outside the bounds of your chosen deposit switch allocation settings. # Link updates Source: https://docs.argyle.com/changelog/2022-01-28 Automated deposit switch flows for returning users. January 28, 2022 Link ![Link update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/link.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=b6ea923ffd5a9eaa46c5b7425326d751) If the `payDistributionAutoTrigger` parameter is set to `true`, deposit switches will take place (if configured) whenever a returning user enters Link. Default values for `payDistributionReviewScreenTitle` and `payDistributionReviewScreenSubtitle` have also been updated. # Console enhancements Source: https://docs.argyle.com/changelog/2022-01-31 Introductory learning modal has been added to Console. January 31, 2022 Console ![Console update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/console.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=8902f7b196ea043075ebcbb91c725787) A introductory "Get Started" learning modal has been added to Console to help new team members hit the ground running with Argyle. # Link updates Source: https://docs.argyle.com/changelog/2022-02-08 Full paycheck deposit switches are now available. February 8, 2022 Link ![Link update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/link.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=b6ea923ffd5a9eaa46c5b7425326d751) You can suggest that user's switch their entire direct deposit allocation to a bank account of your choosing by setting the `entire_allocation` [DDS configuration parameter](https://argyle.com/docs/legacy/api-reference/dds-configurations#object-entire_allocation) to `true`. The user's previous bank account allocations will be removed. # Link updates Source: https://docs.argyle.com/changelog/2022-02-09 Minimum supported Android and iOS versions for Link SDK updated. February 9, 2022 Link ![Link update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/link.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=b6ea923ffd5a9eaa46c5b7425326d751) To improve the integration experience for the Link SDK, the minimum supported versions for Android and iOS have been increased. The minimum supported versions are: * `Android 6.0 (API level 23)` * `iOS 12` # Coverage enhancements Source: https://docs.argyle.com/changelog/2022-02-13 Additional integrations have been added to Argyle's coverage. February 13, 2022 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) Last week Argyle launched new integrations to **Cornershop** by Uber, **OnPay**, and **Wagepoint**. * **Cornershop** by Uber can be accessed via the Link Item ID `item_000010242`. * **OnPay** can be accessed via the Link Item ID `item_000028957`. * **Wagepoint** can be accessed via the Link Item ID `item_000042693`. # Coverage enhancements Source: https://docs.argyle.com/changelog/2022-02-20 Additional integrations have been added to Argyle's coverage. February 20, 2022 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) Last week Argyle launched a new integration to **Spark Driver**, which can be accessed via the Link Item ID `item_000036409`. Our **Paycor** integration also now supports deposit switching. # API enhancements Source: https://docs.argyle.com/changelog/2022-02-23 file_url time limits will be reduced to 15 minutes. February 23, 2022 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) As part of Argyle's ongoing security enhancements, document PDFs returned by the [documents endpoint](https://argyle.com/docs/legacy/api-reference/documents) and [forms endpoint](https://argyle.com/docs/legacy/api-reference/forms) via the `file_url` field will only be accessible for 15 minutes (reduced from 1 hour) before the `file_url` must be refreshed via one of these Argyle endpoints using authorized access. This change will be implemented on April 1, 2022. # Coverage enhancements Source: https://docs.argyle.com/changelog/2022-02-27 Additional integrations have been added to Argyle's coverage. February 27, 2022 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) Last week Argyle launched a new integration to **Favor Delivery**. * **Favor Delivery** can be accessed via the Link Item ID `item_000014662`. # Link updates Source: https://docs.argyle.com/changelog/2022-03-03 The enable_suggestions DDS configuration parameter has been deprecated. March 3, 2022 Link ![Link update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/link.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=b6ea923ffd5a9eaa46c5b7425326d751) The `enable_suggestions` DDS configuration parameter will always be set to `true`. * Setting this parameter to `false` will be ignored. # API breaking changes Source: https://docs.argyle.com/changelog/2022-03-04 The count parameter will be removed March 31, 2022. March 4, 2022 API Breaking ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) The removal date of the `count` parameter from API endpoints in favor of pagination has been updated to **March 31, 2022**. # Coverage enhancements Source: https://docs.argyle.com/changelog/2022-03-06 Additional integrations have been added to Argyle's coverage. March 6, 2022 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) * Last week Argyle launched a new integration to **SAP SuccessFactors**. * Deposit switching is also now supported for our **JP Morgan Chase** integration. # API enhancements Source: https://docs.argyle.com/changelog/2022-03-10 Three new data fields have been added to Argyle's API. March 10, 2022 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) On March 17, 2022 three additional fields will be added. The [payouts](https://argyle.com/docs/legacy/api-reference/payouts) endpoint: * `gross_pay_ytd` — Gross pay amount received in the calendar year. * `net_pay_ytd` — Net pay amount received in the calendar year. The [accounts](https://argyle.com/docs/legacy/api-reference/accounts) endpoint: * `was_connected` — Indicated whether the account was ever previously connected. # Coverage enhancements Source: https://docs.argyle.com/changelog/2022-03-13 Additional integrations have been added to Argyle's coverage. March 13, 2022 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) Last week Argyle launched new integrations to **Patreon** and **Point Pickup**. * **Patreon** can be accessed via the Link Item ID `item_000029854`. * **Point Pickup** can be accessed via the Link Item ID `item_000030957`. # Console enhancements Source: https://docs.argyle.com/changelog/2022-03-15 Quality of life enhancements to Console. March 15, 2022 Console ![Console update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/console.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=8902f7b196ea043075ebcbb91c725787) * How users allocate their pay is now displayed in Console. * A new [Settings](https://console.argyle.com/settings) page has been added to Console. * Console's [Billings](https://console.argyle.com/settings/billing) page has been redesigned. * New Console instances will have three pre-loaded sample users and sample data. * Deposit switching can now be tested in Link Emulator in Console. # Coverage enhancements Source: https://docs.argyle.com/changelog/2022-03-23 Additional integrations have been added to Argyle's coverage. March 23, 2022 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) Last week Argyle launched a new integration to **Shiftsmart**. * **Shiftsmart** can be accessed via the Link Item ID `item_000035209`. # Link 4.0 coming soon Source: https://docs.argyle.com/changelog/2022-03-28 On April 7, 2022 a new Link 4.0 version will be released, focusing on visual enhancements. March 28, 2022 Link ![Link update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/link.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=b6ea923ffd5a9eaa46c5b7425326d751) On **April 7, 2022** a new Link 4.0 version will be released, focusing on visual enhancements. This update will focus on Link's UI and will not impact API endpoints, data quality, or data connections. # API breaking changes Source: https://docs.argyle.com/changelog/2022-03-31 Webhooks will be sent from an additional IP address. March 31, 2022 API Breaking ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) On **April 20, 2022** webhooks will be sourced from two different IP addresses. If you are subscribed to webhooks and use allowlists, add these IP addresses to your allowlists to avoid any issues: * `35.188.163.115` — The existing IP address for webhooks, which you may already have on your allowlists. * `34.122.50.253` — A new IP address for sourcing webhooks. # API enhancements Source: https://docs.argyle.com/changelog/2022-04-01 file_url URL active times have been reduced to 15 minutes. April 1, 2022 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) The validity of the URL returned by these fields is reduced to 15 minutes: * `file_url` for the [documents endpoint](https://argyle.com/docs/legacy/api-reference/documents) * `file_url` for the [reports endpoint](https://argyle.com/docs/legacy/api-reference/reports) * `file_url` for the [forms endpoint](https://argyle.com/docs/legacy/api-reference/forms) # Console enhancements Source: https://docs.argyle.com/changelog/2022-04-02 Argyle free trials are now available. April 2, 2022 Console ![Console update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/console.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=8902f7b196ea043075ebcbb91c725787) Free trials are now available through Console's sign-up flow. Connect five real income and employment accounts to test Argyle's real-time connections to payroll data. Console's [billing page](https://console.argyle.com/settings/billing) has also been upgraded: * A downloadable CSV is available for each month's invoice listing that month's billable events. * A new pricing panel has been added, with full transparency on fees. * Billing details can be edited directly in Console. * A new design for invoices is live. Lastly, we have redesigned our Verification of Income and Employment (VOIE) report PDF's to be cleaner and easier to read. Reports can be generated in Console or via the API using the [reports endpoint](https://argyle.com/docs/legacy/api-reference/reports). # Coverage enhancements Source: https://docs.argyle.com/changelog/2022-04-03 Additional integrations have been added to Argyle's coverage. April 3, 2022 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) Last week Argyle launched a new integration to **Handy**. * **Handy** can be accessed via the Link Item ID `item_000002675`. # Link 4.0 Source: https://docs.argyle.com/changelog/2022-04-07 Argyle has released Link 4.0, an updated version of Link that includes: A new intro screen experience that is customizable through Flows in Console A modern, simple, and breathable search screen layout An improved login experience Simplified multi-factor authentication (MFA) experiences Clearer error messaging April 7, 2022 Link ![Link update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/link.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=b6ea923ffd5a9eaa46c5b7425326d751) Argyle has released Link 4.0, an updated version of Link that includes: * A new intro screen experience that is customizable through Flows in Console * A modern, simple, and breathable search screen layout * An improved login experience * Simplified multi-factor authentication (MFA) experiences * Clearer error messaging # Coverage enhancements Source: https://docs.argyle.com/changelog/2022-04-11 Additional integrations have been added to Argyle's coverage. April 11, 2022 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) Last week Argyle launched new integrations to **FrankCrum** and **Oracle PeopleSoft**. * **FrankCrum** can be accessed via the Link Item ID `item_000015721`. * **Oracle PeopleSoft** can be accessed via the Link Item ID `item_000029125`. **Oracle Cloud HCM** now support deposit switching. This integration powers several Link items including: * Macy's * Kaiser Permanente * Victoria's Secret `Login.gov` is now a supported login method of **Veterans Affairs**, Link Item ID `item_000042186`. # Link updates Source: https://docs.argyle.com/changelog/2022-04-13 Deposit switches to debit cards are now supported. April 13, 2022 Link ![Link update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/link.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=b6ea923ffd5a9eaa46c5b7425326d751) Argyle now supports deposit switches to debit cards. This feature can be used to re-direct user's pay to specific payout cards that many gig platforms use to pay employees in lieu of traditional bank account direct deposits. A new `card` object has been added to the [pay allocations endpoint](https://argyle.com/docs/legacy/api-reference/pay-allocations). # Coverage enhancements Source: https://docs.argyle.com/changelog/2022-04-19 Data availability speed enhancements to Argyle's integrations. April 19, 2022 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) Argyle's **Paylocity** integration's speed has increased dramatically. * Waiting times have been reduced to near-zero for deposit switches. * Data availability is now two-thirds the previous time it took to receive data. New integrations have been added for **Virtual OneStop** and **UKG Ready**. Argyle's **JPMorganChase** integration now returns [activities](https://argyle.com/docs/legacy/api-reference/activities-webhooks) data. # API enhancements Source: https://docs.argyle.com/changelog/2022-04-21 New property returned by the Pay Distribution Updated webhook. April 21, 2022 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) The `pay_distribution_changed` [field](https://argyle.com/docs/legacy/api-reference/accounts-webhooks#pay-distribution-updated_message-pay_distribution_changed) has been added to the [Pay Distribution Updated](https://argyle.com/docs/legacy/api-reference/accounts-webhooks#pay-distribution-updated) webhook. This field returns `true` or `false` to indicate whether a successful direct deposit update resulted in any changes in the user's pay allocation details. # Coverage enhancements Source: https://docs.argyle.com/changelog/2022-04-25 Additional integration has been added to Argyle's coverage. April 25, 2022 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) Last week Argyle launched a new integration to **Namely**. * **Namely** can be accessed via the Link Item ID `item_000027052`. # Link 4.1 Source: https://docs.argyle.com/changelog/2022-05-04 Developer testing and deposit switch error improvements. May 4, 2022 Link ![Link update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/link.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=b6ea923ffd5a9eaa46c5b7425326d751) * Developer testing for iPhone simulators on M1 MacBooks (ARM64 architecture) is now supported. * More payroll providers are available to users in the “Can’t find your employer?” questionnaire. * Direct deposit switching error messaging is now clearer, making it easier for users to understand how they can troubleshoot issues. # API enhancements Source: https://docs.argyle.com/changelog/2022-05-05 Deposit switch (card) updates May 5, 2022 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) The following deposit switch (card) updates have been made: [Pay allocations endpoint](https://argyle.com/docs/legacy/api-reference/pay-allocations): * The `card.is_default` property has been removed. * The `card.is_platform_card` property has been added to distinguish between platform and non-platform cards. [Link items endpoint](https://argyle.com/docs/legacy/api-reference/link-items): * The `features.pay_distribution_card_update` object has been added. It includes supported and max\_allocations fields. [DDS Configs](https://argyle.com/docs/legacy/api-reference/dds-configurations): * `cardholder_title` is now an optional field. # Coverage enhancements Source: https://docs.argyle.com/changelog/2022-05-09 Additional integrations have been added to Argyle's coverage. May 9, 2022 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) * Last week Argyle launched new integrations to **krowD**, **Oasis Paychex HR**, and **Veryable**. * The **Namely** integration now supports deposit switching. # API enhancements Source: https://docs.argyle.com/changelog/2022-05-20 New fields added to pay allocations endpoint. May 20, 2022 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) The following fields have been added to the [pay allocations endpoint](https://argyle.com/docs/legacy/api-reference/pay-allocations): 1. `destination_type` — possible values are `bank_account`, `card`, or `acss_debit` 2. `acss_debit` — destination type representing Canadian bank accounts Additionally, the `card` object is now only returned when `destination_type` is `card`. # Coverage enhancements Source: https://docs.argyle.com/changelog/2022-05-24 Additional integrations have been added to Argyle's coverage. May 24, 2022 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) * Last week Argyle launched a new integration to **Waitr**. * The **krowD** integration now supports deposit switching. # API enhancements Source: https://docs.argyle.com/changelog/2022-05-26 Deposit switch enhancements. May 26, 2022 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) New `card` configuration parameters have been added for address details. Populating these fields allow you to perform deposit switches to cards when address details are required. Additionally, two new deposit switch errors have been added: * `physical_mfa_unsupported` * `unsupported_bank_account_country` # Coverage enhancements Source: https://docs.argyle.com/changelog/2022-06-06 Additional integrations have been added to Argyle's coverage. June 6, 2022 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) Last week Argyle launched a new integration to **Netspend**, which powers a number of employers including HCA Healthcare. These additional integration enhancements were also made: * The **SAP** integration now supports deposit switching. * The **Favor Delivery** and **Rover** integrations now support deposit switches to cards. * The **Veterans Affairs** integration now adjusts the username field in Link depending on the login method selected. # API enhancements Source: https://docs.argyle.com/changelog/2022-06-07 New fields added to Pay Distribution Updated webhook. June 7, 2022 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) New fields have been added to the [Pay Distribution Updated](https://argyle.com/docs/legacy/api-reference/accounts-webhooks#pay-distribution-updated) webhook. Additionally, a new `missing_allocation` deposit switch error has been added. This error indicates a deposit switch allocation does not have a "remainder" amount (the allocation totals do not add up to 100%). # Link 4.2 Source: https://docs.argyle.com/changelog/2022-06-15 Document upload and form fallback improvements. June 15, 2022 Link ![Link update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/link.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=b6ea923ffd5a9eaa46c5b7425326d751) The Argyle team has released these updates to Link: * You can now deep link users to the [document upload](https://argyle.com/docs/workflows/document-processing) feature. * The team has made improvements to the income source and payroll providers questionnaire. * There is a new income source-only questionnaire option for your users. * The team has added the `onFormSubmitted` and `onDocumentsSubmitted` [callback events](https://argyle.com/docs/link/reference/callbacks) after successful questionnaire submission and document upload. * The Link Intro screen is now also available for users who see a specific list of Link items. * The Deep link Login screen now informs users of your partnership with Argyle. * The user disclosure text has been updated to provide transparency to your users. * The order of the Suggestions tabs has been changed to: **Popular**, **Payroll**, **Employer**, **Gig**. * The Kotlin version used in the Android SDK has been updated to `Kotlin 1.6.21`. # API enhancements Source: https://docs.argyle.com/changelog/2022-06-16 Two new properties added to the Link Items endpoint. June 21, 2022 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) Two new properties have been added to the [Link Items endpoint](https://argyle.com/docs/legacy/api-reference/link-items): * A `required_fields` [object](https://argyle.com/docs/legacy/api-reference/link-items#object-required_fields) has been added to the `pay_distribution_update` object and `pay_distribution_card_update` object. This `required_fields` object lists the fields required for deposit switch updates to bank accounts and cards, respectively. # API enhancements Source: https://docs.argyle.com/changelog/2022-06-21 Field and type validations for deposit switches. June 16, 2022 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) Field and type validations will now be applied when [encrypting DDS Configs](https://argyle.com/docs/legacy/api-reference/dds-configurations#encrypt). New fields have been added to the `cards` object: * `cardholder_first_name` * `cardholder_last_name` * `country` * `postal_code` Lastly, on **June 28, 2022** two new webhooks will be introduced: * `forms.ocr_failed` * `documents.ocr_failed` # API breaking changes Source: https://docs.argyle.com/changelog/2022-06-22 Removal of the finances endpoint. June 22, 2022 API Breaking ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) The `finances` API endpoint, which was deprecated on **June 10, 2021** will be fully removed on **July 1, 2022**. Please review your implementation to ensure that you are not using this endpoint. Reach out to your Customer Success Manager if you would like to discuss alternative endpoints for retrieving finance data. # API enhancements Source: https://docs.argyle.com/changelog/2022-06-28 Two new document OCR webhooks have been added. June 28, 2022 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) Two new webhooks have been added: * `forms.ocr_failed` [webhook](https://argyle.com/docs/legacy/api-reference/forms-webhooks#ocr-failed) — for document uploads * `documents.ocr_failed` [webhook](https://argyle.com/docs/legacy/api-reference/documents-webhooks#ocr-failed) — for documents retrieved from payroll connections and scanned by Argyle # Coverage enhancements Source: https://docs.argyle.com/changelog/2022-06-30 Additional integrations have been added to Argyle's coverage. June 30, 2022 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) Last week Argyle launched a new integration to **Asure HCM**, which powers a number of employers including **AMS Auto Group**. These additional integration enhancements were also made: * The **SAP** integration now powers **Walt Disney** as an employer. * The **Shipt** integration now support deposit switches to cards. # Console enhancements Source: https://docs.argyle.com/changelog/2022-07-08 New activity dashboard and billing enhancements. July 8, 2022 Console ![Console update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/console.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=8902f7b196ea043075ebcbb91c725787) A new **Activity** area has been added to [Console's Dashboard](https://console.argyle.com/dashboard), letting you quickly understand your connections and other Argyle metrics with data visualizations. The **Billing** area of **Settings** has been improved: * The Billing tab now includes a chart of your Argyle invoices over time. * Within the Billing tab, you’re now able to edit your billing email address and credit card details if you pay by credit card. * The new Plan tab provides a quick overview of which Argyle capabilities you have enabled and their pricing. A number of additional minor enhancements have been added throughout Console, including improvements to **Link Customizer** and **Link Emulator**. # Link 4.3 Source: https://docs.argyle.com/changelog/2022-07-13 New callbacks and login screen improvements. July 13, 2022 Link ![Link update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/link.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=b6ea923ffd5a9eaa46c5b7425326d751) The Argyle team has released these updates to Link: * You can now give your users the option to upload documents to verify their income if they cannot find their income source. Set the "If no results" experience to Document upload in [Link Customizer](https://console.argyle.com/flows) to utilize this feature. * The `onCantFindLinkItemClicked` callback is now available through Link Customizer. * If you have defined this callback in your implementation, you must set the new behavior in Link Customizer. Set the "If no results" experience to Callback in Customizer to utilize `onCantFindLinkItemClicked`. If you do not apply this setting, the callback will be ignored. * If you select Callback in the "If no results" experience, you must also define the `onCantFindLinkItemClicked` callback programmatically. If you do not define this callback in your implementation, Link will raise the `callback_undefined` error. * The `onUIEvent` callback can now be invoked in additional scenarios. * The Login screen design has been refreshed, with some small updates to the user disclosure text. * A new overlay on the Login screen prompts your users to reset their password when they enter incorrect credentials. You can now integrate Argyle Link into your iOS application using the Swift Package Manager. Link SDK upgrades are now available: * [iOS 4.3](https://argyle.com/docs/link/upgrade#ios) * [Android 4.3](https://argyle.com/docs/link/upgrade#android) * [React Native 4.3](https://argyle.com/docs/link/upgrade#react-native) * Web integrations will automatically update to include these latest features. # Link updates Source: https://docs.argyle.com/changelog/2022-07-20 Removing bank accounts via deposit switches introduced. July 20, 2022 Link ![Link update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/link.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=b6ea923ffd5a9eaa46c5b7425326d751) You can now [remove bank accounts](https://argyle.com/docs/workflows/deposit-switching#remove-a-bank-account) via deposit switches. This option is available now for Web implementations, and will be available for iOS, Android, and React Native integrations in the next Link release. # Console enhancements Source: https://docs.argyle.com/changelog/2022-08-01 New conversion dashboard and duplicating Link customizations. August 1, 2022 Console ![Console update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/console.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=8902f7b196ea043075ebcbb91c725787) * Argyle's new [Conversion Dashboard](https://console.argyle.com/dashboard) enables you to understand your users' Link experience and drive higher conversion. This dashboard provides insight on users’ progress through each step of the account connection flow and shows you historical data to track how your conversion rate evolves over time. * You can now duplicate your Customizations, enabling you to quickly iterate on an existing Customization while maintaining the original. * When you invite users to connect payroll accounts via a [URL invite](https://argyle.com/docs/api-reference/invites), you will now receive a confirmation email at the `reply-to` address you provided as soon as the user connects successfully. # Coverage enhancements Source: https://docs.argyle.com/changelog/2022-08-02 Additional integrations have been added to Argyle's coverage. August 2, 2022 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) Last week Argyle launched a new integration to **Netspend**, which powers a number of employers including **HCA Healthcare**. These additional integration enhancements were also made: * The **Grubhub** integration now supports deposit switches to cards. * The **Namely** integration now returns activities data. # API enhancements Source: https://docs.argyle.com/changelog/2022-08-03 New data fields added to payouts endpoint. August 3, 2022 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) New data fields have been added to the [payouts endpoint](https://argyle.com/docs/legacy/api-reference/payouts): * `gross_pay_list` — an itemized breakdown of gross pay line items * `gross_pay_list_totals` — categorized gross pay, broken down into five categories: `base`, `overtime`, `bonus`, `commission`, `other` * Five new year-to-date fields: * `hours_ytd` * `deductions_ytd` * `taxes_ytd` * `deduction_list.amount_ytd` * `tax_list.amount_ytd` Additionally, `card_name` is now an optional parameter when [encrypting DDS Configs](https://argyle.com/docs/legacy/api-reference/dds-configurations#encrypt). # Link 4.4 Source: https://docs.argyle.com/changelog/2022-08-04 Intro screen customizations and end of Link 3.0 support. August 4, 2022 Link ![Link update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/link.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=b6ea923ffd5a9eaa46c5b7425326d751) The Argyle team has released these updates to Link: * You can now further customize your users’ Link experience by enabling or disabling the **Intro screen** through Link Customizer. * Returning users whose login sessions have expired can now [reconnect their payroll accounts](https://argyle.com/docs/workflows/reconnecting-accounts) with a single button click. * Link 3 will reach the end of its active support period on **September 1, 2022**. After this date, Argyle will no longer provide updates or releases for Link 3. Previously published releases will continue to be available. Link SDK upgrades are now available: * [iOS 4.4](https://argyle.com/docs/link/upgrade#ios) * [Android 4.4](https://argyle.com/docs/link/upgrade#android) * [React Native 4.4](https://argyle.com/docs/link/upgrade#react-native) * Web integrations will automatically update to include these latest features. # API enhancements Source: https://docs.argyle.com/changelog/2022-08-09 New payout field for net pay distributions. August 9, 2022 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) Argyle has added the `destinations` array of objects to the [payouts endpoint](https://argyle.com/docs/legacy/api-reference/payouts). * These `destinations` objects detail how the user’s net pay is distributed. # API enhancements Source: https://docs.argyle.com/changelog/2022-08-11 Unit for deposit switches to cards. August 11, 2022 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) Argyle has integrated with [Unit](https://www.unit.co/) to enhance direct deposit switches to instant payout cards. * Argyle retrieves the card data and handles sensitive information, making PCI DSS compliance no longer required when integrated to Unit. See our [Unit Pay Connector](https://argyle.com/docs/legacy/guides/getting-started/sample-apps/unit-pay-connector) sample app and guide for more information. # Coverage enhancements Source: https://docs.argyle.com/changelog/2022-08-15 Additional integrations have been added to Argyle's coverage. August 15, 2022 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) * Last week Argyle launched a new integration to **Homebase**. * The **Roadie** and **Shiftsmart** integrations now support deposit switches to cards. # API enhancements Source: https://docs.argyle.com/changelog/2022-08-16 Error testing in Sandbox. August 16, 2022 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) You can now [trigger errors in Sandbox mode](https://argyle.com/docs/overview/sandbox-testing#simulate-errors-in-console) directly in Console or via the API. * Use this testing feature to improve error handling in your implementation. A new `bank_name` field has been added to the `bank_account` object returned by the [pay allocations endpoint](https://argyle.com/docs/legacy/api-reference/pay-allocations). # Link 4.5 Source: https://docs.argyle.com/changelog/2022-08-24 Login screen redesign. August 24, 2022 Link ![Link update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/link.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=b6ea923ffd5a9eaa46c5b7425326d751) The Argyle team has released these updates to Link: * The **Login screen** design has been refreshed to make the user disclosure text more visible to your users. Link SDK upgrades are now available: * [iOS 4.5](https://argyle.com/docs/link/upgrade#ios) * [Android 4.5](https://argyle.com/docs/link/upgrade#android) * [React Native 4.5](https://argyle.com/docs/link/upgrade#react-native) * Web integrations will automatically update to include these latest features. # Coverage enhancements Source: https://docs.argyle.com/changelog/2022-08-29 Additional integrations have been added to Argyle's coverage. August 29, 2022 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) * Last week Argyle launched a new integration to **Infor CloudSuite HCM**, which powers a number of employers including **Georgia-Pacific**. * **Waitr** has been renamed to **ASAP (formerly Waitr)** after its recent re-branding. * **Handy** will now re-direct to **Angi (formerly Handy)** after its recent acquisition. # API enhancements Source: https://docs.argyle.com/changelog/2022-09-01 New activities data fields for accepting and cancelling. September 1, 2022 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) New `accept_at` and `cancel_at` fields have been added to the `all_timestamps` and `all_datetimes` objects returned by the [activities endpoint](https://argyle.com/docs/legacy/api-reference/activities). # Console enhancements Source: https://docs.argyle.com/changelog/2022-09-02 Sign up to Console with your Google account! September 2, 2022 Console ![Console update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/console.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=8902f7b196ea043075ebcbb91c725787) Major new Console upgrades: * You’re now able to sign up or log in to Console with a Google account. * A more informative **Get Started** page will get you up and running with Argyle in no time. * We’ve introduced robust [role-based permissions](https://argyle.com/docs/console/management/members) to enable you to control access to sensitive income and employment data, as well as other Console functionality like API keys, billing information, and dashboards. * In Link Emulator, you're now able to trigger errors when connecting sample accounts, enabling you to more easily test and handle error states that users can experience when connecting payroll accounts. * In Link Emulator, you’re now able to select from a menu of direct deposit update scenarios when connecting sample accounts, enabling you to more easily test Argyle Link's direct deposit update flow. * The way Payouts are displayed in Console has been re-designed, incorporating fields available with the release of [Digital Paystubs](https://argyle.com/blog/new-release-digital-paystubs-for-income-verification/) into a cleaner new layout and enabling you to download the paystub PDF corresponding to each payout. * The way Documents are displayed in Console has been re-designed, incorporating filtering by document type into a compact new table view. * You can now download a [Verification of Income & Employment (VOIE) report](https://argyle.com/docs/overview/data-structure/reports#voie--verification-of-income--employment) directly from a user’s Console profile, generated using the latest data from the user’s connected payroll accounts. * You can now submit coverage requests in Console’s Coverage tab. # Link updates Source: https://docs.argyle.com/changelog/2022-09-09 Shorter expiration time for user tokens. September 9, 2022 Link ![Link update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/link.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=b6ea923ffd5a9eaa46c5b7425326d751) User tokens underpin the returning user experience in Argyle Link, allowing re-authentication without submission of credentials. * On **September 29, 2022** Argyle will reduce the expiry time of user tokens. For returning users, their `userId` should be used to [generate a new user token](https://argyle.com/docs/api-reference/user-tokens#create) every time Argyle Link is initialized. This will not impact implementations already following this pattern. # Link 4.6 Source: https://docs.argyle.com/changelog/2022-09-12 Images files are now supported by document upload. September 12, 2022 Link ![Link update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/link.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=b6ea923ffd5a9eaa46c5b7425326d751) The Argyle team has released these updates to Link: * Users can now upload image files in addition to PDF files through [Document upload](https://argyle.com/docs/workflows/document-processing). * [Link errors](https://argyle.com/docs/link/reference/error-codes) have been extended to include `card_issuer_unavailable` to aid in troubleshooting updates to direct deposit switching. Link SDK upgrades are now available: * [iOS 4.6](https://argyle.com/docs/link/upgrade#ios) * [Android 4.6](https://argyle.com/docs/link/upgrade#android) * [React Native 4.6](https://argyle.com/docs/link/upgrade#react-native) * Web integrations will automatically update to include these latest features. # API enhancements Source: https://docs.argyle.com/changelog/2022-09-15 retired added as new status property for employments. September 15, 2022 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) The [employments endpoint](https://argyle.com/docs/legacy/api-reference/employments#object-status) now returns `retired` as a new possible value for the `status` property. # Coverage enhancements Source: https://docs.argyle.com/changelog/2022-09-19 Additional integrations have been added to Argyle's coverage. September 19, 2022 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) Last week Argyle launched a new integration to **SumTotal Systems**, which powers a number of employers including **Tops Friendly Markets**. * The **SumTotal Systems** integration also supports deposit switching. # API enhancements Source: https://docs.argyle.com/changelog/2022-09-20 New Income Totals endpoint. September 20, 2022 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) Argyle has introduced the new [income totals endpoint](https://argyle.com/docs/legacy/api-reference/income-totals), a major upgrade to how you access annual pay data. * Understanding users’ total annual income can be fundamental, but this information is not always available when viewing individual paystubs. Through the income totals endpoint, Argyle looks across all paystubs to provide standardized, aggregated yearly income values. # Coverage enhancements Source: https://docs.argyle.com/changelog/2022-09-26 Additional integrations have been added to Argyle's coverage. September 26, 2022 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) Last week Argyle launched new integrations to **Oracle HRMS** and **Skipcart**. * The **Oracle HRMS** integration powers a number of employers including **randstad**. * Both integrations support deposit switching. # API enhancements Source: https://docs.argyle.com/changelog/2022-09-27 New data fields for employee breaks added. September 27, 2022 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) Argyle has introduced a new `breaks` array of objects within `all_timestamps` for the [activities endpoint](https://argyle.com/docs/legacy/api-reference/activities). * Breaks taken during a work shift are represented as objects within breaks. # Console enhancements Source: https://docs.argyle.com/changelog/2022-09-30 UI Toolkit in Figma for Link screens is now available. September 30, 2022 Console ![Console update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/console.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=8902f7b196ea043075ebcbb91c725787) Major new Console upgrades: * If you're new to Argyle, we've added a new step-by-step welcome experience in Console to help you quickly get up to speed on the basics. * If you're embedding Argyle Link into your application or website, our new [Figma UI Toolkit](https://www.figma.com/design/i5gVMi4YmZD2YblzvhvZRl/Argyle-Link-%E2%80%93-UI-toolkit?node-id=2605-12927\&t=6zIDYkV6qrHD9h4P-0) lets you quickly start exploring and designing your flow. * If you use Console to send [URL invites](https://argyle.com/docs/console/flows/email-sms-templates#sending-invites) to users to connect payroll accounts: * The Link customization selected when sending an invite is now saved as part of the invite template, allowing you to set it and forget it, rather than needing to set the correct customization each time you send an invite. * The "reply-to" field now accepts multiple email addresses, allowing you to forward replies to multiple inboxes (e.g., a shared inbox along with the inbox of the sender) * In the final step of sending email/SMS invites, Console now provides clearer and more detailed information on whether the invites were successfully sent. * The confirmation email you receive when an invited user connects their accounts now includes a link letting you immediately view the connected account in Console. * Argyle's [Verification of Income and Employment (VOIE) PDF report](https://argyle.com/docs/overview/data-structure/reports#voie--verification-of-income--employment) has gotten a number of upgrades: * The latest version of the VOIE report provides a more detailed view of a user's year-to-date and annual income, powered by the new [Income Totals endpoint](https://argyle.com/docs/legacy/api-reference/income-totals). * To improve readability, we've refreshed the VOIE report layout. * You can now download VOIE reports directly in Console by visiting a connected user's profile. As always, you can also retrieve them using the Reports API endpoint. * [Console's Coverage page](https://console.argyle.com/coverage) has been upgraded to display income sources exactly as they appear in Link (including the same groupings and tooltips), to ensure you're able to explore Argyle's Coverage in a way that reflects what end-users are able to find in Link when connecting their payroll accounts. # API enhancements Source: https://docs.argyle.com/changelog/2022-10-06 New users.fully_synced webhook. October 6, 2022 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) Argyle has [introduced](https://argyle.com/docs/api-reference/users-webhooks#fully-synced) a new `users.fully_synced` webhook. * This webhook is sent when data retrieval has completed for all accounts connected by a user. # Coverage enhancements Source: https://docs.argyle.com/changelog/2022-10-17 Additional integrations have been added to Argyle's coverage. October 17, 2022 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) Last week Argyle launched new integrations to **Instawork** and **ASDA**. # API enhancements Source: https://docs.argyle.com/changelog/2022-10-28 New documents endpoint filters. October 28, 2022 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) The following query parameters have been added to the [documents endpoint](https://argyle.com/docs/legacy/api-reference/documents): * `document_type` — filter by document type * `from_available_date` — filter for documents on or after this timestamp * `to_available_date` — filter for documents on or before this timestamp # Console enhancements Source: https://docs.argyle.com/changelog/2022-10-31 Sign up to Console with your Microsoft account! October 31, 2022 Console ![Console update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/console.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=8902f7b196ea043075ebcbb91c725787) Major new Console upgrades: * If you're new to Argyle, use Console's new **Preview Mode** to learn how Argyle works by securely connecting your own payroll account and viewing the retrieved income and employment data. Your data is only visible to you (never colleagues with Console accounts) and is removed when you exit the preview experience. * You can now sign up or sign in or sign in to Console using a **Microsoft account**, such as Outlook or Azure Active Directory. * With this addition, Argyle now supports Google, Microsoft, Okta, and email + password as methods for you and your team to access Console quickly and securely. * The new [Integrations](https://console.argyle.com/integrations) page in Console allows you to connect third-party applications, enhancing the Argyle experience. * Our first integration enables you to receive third-party OCR data via the Argyle API for income documents that have been manually uploaded by your users in Link. * The recently introduced Income Totals endpoint is displayed in Console as a table when viewing a connected user's profile. This provides a conveniently formatted breakdown of a user's total annual income - YTD and for all available years in the past - based on analyzing all available paystub data for the user. * If you use Console to send URLs inviting user to connect payroll accounts, you'll now receive a notification email if an invited user has chosen to manually upload income documents, similar to the confirmation emails you currently receive when invited users connect their payroll accounts. # Link 4.7 Source: https://docs.argyle.com/changelog/2022-11-22 Deposit switch enhancements. November 22, 2022 Link ![Link update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/link.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=b6ea923ffd5a9eaa46c5b7425326d751) The Argyle team has released these updates to Link: * Direct deposit switching flows that users experience in Argyle Link have been enhanced and streamlined to optimize user conversion. Visit our updated [Deposit Switching Guide](https://argyle.com/docs/workflows/deposit-switching) to learn more, or check out our recent [Blog Post](https://argyle.com/blog/new-release-optimized-direct-deposit-switching-with-full-lifecycle-management/) to see the latest changes in action. Link SDK upgrades are now available: * [iOS 4.7](https://argyle.com/docs/link/upgrade#ios) * [Android 4.7](https://argyle.com/docs/link/upgrade#android) * [React Native 4.7](https://argyle.com/docs/link/upgrade#react-native) * Web integrations will automatically update to include these latest features. # Coverage enhancements Source: https://docs.argyle.com/changelog/2022-11-28 Instawork integration now supports deposit switching. November 28, 2022 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) Argyle's **Instawork** integration now supports direct deposit switching. # Console enhancements Source: https://docs.argyle.com/changelog/2022-11-30 Filter conversion by Link Flow in Console's Dashboard. November 30, 2022 Console ![Console update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/console.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=8902f7b196ea043075ebcbb91c725787) Major new Console upgrades: * Filter Console's [Conversion Dashboard](https://console.argyle.com/dashboard) by Link Flow to experiment with how different configurations of Link impact conversion. * If you're new to Argyle, explore pre-loaded example customizations in Link Emulator to learn about how Link can be branded and tailored to your use case. * If you're on Argyle's free Sandbox-only plan, explore our Console's [Coverage](https://console.argyle.com/coverage) page for detailed information about supported payroll platforms and available data fields. Previously this tool was only available to customers on a paid Argyle plan. * When creating a Link Customization in Customizer, you can now choose whether to include Government benefits as a category of income sources. If you use Console to send URLs inviting users to connect payroll accounts: * You can now view and filter your [Connections](https://console.argyle.com/connections) by sender, providing visibility into invite usage across team-members and enabling individual team-members to focus on sent invites that are relevant to them. * You can now copy the URL that was sent as part of an invite right from the Connections table. * You'll now get notified via email when an invited user uploads income documents rather than connecting a payroll account (in addition to the existing email notification for users connecting a payroll account). If you use Console to retrieve [Verification of Income and Employment PDF reports](https://argyle.com/docs/overview/data-structure/reports#voie--verification-of-income--employment): * These reports now include 3 years of income history rather than 2 (when available from the connected payroll account). # API enhancements Source: https://docs.argyle.com/changelog/2022-12-06 Reports can now be generated via Argyle's API. December 6, 2022 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) You can now generate Argyle verification reports via the new [reports endpoint](https://argyle.com/docs/api-reference/reports). # Coverage enhancements Source: https://docs.argyle.com/changelog/2022-12-12 Additional integrations have been added to Argyle's coverage. December 12, 2022 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) Last week Argyle launched a new integration to **SurePayroll**. # API enhancements Source: https://docs.argyle.com/changelog/2022-12-15 New currency field added to pay allocations endpoint. December 15, 2022 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) A new `currency` field is now returned by the [pay allocations endpoint](https://argyle.com/docs/legacy/api-reference/pay-allocations#object-currency). # API enhancements Source: https://docs.argyle.com/changelog/2022-12-16 Changes to user invites object. December 16, 2022 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) Argyle has made the following changes to the [user invite object](https://argyle.com/docs/legacy/api-reference/user-invites#user-invite-object): * Possible status attributes are now: `sent`, `initiated`, `attempted`, `completed`, `revoked` * The `accepted_invitation` field has been removed. * A `url` field has been added, containing the invite URL in the invitation. # API enhancements Source: https://docs.argyle.com/changelog/2022-12-19 1099 documents now supported by Ocrolus OCR. December 19, 2022 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) 1099 documents submitted through Link's [document upload](https://argyle.com/docs/workflows/document-processing) flow can now be processed by [Ocrolus OCR](https://argyle.com/docs/integrations/ocr/ocrolus). * *Contact our customer success team for more information on OCR for uploaded documents.* # Coverage enhancements Source: https://docs.argyle.com/changelog/2022-12-20 Last week Argyle launched a new integration to PepsiCo. December 20, 2022 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) Last week Argyle launched a new integration to **PepsiCo**. # Console enhancements Source: https://docs.argyle.com/changelog/2022-12-31 How invites are sent has been redesigned. December 31, 2022 Console ![Console enhancements](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2022-12-31/dec2022.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=41db56afbf70645cf1c46df0b198138d) We've redesigned the way you [send invites](https://argyle.com/docs/console/flows/email-sms-templates#sending-invites) from Console, making it faster and simpler to send unique URLs allowing recipients to immediately connect payroll accounts. You can now more easily: * Send a URL invite via email, SMS, or both. * Preview the recipient's account connection experience. * Add and configure advanced Argyle features such as [deposit switching](https://argyle.com/docs/workflows/deposit-switching). * Customize and save your default invite text and Link Customization in [Settings](https://console.argyle.com/settings/other-settings). * Hovering over invite statuses within the [Connections](https://console.argyle.com/connections) page now shows the date the user connected, removed, or attempted to connect an account. * Possible API [invite statuses](https://argyle.com/docs/api-reference/invites#object-status) were expanded from `sent`, `completed`, and `revoked` to also include `initiated` and `attempted`. Additionally, you can now preview and crop your logo in [Link Flows](https://console.argyle.com/flows) to demo how users will experience your branding in Argyle Link. # Coverage enhancements Source: https://docs.argyle.com/changelog/2023-01-10 Digital paystubs are now available. January 10, 2023 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) [Digital paystubs](https://argyle.com/blog/new-release-digital-paystubs-for-income-verification/) have now been rolled out across Argyle's coverage universe. Access granular, line-by-line paystub data through the [payouts endpoint](https://argyle.com/docs/legacy/api-reference/payouts), as well as yearly income totals through the [income totals endpoint](https://argyle.com/docs/legacy/api-reference/income-totals). As always, this information can be viewed in Console or retrieved via the API. Additionally, last week Argyle launched a new integration to **In-Home Supportive Services**. # API enhancements Source: https://docs.argyle.com/changelog/2023-01-23 Two additional IP addresses for webhooks. January 23, 2023 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) [Webhook](https://argyle.com/docs/api-guide/webhooks) deliveries will now originate from two additional IP addresses. Add the following IP addresses to any whitelists in use to ensure uninterrupted webhook delivery: * `34.27.251.226` — new addition * `34.122.50.253` * `35.188.163.115` * `35.226.53.251` — new addition # Console enhancements Source: https://docs.argyle.com/changelog/2023-01-31 Redesigned user profiles in Console. January 31, 2023 Console ![Console enhancements](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2023-01-31/jan2023.jpeg?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=873865f166ace5e305fdb0e175c2e492) We've redesigned the way you view a connected user's information in Console via the [Connections](https://console.argyle.com/connections) page. * You can now quickly see an overview of the accounts a user has connected, switch between the data sets available, and generate reports. Additionally: * You can now submit and view your support requests through Console's new Ticket Center, which can be accessed through the help menu. If you are generating reports through Console: * You can now use Console to generate [verification of employment (VOE) reports](https://argyle.com/docs/overview/data-structure/reports#voe--verification-of-employment) in addition to verification of income and employment (VOIE) reports. VOE reports include employment details but omit income information. * All reports generated now include timestamps for when the report was generated, and when the data was most recently refreshed. * You can now generate reports for a user as long as at least one of their accounts was successfully connected in the past and the data was fully synced. If you use Console to send URLs inviting users to connect payroll accounts: * The URLs included in invites sent to users no longer expire. * You can now [reconnect returning users](https://argyle.com/docs/workflows/reconnecting-accounts) using this same invite URL, or resend the invite using the API. This lets returning users re-verify or revoke existing account connections, or connect additional accounts. Lastly: * Currency values are now displayed when viewing pay allocations in Console. * Hovering over an account in the Connections page now displays information on the account's connection status and when the account's data was last synced. # Coverage enhancements Source: https://docs.argyle.com/changelog/2023-02-01 Symantec VIP multi-factor authentication now supported. February 1, 2023 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) Symantec VIP multi-factor authentication (MFA) is now supported, which will increase the scope of Argyle's coverage. Using this enhancement, our **Workday** integration is being expanded and now supports the following employers: * **SSM Health** * **Bon Secours Mercy Health** # Coverage enhancements Source: https://docs.argyle.com/changelog/2023-02-21 More multi-factor authentication (MFA) and single sign-on (SSO) methods supported. February 21, 2023 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) Support for new multi-factor authentication (MFA) and single sign-on (SSO) methods continues to increase the scope of Argyle's coverage. Our Workday integration has been expanded again to include the following employers: * **Elevance Health**, by using PingID SSO * **Expedia Group**, by using OKTA IDX SSO * **Wawa**, by using PingID SSO and Symantec VIP MFA # Coverage enhancements Source: https://docs.argyle.com/changelog/2023-02-22 Last week Argyle launched a new integration to State of New York. February 22, 2023 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) Last week Argyle launched a new integration to **State of New York**. # API enhancements Source: https://docs.argyle.com/changelog/2023-03-06 Webhook performance enhancements. March 6, 2023 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) We've made new enhancements to our webhook engine. Further optimizations have increased the accuracy of our `updated` webhooks, which are delivered when a resource's underlying data changes. * The improved performance has resulted in a significant reduction in `updated` webhook volume across all data categories. # Coverage enhancements Source: https://docs.argyle.com/changelog/2023-03-12 Last week Argyle launched a new integration to Care.com. March 12, 2023 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) Last week Argyle launched a new integration to **Care.com**, a gig platform for caregivers. # Console 3.0 Source: https://docs.argyle.com/changelog/2023-04-04 Improved navigation, simpler terminology, and easier-to-access features. April 4, 2023 Console ![Console update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/console.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=8902f7b196ea043075ebcbb91c725787) Since Argyle Console’s last design refresh, a lot has been added to the tool’s capabilities, from webhook alerts and conversion charts to integration status updates. With that in mind, we’ve made some small updates that we expect will have a big impact on your Console experience. Let’s dive into what you can expect from the new Console experience: * **Reoriented navigation**: You’ll notice the Console navigation bar has shifted from a vertical column (along the left-hand side of the screen) to a horizontal menu that sits along the top. This not only gives you more space to explore and play with Console’s many features and functions, it also makes it clearer how different elements connect and work with one another. It also gives our team some breathing room to add new capabilities as we expand our platform. * **Simpler terminology**: Previously, the tools that allowed you to preview and adjust your consumer-facing UI were referred to as Link Emulator and Link Customizer, respectively. Now, we’ve merged and repackaged them into one simplified tool called Link Flows. That means you can make edits and see your changes go live in the same space, for a more intuitive and immediate experience. * **Accessible features**: Our redesigned Console offers all the same features and functions you’ve always used—including the ability to review your coverage, check the status of your connections, set up real-time webhook alerts, and generate custom VOI and VOE reports and data sets—just in a streamlined and more self-evident package. To explore the updates we've made, get started in [Console's Dashboard](https://console.argyle.com/dashboard). # Link 5.0 Source: https://docs.argyle.com/changelog/2023-04-05 The most intuitive payroll connection experience ever. April 5, 2023 Link ![Link update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/link.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=b6ea923ffd5a9eaa46c5b7425326d751) Link 5.0 delivers a more intuitive, straightforward experience, so you can upgrade your onboarding flows, improve your UX, and boost conversions without having to provide any additional customer education. Visit our [Upgrade Guide](https://argyle.com/docs/upgrade-guide) for an in-depth look at what's changed and how to upgrade your Link SDK and web integrations. # API v2 Source: https://docs.argyle.com/changelog/2023-04-06 An optimized, more secure API that performs. April 6, 2023 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) API v2 enables us to better optimize, add new features, and enhance our data security going forward. Expect faster response times and an all-around superior experience that unlocks the full potential of Link 5.0. # API enhancements Source: https://docs.argyle.com/changelog/2023-04-14 Retrieve Argyle verification reports in JSON. April 14, 2023 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) The content of PDF reports can now be retrieved in JSON format. * **Verification of Income and Employment (VOIE) report JSON** includes employment status, last three years of income for all connected payroll accounts, and combined income totals per year. * **Verification of Employment (VOE) report JSON** includes employment status and employer details for all connected payroll accounts. Visit [Reports](https://argyle.com/docs/api-reference/reports#retrieve-json) in our API Reference to learn more. # Link updates Source: https://docs.argyle.com/changelog/2023-04-15 Flutter SDK is now available. April 15, 2023 Link ![Link update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/link.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=b6ea923ffd5a9eaa46c5b7425326d751) Flutter is now a supported SDK for mobile implementations of Link. * To install the Flutter SDK and for more information, visit our [Flutter documentation](https://argyle.com/docs/link/initialization#flutter). # API enhancements Source: https://docs.argyle.com/changelog/2023-04-26 Retrieve data refresh frequency. April 26, 2023 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) How often payroll connections are re-scanned for new data is now returned in the `refresh_frequency` field when [retrieving an Item by its ID](https://argyle.com/docs/api-reference/items#retrieve) via the API. # Console enhancements Source: https://docs.argyle.com/changelog/2023-05-01 Connections page improvements. May 1, 2023 Console ![Console update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/console.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=8902f7b196ea043075ebcbb91c725787) New enhancements have been added to Console: * Console's [Coverage](https://console.argyle.com/coverage) page is now searchable by the Item ID that corresponds to each employer and payroll provider. * After selecting a Flow within the [Link Flows](https://console.argyle.com/flows) page in Console, the selection will persist if you navigate away and return to the page. * If you use Console to send URLs inviting users to connect payroll accounts, the default text for email invites has been updated with additional context on the connection process to improve conversion. * Users that have only submitted a response form in Link after being unable to find their employer or payroll provider are now listed in the "Attempted Connections" section of Console's [Connections](https://console.argyle.com/connections) page rather than the "Connected" section. If these users opened Link through a URL invite, their status in the "Invited" section of Console's Connections page will now be "Attempted" instead of "Completed" as well. # API enhancements Source: https://docs.argyle.com/changelog/2023-05-08 Items webhooks are now available. May 8, 2023 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) [Items webhooks](https://argyle.com/docs/api-reference/items-webhooks) are now available. * Subscribe to any list of up to 30 employers or payroll platforms in Link. * Receive real-time updates on changes to connection health, known data limitations, and platform maintenance. # API enhancements Source: https://docs.argyle.com/changelog/2023-05-09 New shifts endpoint introduced. May 9, 2023 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) A new [shifts endpoint](https://argyle.com/docs/api-reference/shifts) is now available via Argyle's API. * Retrieve information on individual work shifts, including when they started and ended, any breaks taken, and total hours worked. * Stay notified of new shifts data via [shifts webhooks](https://argyle.com/docs/api-reference/shifts-webhooks). # API enhancements Source: https://docs.argyle.com/changelog/2023-05-10 Earliest and most recent payout dates added to income totals endpoint. May 10, 2023 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) Two additional fields have been added to the API v1 [income totals endpoint](https://argyle.com/docs/legacy/api-reference/income-totals): * `period_start_date` — The `start_date` of the earliest payout used for the income totals. * `period_end_date` — The `end_date` of the most recent payout used for the income totals. # Coverage enhancements Source: https://docs.argyle.com/changelog/2023-05-11 Last week Argyle launched a new integration to PrimePay. May 11, 2023 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) **PrimePay**, a payroll provider serving the food service, healthcare, manufacturing, and franchise industries, has been added to Argyle's coverage. * **PrimePay** can be accessed via the Item ID `item_000109308` # API enhancements Source: https://docs.argyle.com/changelog/2023-05-16 New mapping_status Item fields introduced. May 16, 2023 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) When [retrieving an Item by its ID](https://argyle.com/docs/api-reference/items#retrieve), a new `mapping_status` field is now returned with three possible values: * `verified` — The payroll system associated with the Item is known, and the Item has previously experienced a successful connection. * `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. Changes to an Item's `mapping_status` value will result in a new Item notification and cause the [items.updated webhook](https://argyle.com/docs/api-reference/items-webhooks#updated) to be sent. # Link 5.1 Source: https://docs.argyle.com/changelog/2023-05-17 Customizable home screen tabs. May 17, 2023 Link ![Link update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/link.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=b6ea923ffd5a9eaa46c5b7425326d751) Link 5.1 is now available, and includes the following updates: * The ability to fully customize which tabs (Popular, Employer, Gig, Benefits, Payroll) appear on the home screen of Link's [search experience](https://argyle.com/docs/workflows/account-connections#search). * Recommendations for the Popular tab can now be chosen manually. * Additional selections are available when the user is searching for a payroll provider. * Users can be given the option to return to the search screen even if they are [directly connected](https://argyle.com/docs/workflows/account-connections#direct-login) to a specific employer or payroll provider. Visit the following pages in our documentation to upgrade your respective Link SDK: * [iOS 5.1](https://argyle.com/docs/link/upgrade#ios) * [Android 5.1](https://argyle.com/docs/link/upgrade#android) * [React Native 5.1](https://argyle.com/docs/link/upgrade#react-native) * [Flutter 5.1](https://argyle.com/docs/link/upgrade#flutter) Web instances of Link 5.0 will automatically be upgraded to Link 5.1 and receive these latest features. If you are upgrading from Link 4.7 or earlier, visit our [Link 5.0 Upgrade Guide](https://argyle.com/docs/upgrade-guide). # Ocrolus added as new subprocessor. Source: https://docs.argyle.com/changelog/2023-05-25 Ocrolus added as new subprocessor. May 25, 2023 Platform ![Platform update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/breaking.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=2c5e1520e37851960967e9d07b5275b8) Argyle has engaged Ocrolus as a subprocessor for optical character recognition services related to payroll and tax documents. Please visit our [Subprocessors](https://www.argyle.com/legal/open-payroll/subprocessors) page for more information. # API enhancements Source: https://docs.argyle.com/changelog/2023-06-02 New external_id user field introduced. June 2, 2023 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) You can now attach your own identifier to users via the new `external_id` field when [creating](https://argyle.com/docs/api-reference/users#create) or [updating](https://argyle.com/docs/api-reference/users#update) users via the API. * The `external_id` field supports up to 100 characters and can be used as a filter when [listing users](https://argyle.com/docs/api-reference/users#list). * Multiple users can have the same `external_id` value. Visit our [Users API Documentation](https://argyle.com/docs/api-reference/users) for more information. # Console enhancements Source: https://docs.argyle.com/changelog/2023-06-06 Payroll connection experience customizations. June 6, 2023 Console Console added new features this month that give you more control over the payroll connection experience and help you find the information you need more quickly and intuitively. ![image](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2023-06-06/may2023.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=b73523cf2526ec0d2bb57dc99add09cc) * Console's [Coverage](https://console.argyle.com/coverage) page has been redesigned and now shows more information on what data fields are supported, how often data is refreshed, and what [Link 5](https://argyle.com/blog/announcing-argyle-2/) Item ID corresponds to each employer and payroll provider. * [Link Flows](https://console.argyle.com/flows) in Console has been upgraded to support new ways to customize the Link home screen that were introduced with Link 5.1, including choosing which tabs are shown (Popular, Employer, Gig, Benefits, Payroll) and the option to manually select which payroll platforms are suggested to users on the Popular tab. * Sending URL invites from the [Connections](https://console.argyle.com/connections) page received more updates: * The default method for invites is now "Email and SMS" — the most popular option for sending invites with the highest connection success rate of any invite method. * SMS invites sent to users now use a shorter and more trustworthy URL that begins with `verify.argyle.com/`. # API enhancements Source: https://docs.argyle.com/changelog/2023-06-12 ongoing_refresh enhancements June 12, 2023 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) New releases related to ongoing refresh are now available: * An `ongoing_refresh` object is now returned in the [accounts object](https://argyle.com/docs/api-reference/accounts). * The `ongoing_refresh` object contains a status field, indicating whether ongoing refresh is currently enabled for the account. * Accounts will experience [data updates](https://argyle.com/docs/overview/data-updates) when the ongoing refresh status is enabled. * Accounts can now be filtered by their ongoing refresh status using `ongoing_refresh_status` as an optional query parameter when [listing accounts](https://argyle.com/docs/api-reference/accounts#list). * A new `/v2/accounts/{id}/disable-ongoing-refresh` [API endpoint](https://argyle.com/docs/api-reference/accounts#disable) has been introduced, providing a way to manually disable ongoing refresh for individual accounts. * *To access this feature, reach out to our team for assistance.* * An `ongoing_refresh_disabled` [account connection error](https://argyle.com/docs/api-reference/account-connection-errors#ongoingrefreshdisabled) has been added. # Coverage enhancements Source: https://docs.argyle.com/changelog/2023-06-14 Last week Argyle launched a new integration to Curri. June 14, 2023 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) **Curri**, a gig platform for construction delivery drivers, has been added to Argyle's coverage. * **Curri** can be accessed via the Item ID `item_000122055` # API enhancements Source: https://docs.argyle.com/changelog/2023-06-15 New filters for Items are now supported. June 15, 2023 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) Items can now be filtered by their health status and `mapping_status` values when [listing Items](https://argyle.com/docs/api-reference/items#list). Multiple `status` or `mapping_status` values are also supported. * For example, filtering `status` by both `healthy` and `issues` will return a list of all Items that currently support new payroll connections. # Coverage enhancements Source: https://docs.argyle.com/changelog/2023-06-26 Last week Argyle launched a new integration to Heartland. June 26, 2023 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) **Heartland**, a leading human capital management (HCM) provider for small and medium-sized businesses within the retail and hospitality industries, has been added to Argyle's coverage. * **Heartland** can be accessed via the Item ID `item_000122842` # Console enhancements Source: https://docs.argyle.com/changelog/2023-07-01 Console's Connections page has been redesigned. July 1, 2023 Console Console's Connections page was redesigned from the ground up, giving you more information at a glance with advanced filters to find the information you need faster. 1. The previous three table views — Connected, Invited, and Attempted Connections — were combined into one view. ![image](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2023-07-01/july2023_1.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=e96bbedb00a8a70252d6cd5ed430a02b) 2. If you are sending URL invites through Console, sent invites can be filtered by their current status or the Console member who sent the invite. Additionally, all Connections can be filtered by income source. ![image](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2023-07-01/july2023_2.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=903da7448a625c618183478800314289) Other Console changes introduced this month: * [External ID's](https://argyle.com/docs/overview/data-structure/users#external-identifiers) can be attached to individual users and used when searching the Connections page. Multiple users can have the same external ID. * [Shifts data](https://argyle.com/docs/api-reference/shifts) and [shifts webhooks](https://argyle.com/docs/api-reference/shifts-webhooks) are now available in Console. * The content of Argyle PDF Reports can be viewed in JSON within Console. * Additional metrics were added to Console's Dashboard. * Invites sent through Console in sandbox mode for testing purposes can now be sent to any email. * Searching the Connections page by user ID or account ID has been improved to support copy-pasting of ID's. # Link 5.2 Source: https://docs.argyle.com/changelog/2023-07-12 Payroll connection experience improvements. July 12, 2023 Link Link 5.2 is now available, with updates focused on improving the payroll connection experience to maximize conversion: 1. Employers that utilize multiple payroll platforms for their employees have been consolidated into one search Item. 2. Users are prompted to confirm they are employees after selecting popular benefit and service providers in Link. ![Image](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2023-07-12/link_july2023_1.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=79451ca5fd93f08bd58444ee38ed74d2) 3. Separate username and password reset buttons have been introduced. 4. A new [deposit switch flow](https://argyle.com/docs/workflows/deposit-switching#entire-paycheck) has been added, allowing users to choose between dollar or percent amounts when making edits to entire paycheck allocations. ![Image](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2023-07-12/link_july2023_2.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=0c8241831b1fc25af1004c4b5b6412c3) Additional changes: * **Link keys have been deprecated** and are no longer a [required initialization parameter](https://argyle.com/docs/link/initialization#required-initialization-parameters) when embedding Link 5.2. * More information on Argyle payroll connectivity is available to users from within the login screen. Visit the following pages in our documentation to upgrade your respective Link SDK: * [iOS 5.2](https://argyle.com/docs/link/upgrade#ios) * [Android 5.2](https://argyle.com/docs/link/upgrade#android) * [React Native 5.2](https://argyle.com/docs/link/upgrade#react-native) * [Flutter 5.2](https://argyle.com/docs/link/upgrade#flutter) Web instances of Link 5.0 will automatically be upgraded to Link 5.2 and receive these latest features. If you are upgrading from Link 4.7 or earlier, visit our [Link 5.0 Upgrade Guide](https://argyle.com/docs/upgrade-guide). # Console enhancements Source: https://docs.argyle.com/changelog/2023-08-01 Invite experience improvements have arrived. August 1, 2023 Console This month Console focused on improving every step of the invited user experience. ![Image](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2023-08-01/console_july2023_1.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=fe3fcba82f0e024a128d3e4e0d706570) Invite emails and Argyle's landing page got a new look. Your brand is now front and center, helping to maximize conversion by increasing user trust. The new email and landing page can be enabled and configured by in the Invites section (\**update: now [Flows](https://console.argyle.com/flows) section*) of Console. ![Image](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2023-08-01/console_july2023_2.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=ce2f7a1aaccb77dd28e744fe49d2959d) Other Console changes introduced this month: * [Resending invites](https://argyle.com/docs/console/invites#reconnecting-existing-users) to **attempted** and **successfully** connected users is now possible within the [Connections](https://console.argyle.com/connections) page of Console. * Users can re-establish a payroll connection in one click (no login credentials needed) by returning to Link through original or re-sent invites. * Argyle PDF Reports have been redesigned, with additional metadata including [external ID's](https://argyle.com/docs/overview/data-structure/users#external-identifiers) now shown in a new **Report details** area. * Under the hood improvements have been made across Console, yielding faster page loading and a more responsive experience. # Console enhancements Source: https://docs.argyle.com/changelog/2023-09-08 Faster report generation times. September 8, 2023 Console ![Console update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/console.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=8902f7b196ea043075ebcbb91c725787) New enhancements have been added to Console: * [Generating PDF reports](https://argyle.com/docs/overview/data-structure/reports#generating-reports) is now \~30% faster. * The time of day a report was generated, and the time of day the report was last updated with new data, is now shown within **Report details**. * Console now remembers scroll location. You won't lose your spot when viewing all your Connections, visiting an individual User Profile, and returning to Connections. * Filters applied to [Connections](https://console.argyle.com/connections) are now more reliably retained across sessions. # Link 5.3 Source: https://docs.argyle.com/changelog/2023-09-09 Improved returning user experience. September 9, 2023 Link Link 5.3 is now available, and includes the following updates: * A new prompt guides returning users when action is required to re-establish a previous account connection. ![Image](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2023-09-09/link_5.3.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1105cc043ea4b69f2a702720b3bdc627) * (Web only) Argyle's customizable introduction screen can now be placed before [Direct Login](https://argyle.com/docs/workflows/account-connections#direct-login) flows. The introduction screen can be enabled when creating or editing [Flows](https://console.argyle.com/flows) in Console. * A new account connection error for unsupported languages has been added. Visit the following pages in our documentation to upgrade your respective Link SDK: * [iOS 5.3](https://argyle.com/docs/link/upgrade#ios) * [Android 5.3](https://argyle.com/docs/link/upgrade#android) * [React Native 5.3](https://argyle.com/docs/link/upgrade#react-native) * [Flutter 5.3](https://argyle.com/docs/link/upgrade#flutter) Web instances of Link 5.0 will automatically be upgraded to Link 5.3 and receive these latest features. If you are upgrading from Link 4.7 or earlier, visit our [Link 5.0 Upgrade Guide](https://argyle.com/docs/upgrade-guide). # API enhancements Source: https://docs.argyle.com/changelog/2023-09-18 Easier change tracking for supported data fields and deposit switch capabilities. September 18, 2023 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) The features object, previously available when retrieving an Item's details, is now returned by the Items endpoint and in the payload of [items.updated webhooks](https://argyle.com/docs/api-reference/items-webhooks#updated). These additions make it easier to track changes to an Item's supported data fields and deposit switch capabilities. # API breaking changes Source: https://docs.argyle.com/changelog/2023-09-27 Renamed Item fields September 27, 2023 API Breaking ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) On October 18, two API v2 fields will be renamed within the [Item object](https://argyle.com/docs/api-reference/items#object): * `features.field_coverage.paystubs.document_id` will be renamed to `features.field_coverage.paystubs.payroll_document` * `features.field_coverage.paystubs.gross_pay_list_totals.{base/overtime/commission/bonus/other}.rate_ytd_implied` will be renamed to `features.field_coverage.paystubs.gross_pay_list_totals.{base/overtime/commission/bonus/other}.rate_implied_ytd` These renamed fields are currently returned when: * [Retrieving an individual Item](https://argyle.com/docs/api-reference/items#retrieve) by calling `/v2/items/{id}` * Listing Item notifications by calling `/v2/item-notifications` * Receiving an [items.updated API v2 webhook](https://argyle.com/docs/api-reference/items-webhooks#updated) # Link 5.4 Source: https://docs.argyle.com/changelog/2023-10-18 More prominent Login help button and image previews. October 18, 2023 Link Link 5.4 is now available, and includes the following updates: * The "Login help" call-to-action button is more prominently displayed on the login screen. * Multi-factor authentication (MFA) screens now feature new troubleshooting error messages and design enhancements. ![Image](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2023-10-18/link_5.4.jpeg?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=35384ac112fd99441d7c17c481bc4952) * Image previews for photo-captured uploaded documents are now zoomed out to show the entire document. * (iOS and Android support added) Argyle's customizable introduction screen can be placed before [Direct Login flows](https://argyle.com/docs/workflows/account-connections#direct-login) when creating or editing [Flows](https://console.argyle.com/flows) in Console. * (Web only) Dependency removed that was previously required for automatic HEIC to JPG/PNG image file conversion. Visit the following pages in our documentation to upgrade your respective Link SDK: * [iOS 5.4](https://argyle.com/docs/link/upgrade#ios) * [Android 5.4](https://argyle.com/docs/link/upgrade#android) * [React Native 5.4](https://argyle.com/docs/link/upgrade#react-native) * [Flutter 5.4](https://argyle.com/docs/link/upgrade#flutter) Web instances of Link 5.0 will automatically be upgraded to Link 5.4 and receive these latest features. If you are upgrading from Link 4.7 or earlier, visit our [Link 5.0 Upgrade Guide](https://argyle.com/docs/upgrade-guide). # Integration enhancements Source: https://docs.argyle.com/changelog/2023-10-31 Argyle is now available within Encompass. October 31, 2023 Integrations ![Integrations update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/integrations.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1844d9bdf0a31d0b8c27962155e43a90) We’re thrilled to announce that we’re fully integrated with [Encompass® by ICE Mortgage Technology®](https://www.icemortgagetechnology.com/products/encompass), a leading loan origination system (LOS) for mortgage lenders. Through our formal partnership with ICE, we’ve made our [direct-source Income & Employment Verification solution](https://argyle.com/industries/mortgage/) available within the Encompass platform, so mortgage lenders don’t have to leave the Encompass software environment to leverage the benefits of the most trusted network for income and employment data. [Argyle’s integration with Encompass](https://docs.argyle.com/integrations/pos-los/encompass) gives lenders continuous access to real-time VOI and VOE reports and borrower documentation throughout the mortgage loan cycle. As a result, lenders gain significant production efficiencies at a much lower cost. ***Reach out to your Argyle or Encompass customer success manager to enable this Argyle integration today.*** # Thena added as new subprocessor. Source: https://docs.argyle.com/changelog/2023-11-03 Thena added as new subprocessor. November 3, 2023 Platform ![Platform update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/breaking.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=2c5e1520e37851960967e9d07b5275b8) Argyle has engaged **Thena** as a subprocessor in connection with responding to customer support requests via Slack. Please visit our [Subprocessors](https://www.argyle.com/legal/open-payroll/subprocessors) page for more information. # API enhancements Source: https://docs.argyle.com/changelog/2023-11-07 Gigs endpoint now returns additional data fields. November 7, 2023 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) We've updated our [gigs endpoint](https://argyle.com/docs/api-reference/gigs) with new data enhancements: * A new `task_details` object has been added, providing task-level details for multi-task gig assignments such as rideshares with multiple drop-offs or deliveries with several pickup locations. * A new `customer_price` field has been added, representing the amount a customer paid for an order excluding fees and tips. * More visibility around miscellaneous payments, reimbursements, and fees such as tolls and withholding taxes is now available through the `income.other` field. # API breaking changes Source: https://docs.argyle.com/changelog/2023-11-13 Weak cipher suite are being removed on December 13, 2023. November 13, 2023 API Breaking ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) On **December 13, 2023**, we will be removing the weak cipher suites listed below from our TLS configuration on all API endpoints to strengthen our information security. If your client or library relies on any of these ciphers and cannot be updated, please reach out to our customer support team. * `TLS_RSA_WITH_AES_128_CBC_SHA` * `TLS_RSA_WITH_AES_128_CBC_SHA256` * `TLS_RSA_WITH_AES_128_GCM_SHA256` * `TLS_RSA_WITH_AES_256_CBC_SHA` * `TLS_RSA_WITH_AES_256_CBC_SHA256` * `TLS_RSA_WITH_AES_256_GCM_SHA384` * `TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA` * `TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA` * `TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256` * `TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384` # Link updates Source: https://docs.argyle.com/changelog/2023-11-14 Username and password recovery with identifying information. November 14, 2023 Link The "Login help" call-to-action button now allows users who have forgotten or entered incorrect credentials to natively reset payroll account access by verifying their personal information. ![Image](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2023-11-14/link_update1.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=cf07c64c80e6560e0832876c7d66b552) This feature is currently available for a limited number of employers and payroll providers, with plans for future expansion. It has been automatically enabled for all Link 5.4 implementations. # Shareable URLs and multiple Invite Templates are now available. Source: https://docs.argyle.com/changelog/2023-11-15 Today we're releasing some game-changing new features to Console Flows. November 15, 2023 Console Today we're releasing some game-changing new features to [Console Flows](https://console.argyle.com/flows). ![Image](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2023-11-15/shareable_urls.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=936b7db67490bde211a559be859e3039) [Shareable URLs](https://argyle.com/docs/console/flows/shareable-urls) are standalone URLs that link to Argyle's payroll connection experience. * Create as many unique URLs as you need, each with their own customized landing page, Link connection experience, and success page. * Optional [external identifiers](https://argyle.com/docs/overview/data-structure/users#external-identifiers) let you tag users who enter through a specific URL, an easy way to match users to different campaigns, branches, or Console members. * Filtering users by the URL that connected them to Link has been added to the [Connections](https://console.argyle.com/connections) page in Console and the Conversion section of [Console's Dashboard](https://console.argyle.com/dashboard). ![Image](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2023-11-15/multiple_templates.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=ffedb5e51cdaf7ac36c6f4081e6a3bc9) [Email/SMS Templates](https://argyle.com/docs/console/flows/email-sms-templates) let you create **multiple invite templates** that can be applied to invites sent through Console. * Each template can be customized with its own email and/or text messaging, landing page, Link connection experience, and success page. * Filtering users by the invite template they experienced has been added to the [Connections](https://console.argyle.com/connections) page in Console and the Conversion section of [Console's Dashboard](https://console.argyle.com/dashboard). # API enhancements Source: https://docs.argyle.com/changelog/2023-11-29 New daily possible value added for base_pay.period November 29, 2023 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) We have introduced `daily` as a new possible value for `period` within the `base_pay` object, which is returned by the [identities endpoint](https://argyle.com/docs/api-reference/identities#object-base_pay) (API v2) and [employments endpoint](https://argyle.com/docs/legacy/api-reference/employments#object-base_pay.period) (API v1). # API breaking changes Source: https://docs.argyle.com/changelog/2023-12-04 Gross pay type consolidation on January 3, 2024. December 4, 2023 API Breaking ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) On **January 3, 2024**, we will be consolidating the list of possible `type` values for `gross_pay_list` objects, which are returned by the [paystubs endpoint](https://argyle.com/docs/api-reference/paystubs#object-gross_pay_list). The following `type` values will continue to be returned: * `base`, `pto`, `bonus`, `commission`, `overtime`, `disability`, `tips`, `stock`, `other` The following `type` value will be renamed: * `insurance` will be renamed to `benefits` The following `type` values will be removed: * `retirement` (merged with `benefits`) * `premium` (merged with `overtime`) * `unpaid` (merged with `other`) * `reimbursement` (merged with `other`) * `retro` (merged with `other`) # Link 5.5 Source: https://docs.argyle.com/changelog/2023-12-13 Payroll providers sorted by popularity. December 13, 2023 Link Link 5.5 is now available, and includes the following updates: * Payroll providers are now sorted by popularity, with a new user-friendly layout: ![Image](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2023-12-13/link_5.5.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=826200b40dd21870dd8eb9c824531d8c) * Your company logo now appears in front of the Argyle logo on Link's introduction screen. * Items shown in search can be limited based on their [mapping status](https://argyle.com/docs/overview/data-structure/items#mapping-status). * A new account connection error for [unsupported business accounts](https://argyle.com/docs/api-reference/account-connection-errors#unsupportedbusinessaccount) has been added. * The `onCantFindItemClicked` callback always precedes `onClose`. Web instances of Link 5 will automatically be upgraded to Link 5.5 and receive these latest features. Visit the following pages in our documentation to upgrade your respective Link SDK: * [iOS 5.5](https://argyle.com/docs/link/upgrade#ios) * [Android 5.5](https://argyle.com/docs/link/upgrade#android) * [React Native 5.5](https://argyle.com/docs/link/upgrade#react-native) * [Flutter 5.5](https://argyle.com/docs/link/upgrade#flutter) If you are upgrading from Link 4.7 or earlier, visit our [Link 5.0 Upgrade Guide](https://argyle.com/docs/upgrade-guide). # HubSpot added as new subprocessor. Source: https://docs.argyle.com/changelog/2023-12-18 HubSpot added as new subprocessor. December 18, 2023 Platform ![Platform update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/breaking.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=2c5e1520e37851960967e9d07b5275b8) Argyle has engaged HubSpot as a subprocessor in connection with marketing engagement, customer communication, and relationship management. Please visit our [Subprocessors](https://www.argyle.com/legal/open-payroll/subprocessors) page for more information. # Coverage enhancements Source: https://docs.argyle.com/changelog/2023-12-22 Historical gigs data adjustment on January 15, 2024. December 22, 2023 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) Beginning **January 15, 2024**, accounts connected to [gig platforms](https://console.argyle.com/coverage?type=gig) will provide historical data dating back to January 1, 2018. This change is solely applicable to data returned by our [gigs endpoint](https://argyle.com/docs/api-reference/gigs), and will not impact data from accounts connected before January 15, 2024. # API enhancements Source: https://docs.argyle.com/changelog/2024-01-18 Additional fields returned when retrieving reports in JSON. January 18, 2024 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) The following additional fields are now returned when [retrieving the JSON](https://argyle.com/docs/api-reference/reports#retrieve-json) of Argyle verification reports via the API: * `type` * `report_id` * `user_id` * `external_id` * `generated_at` * `last_synced_at` * `end_date` * `last_paystub_date` # Link 5.6 Source: https://docs.argyle.com/changelog/2024-02-14 Redesigned connection success and reconnection screens. February 14, 2024 Link Link 5.6 is now available, and includes the following updates: * The redesigned connection success screen now features: * An emphasis on the "Connect more accounts" button (when enabled). * The option to disable the exit button (adjustable via [Flows](https://console.argyle.com/flows) in Console). ![Image](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2024-02-14/link5.6_1.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=caef85580adf242d8cc4091044373042) * Deposit switches with [adjustable allocations](https://argyle.com/docs/workflows/deposit-switching#dds-flows--direct-deposits) now have a more user-friendly design. * The search field is hidden for [constrained lists](https://argyle.com/docs/workflows/account-connections#list) of less than 10 Items. * Users can now select their preferred multi-factor authentication (MFA) method for a limited number of payroll providers. * The reconnection screen has been redesigned to streamline [re-authorizations](https://argyle.com/docs/workflows/reconnecting-accounts). ![Image](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2024-02-14/link5.6_2.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=454223338f273ea56bcb56e0bca4d0c0) * The **Callback** fallback experience now lets users search for their payroll provider if they cannot find their employer. * (Web only) Inline error messages are displayed on the login screen's input fields when invalid characters are used. * (Android only) SMS verification codes can be auto-filled during MFA. Web instances of Link 5 will automatically be upgraded to Link 5.6 and receive these latest features. Visit the following pages in our documentation to upgrade your respective Link SDK: * [iOS 5.6](https://argyle.com/docs/link/upgrade#ios) * [Android 5.6](https://argyle.com/docs/link/upgrade#android) * [React Native 5.6](https://argyle.com/docs/link/upgrade#react-native) * [Flutter 5.6](https://argyle.com/docs/link/upgrade#flutter) # API enhancements Source: https://docs.argyle.com/changelog/2024-02-29 original_hire_date added to the identities endpoint. February 29, 2024 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) A new field has been added to the [identities endpoint](https://argyle.com/docs/api-reference/identities): * `original_hire_date` — Timestamp of the user's earliest employment start date. # API enhancements Source: https://docs.argyle.com/changelog/2024-03-05 The /item-notifications endpoint has been deprecated. March 5, 2024 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) The `/item-notifications` endpoint has been deprecated. Please use the `/items` [endpoint](https://argyle.com/docs/api-reference/items) going forward to retrieve information on: * Changes to an Item's health `status` or related messaging when connection issues occur. * Changes to the data fields an Item supports or its deposit switching capabilities. # API breaking changes Source: https://docs.argyle.com/changelog/2024-03-08 file_url field will require basic authentication headers on April 8, 2024. March 8, 2024 API Breaking ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) On **April 8, 2024** the `file_url` [field](https://argyle.com/docs/api-reference/reports#object-file_url) returned by the `/v2/reports` endpoint will begin redirecting to a PDF download page that requires Argyle [basic authentication headers](https://argyle.com/docs/api-guide/overview#authentication). Please ensure your HTTP client or library is configured to pursue redirects and append authentication headers to these requests to continue successfully retrieving report PDFs via the API following this adjustment. # Automated reminders Source: https://docs.argyle.com/changelog/2024-04-02 Today we're introducing a new Console setting — Automated reminders. April 2, 2024 Console Today we're introducing a [new Console setting](https://console.argyle.com/settings/other-settings) — [Automated reminders](https://argyle.com/docs/console/flows/email-sms-templates#automated-reminders). ![Image](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2024-04-02/automated_reminders.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=28378184b461b98829543bb10d659aaf) * Automated reminders are sent when an invite remains unopened after a configured number of days. * Automated reminders are sent via the original invite method (email, SMS, or both). * Automated reminders will be applied to all new invites sent after the setting is enabled in Console. In most cases, this setting has already been enabled by default. # Link 5.7 Source: https://docs.argyle.com/changelog/2024-04-17 Major enhancements to document uploads. April 17, 2024 Link Link 5.7 is now available, and includes the following updates: **Document upload improvements** Link now supports [three additional document upload categories](https://argyle.com/docs/workflows/document-upload): * Proof of Identity * Proof of Address * Miscellaneous (re-nameable) ![Image](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2024-04-17/link5.7_1.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=d9b120dc37c954dac0d67f96c48a459b) Link now supports multiple document upload submissions. * Returning users can upload additional verification documents even if they previously uploaded documents. ![Image](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2024-04-17/link5.7_2.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=f043bb2710ca7f9b47912f54e3c2de45) Document upload can be shown on the connection success screen. ![Image](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2024-04-17/link5.7_3.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=22e6e38a763b447fbc1a376762b137d0) Document upload can be shown on the payroll provider selection screen. ![Image](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2024-04-17/link5.7_4.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=f33a1eaff227dc3526aec8d1018da101) Document upload can be shown when users select an unsupported employer. ![Image](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2024-04-17/link5.7_5.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=df8820925c5f501cfd362a2fc99631e4) Users entering Link through an [embedded instance](https://argyle.com/docs/console/flows/embedded-experiences) or [shareable URL](https://argyle.com/docs/console/flows/shareable-urls) that upload documents are asked for their full name, making these users more easily identifiable when viewing your [Connections](https://console.argyle.com/connections). ![Image](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2024-04-17/link5.7_6.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=49ebb5f01f9101deac32ccf3317722e6) * Uploaded documents can now be previewed. * Uploaded documents can be individually deleted. * All uploaded documents will now be contained within one dedicated "Uploaded documents" account per user, rather than associated with specific payroll account connections. ![Image](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2024-04-17/link5.7_7.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=66a6240d34a9c91ab0dd0c3c063edff7) **Other improvements** * If returning to Link's full search experience is optionally enabled for [direct logins](https://argyle.com/docs/workflows/account-connections#direct-login), the search experience can now be customized. * The "Find more employers" button can now be customized. * The `accountId` property returned by the `onDocumentsSubmitted` [callback](https://argyle.com/docs/link/reference/callbacks#ondocumentssubmitted) has been deprecated. * (Web only) Link will no longer close when users click outside its viewport. * Connection success screen subtitles can now be customized. ![Image](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2024-04-17/link5.7_8.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=354ec944e3ba68c2b6743e4bedf01452) Deposit switch percentages now adjust automatically. ![Image](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2024-04-17/link5.7_9.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=df5ea3e74d6148917b7ae56322bb89c4) Web instances of Link 5 will automatically be upgraded to Link 5.7 and receive these latest features. Visit the following pages in our documentation to upgrade your respective Link SDK: * [iOS 5.7](https://argyle.com/docs/link/upgrade#ios) * [Android 5.7](https://argyle.com/docs/link/upgrade#android) * [React Native 5.7](https://argyle.com/docs/link/upgrade#react-native) * [Flutter 5.7](https://argyle.com/docs/link/upgrade#flutter) New optional document upload features can be configured within "Document upload settings" when creating or editing [Flows](https://console.argyle.com/flows) in Console. # API enhancements Source: https://docs.argyle.com/changelog/2024-05-01 Authenticity information available for uploaded documents. May 1, 2024 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) [Authenticity information](https://argyle.com/docs/integrations/ocr/document-ocr-processors#authenticity-information) for uploaded documents is now available via the API when Ocrolus document processing is enabled. The following properties have been added to the [users forms endpoint](https://argyle.com/docs/api-reference/user-forms#upload-ocr_authenticity_score): * `ocr_authenticity_score` — Single integer score that captures the likelihood an uploaded document is authentic, as determined by Ocrolus. * `ocr_authenticity` — Object containing details on individual instances of tampering or other authenticity-related edits. The following [webhook](https://argyle.com/docs/api-reference/user-forms-webhooks#ocr-authenticity) is now available: * `user_forms.ocr_authenticity` — Sent when authenticity information is available for an uploaded document. *Ocrolus OCR and authenticity for uploaded documents can be purchased through Argyle directly. For purchasing and setup assistance, please reach out to our customer success team.* # Coverage enhancements Source: https://docs.argyle.com/changelog/2024-05-08 Education coverage expands by 600 employers. May 8, 2024 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) **Munis by Tyler Technologies**, an enterprise resource planning provider serving school districts, local governments, and other public sector entities has been added to Argyle's coverage, expanding our network by over **600 employers**. Argyle's coverage has also expanded by **200,000+ employees** with recent enhancements to our Workday integration, which now supports the following employers: * **Cleveland Clinic**, represented by the Item ID `item_000009086`. * **Delaware North Companies**, represented by the Item ID `item_000011545`. * **Evernorth Health Services**, represented by the Item ID `item_000073551`. * **Mercy Health**, represented by the Item ID `item_000025468`. * **Allegheny Health Network**, represented by the Item ID `item_000001638`. # Manage your teams with Groups Source: https://docs.argyle.com/changelog/2024-05-15 Today we're introducing a new Console setting: Groups. May 15, 2024 Console Today we're introducing a [new Console setting](https://console.argyle.com/settings/groups): Groups. * Manage viewing permissions in Console by organizing your team into groups. * Groups can be structured by branch, office, geographical location, or however best suits your organizational needs. * Console members can be limited to viewing only invites or verifications ordered by other members of their group. ![Image](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2024-05-15/groups.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=8c269e3d72306d9fe531be4e00986f24) *Please reach out to your Argyle Customer Success Manager to enable this setting. More information is also available in our [Groups Documentation](https://argyle.com/docs/console/management/groups).* # API enhancements Source: https://docs.argyle.com/changelog/2024-05-21 Two new fields added to users.fully_synced webhook. May 21, 2024 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) The payload of our [users.fully\_synced](https://argyle.com/docs/api-reference/users-webhooks#fully-synced) webhook now includes two additional properties: * `accounts_connected` * `external_id` # Coverage enhancements Source: https://docs.argyle.com/changelog/2024-05-29 Argyle's coverage expands by 450,000+ employees. May 29, 2024 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) [Deposit switching](https://argyle.com/docs/workflows/deposit-switching) for **Intuit Quickbooks Self-Employed** is now supported, giving you the ability to direct payments these customers receive from contractors and other sources to your bank account. Argyle's coverage has also expanded by **450,000+ employees** with recent enhancements to our **Oracle PeopleSoft** integration, which now supports the following employers: * **Ascension Health**, represented by the Item ID `item_000121975`. * **Atrium Health**, represented by the Item ID `item_000051905`. * **Mass General Brigham**, represented by the Item ID `item_000063190`. * **University of Michigan**, represented by the Item ID `item_000041449`. * **Brinker International**, represented by the Item ID `item_000006288`. * **JCPenney**, represented by the Item ID `item_000021119`. * **D.R. Horton**, represented by the Item ID `item_000012607`. * **Alaska Air Group**, represented by the Item ID `item_000001484`. # URL modifications Source: https://docs.argyle.com/changelog/2024-05-30 An enhanced way to share direct links to Argyle's payroll connection experience. May 30, 2024 Console Today we're introducing [URL modifications](https://argyle.com/docs/console/flows/shareable-urls#url-modifications). URL modifications are an enhancement to [Shareable URLs](https://argyle.com/docs/console/flows/shareable-urls), a feature that lets you share direct links to Argyle's payroll connection experience. With URL modifications, the URL path can be altered so you can adjust or even automate: * Who receives an email notification when there is a successful connection. * Which [external identifier](https://argyle.com/docs/overview/data-structure/users#external-identifiers) should be associated with connections made through the URL. ![Image](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2024-05-30/url_modifications.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=cc03184d7864ce074bf9e96ffa22fe8d) # Coverage enhancements Source: https://docs.argyle.com/changelog/2024-06-28 Argyle has achieved 70% verified coverage of the Fortune 500. June 28, 2024 Coverage Inclusion in our verified coverage requires at least one successful connection. Our Fortune 500 verified coverage has expanded in 2024 by over **750,000+ employees** from 18 of the largest U.S. employers, including: * **Adobe**, represented by the Item ID `item_000207039`. * **American Electric Power**, represented by the Item ID `item_000002231`. * **American Family Insurance Group**, represented by the Item ID `item_000002239`. * **Bank of New York Mellon**, represented by the Item ID `item_000004463`. * **DaVita**, represented by the Item ID `item_000011353`. * **Molson Coors Beverage**, represented by the Item ID `item_000026335`. * **Mutual of Omaha Insurance**, represented by the Item ID `item_000203751`. * **Pacific Life**, represented by the Item ID `item_000029422`. * **Rockwell Automation**, represented by the Item ID `item_000033507`. ![Image](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2024-06-28/verified_coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=5486043094612427f9c18dcce4a568d4) # API enhancements Source: https://docs.argyle.com/changelog/2024-07-03 New last_sent_at property added for better webhook management. July 3, 2024 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) The `/v2/webhooks` [endpoint](https://argyle.com/docs/api-guide/webhooks#subscribing-to-webhooks) now returns an additional property: `last_sent_at`. The `last_sent_at` property provides the most recent timestamp a particular webhook was sent, and is intended to aid in [webhook management](https://argyle.com/docs/api-guide/webhooks#webhook-management) and testing. # Link updates Source: https://docs.argyle.com/changelog/2024-07-05 New full_auth_required account connection error. July 5, 2024 Link ![Link update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/link.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=b6ea923ffd5a9eaa46c5b7425326d751) A new [account connection error](https://argyle.com/docs/api-reference/account-connection-errors#fullauthrequired) has been added: `full_auth_required`. This error is manually set by Argyle after investigating a previous error. When this error occurs, have the user [return to Link](https://argyle.com/docs/workflows/reconnecting-accounts#returning-users-to-link) and reconnect their account using their login credentials. # Employer match Source: https://docs.argyle.com/changelog/2024-07-08 Match users with their employers for a streamlined connection process. July 8, 2024 Console Today we're introducing [Employer Match](https://argyle.com/docs/console/flows/email-sms-templates#employer-match) and a few other major quality of life enhancements to Console and our Encompass integration. Employer Match is a new feature for situations where you already know the user's employer(s). * Employer Match lets you select one or more employers by searching Argyle's coverage when sending email or text invites through [Console](https://argyle.com/docs/console/flows/email-sms-templates#sending-invites) or [Encompass](https://argyle.com/docs/integrations/pos-los/encompass#verifying-income-and-employment). * **Invites are automatically adjusted so the user is sent directly to the respective login screens of those employers when they enter Link.** * Employer match can be enabled in the [Other settings](https://console.argyle.com/settings/other-settings) section of Console. ![Image](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2024-07-08/employer_match1.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=989a8c6628e237a348639a67b4a106ed) New workflow enhancements are also available: * **The invites interface in Console has been streamlined**, making it easier to select a [Group](https://argyle.com/docs/console/management/groups) and review the invite recipient's details before hitting send. * **Cc your team has been added to Encompass.** You can select contacts associated with a loan file or enter the emails of team members that you want notified when a verification report is available. * **Error messaging in Console and Encompass has been significantly improved.** Troubleshooting links now appear next to their respective errors, and new prompts are available if an account becomes disconnected. Extra handy to ensure Argyle data is up-to-date before ordering re-verification reports. ![Image](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2024-07-08/employer_match2.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=9ac5b46409b85a1001824ecb4bbd7cfb) # API enhancements Source: https://docs.argyle.com/changelog/2024-07-09 Argyle's new endpoint for manually uploaded documents. July 9, 2024 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) A new [user uploads endpoint](https://argyle.com/docs/api-reference/user-uploads) has been added to Argyle's API. * Retrieve and filter documents that users have [manually uploaded through Link](https://argyle.com/docs/workflows/document-processing). * Retrieve [Ocrolus OCR](https://argyle.com/docs/integrations/ocr/ocrolus) and [authenticity data](https://argyle.com/docs/integrations/ocr/ocrolus#authenticity-scores) for manually uploaded documents. # Link updates Source: https://docs.argyle.com/changelog/2024-07-18 New credentials_managed_by_organization account connection error. July 18, 2024 Link ![Link update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/link.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=b6ea923ffd5a9eaa46c5b7425326d751) A new [account connection error](https://argyle.com/docs/api-reference/account-connection-errors#credentialsmanagedbyorganization) has been added: `credentials_managed_by_organization`. This error occurs during Argyle's "Login help" password reset recovery flow for certain Items when the user's login credentials cannot be adjusted because they are centrally managed by their organization's IT department. # Authenticity Summary in Console Source: https://docs.argyle.com/changelog/2024-07-30 Authenticity information for uploaded documents. July 30, 2024 Console Console now displays authenticity information for uploaded documents when [Ocrolus OCR](https://argyle.com/docs/integrations/ocr/ocrolus) is enabled. ![Image](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2024-07-30/authenticity.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=859fdbff54ff6d60e02eea953b08d32e) # Coverage enhancements Source: https://docs.argyle.com/changelog/2024-07-31 Argyle's healthcare sector coverage expands by 200,000+ employees. July 31, 2024 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) Argyle's healthcare sector coverage has recently expanded by **200,000+ employees**. The following employers are now supported: * **Cencora**, represented by the Item ID `item_000002436`. * **Christus Health**, represented by the Item ID `item_000115076`. * **Highmark Health**, represented by the Item ID `item_000018728`. * **Vidant Health**, represented by the Item ID `item_000042276`. * **Wellstar Health System**, represented by the Item ID `item_000043062`. * **Riverside Health System**, represented by the Item ID `item_000033339`. * **Florida Blue Health Insurance**, represented by the Item ID `item_000015322`. * **WPS Health Insurance**, represented by the Item ID `item_000043922`. # Link 5.8 Source: https://docs.argyle.com/changelog/2024-08-01 Payroll connection experience improvements. August 1, 2024 Link Link 5.8 is now available, and includes the following updates: * Deposit switch percentage allocations automatically adjust to add up to 100% when editing multiple bank accounts. * Date selection UI and validations have been added. ![Image](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2024-08-01/link5.8_1.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=26b3dee1f5d86340bb889558ef12ecea) * If all document categories are marked as *Optional*, the option to "Skip document upload" will be presented to users. ![Image](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2024-08-01/link5.8_2.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=a1a1ee91b1cde5ce2a5abb6a9b7af854) * "Allow users to access full search experience" is now available when listing employers. This can be enabled in the "List" search and connect settings when configuring [Flows](https://console.argyle.com/flows) in Console. ![Image](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2024-08-01/link5.8_3.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=bf23f1ce60ea5b1b256b506d40746926) * Whitespace format validation has been introduced for MFA codes. * The `closeMethod` property was added to the `onUIEvent` [callback](https://argyle.com/docs/link/reference/tracking#link-closed). * (Web) UX compatibility adjustments were made for screens with heights under 720px. Web instances of Link 5 will automatically be upgraded to Link 5.8 and receive these latest features. Visit the following pages in our documentation to upgrade your respective Link SDK: * [iOS 5.8](https://argyle.com/docs/link/upgrade#ios) * [Android 5.8](https://argyle.com/docs/link/upgrade#android) * [React Native 5.8](https://argyle.com/docs/link/upgrade#react-native) * [Flutter 5.8](https://argyle.com/docs/link/upgrade#flutter) # Link updates Source: https://docs.argyle.com/changelog/2024-08-08 New feature for payroll accounts with multiple employments coming soon. August 8, 2024 Link In the coming weeks, Argyle will be rolling out a new feature designed to support payroll accounts with multiple employments. This feature applies to users who have worked for two or more employers using the same payroll system. ![Image](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2024-08-08/aug_link_update.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=b167067d57d02916114bbf50e1a3409f) After a successful connection: * If multiple employments are detected within the connected payroll account, users will be prompted to select and connect each of their current and past employers. * Duplicate accounts for the same employer will be prevented. * Argyle's [data sets](https://argyle.com/docs/overview/data-structure/data-sets) and [verification reports](https://argyle.com/docs/overview/data-structure/reports) will begin reflecting the name of the employer associated with each connection's underlying employment records, instead of the name of the Item the user selected in Link. # API enhancements Source: https://docs.argyle.com/changelog/2024-08-14 Quality of life upgrades to Argyle's invites endpoint. August 14, 2024 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) Our [invites endpoint](https://argyle.com/docs/api-reference/invites) has been enhanced with a few quality of life upgrades: * Invite recipients can now be sent directly to their employers' login screens via a new `flow_items` [parameter](https://argyle.com/docs/api-reference/invites#send-flow_items) that can be used when [sending invites](https://argyle.com/docs/api-reference/invites#send-invite). * Sent invites can now be filtered by their `status` value. * Sent invites can now be filtered by their `reply_to` values. * This newly introduced `reply_to` [property](https://argyle.com/docs/api-reference/invites#object-reply_to) lists the email addresses that will receive an email notification after an account connection occurs. * The email address of the invite sender is always listed if you are sending invites through [Console](https://argyle.com/docs/console/flows/email-sms-templates#sending-invites) or one of Argyle's [POS/LOS integrations](https://argyle.com/docs/integrations/pos-los/encompass). * If you are linking to Argyle using [Shareable URLs](https://argyle.com/docs/console/flows/shareable-urls), the email addresses specified in your [Flow settings](https://console.argyle.com/flows) or [URL modifications](https://argyle.com/docs/console/flows/shareable-urls#url-modifications) will be listed. # API enhancements Source: https://docs.argyle.com/changelog/2024-08-20 Automate employer search inputs in your applications. August 20, 2024 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) A new `matching_score` [field](https://argyle.com/docs/api-reference/items#object-matching_score) is now returned when [listing Items](https://argyle.com/docs/api-reference/items#list). * This field provides a confidence score of how well the returned Items match your search query. A new `min_matching_score` [query parameter](https://argyle.com/docs/api-reference/items#list-min_matching_score) has also been added to restrict search results to specific confidence levels. * **This field can be used to automate employer search inputs in your applications** — query Argyle's API for a relevant Item and with high confidence [directly connect](https://argyle.com/docs/workflows/account-connections#direct-login) users to their employers' login screens in Link. Additionally, in **Sandbox** you can now [update a sample user's identity information](https://argyle.com/docs/overview/sandbox-testing#update-sample-data). This provides a way to test or explore how your system handles identity-related events such as a user's `employment_status` updating from `active` to `terminated`. # API enhancements Source: https://docs.argyle.com/changelog/2024-08-22 API secret obfuscation for improved security. August 22, 2024 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) In line with our commitment to secure practices, API key secrets going forward will only be visible during API key creation and partially obfuscated thereafter. * **Please ensure you copy and securely store API secrets when creating new API keys.** # API enhancements Source: https://docs.argyle.com/changelog/2024-08-28 Re-introducing Argyle's user forms endpoint and webhooks. August 28, 2024 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) The [user forms endpoint](https://argyle.com/docs/api-reference/user-forms) and its [related webhooks](https://argyle.com/docs/api-reference/user-forms-webhooks) have been re-introduced to **API v2**, as a follow-on to the recent introduction of the [user uploads endpoint](/changelog/2024-07-09). # API enhancements Source: https://docs.argyle.com/changelog/2024-08-29 military and benefits added as new possible values for employment_type August 29, 2024 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) Two new possible values have been added to the `employment_type` field returned by the [identities endpoint](https://argyle.com/docs/api-reference/identities#object-employment_type): * `military` * `benefits` # Link updates Source: https://docs.argyle.com/changelog/2024-08-30 Three new account connection errors have been added. August 30, 2024 Link ![Link update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/link.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=b6ea923ffd5a9eaa46c5b7425326d751) Three new [account connection errors](https://argyle.com/docs/api-reference/account-connection-errors) have been added: * `account_nonunique` — This error occurs after a user selects "Login help" and enters personal details that match multiple account records stored by the payroll system's account recovery service. * `mfa_cancelled_by_the_user` — This error occurs when a user exits Link's multi-factor authentication (MFA) screen during an account connection attempt before completing the MFA process. * `platform_temporarily_unavailable` — This error occurs when an account is connected to a payroll system that is experiencing temporary connection issues. # Coverage enhancements Source: https://docs.argyle.com/changelog/2024-09-03 Argyle's coverage expands by 450,000+ employees. September 3, 2024 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) Argyle's coverage has expanded by another **450,000+ employees** with recent enhancements to our Workday integration, which now supports the following employers: * **Loblaw Companies**, represented by the Item ID `item_000023703`. * **Smithfield Foods**, represented by the Item ID `item_000069339`. * **Brookfield**, represented by the Item ID `item_000006374`. * **Northern Trust**, represented by the Item ID `item_000028089`. * **Topgolf Callaway Brands**, represented by the Item ID `item_000006940`. * **Mercy**, represented by the Item ID `item_000183406`. * **United Rentals**, represented by the Item ID `item_000083442`. # Link updates Source: https://docs.argyle.com/changelog/2024-09-16 Connect more employers button added to Link's login success screen. September 16, 2024 Link ![Link updates](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2024-09-16/link09-15_cover.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=8428e675e0547d4564fb6fd37b2aff4d) On October 16, 2024, the "**Connect more employers**" button will be displayed by default on Link's login success screen. * This change will only adjust the Link experience if you are using Link's default Flow. * This change will not adjust any saved Link Flow customizations that you are currently applying to invites, shareable URLs, or embedded instances of Link. * After this change, you will still be able to toggle this button ON or OFF when creating or editing [Link Flows](https://console.argyle.com/flows) in Console. ![Image](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2024-09-16/link_login_success.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=aa501c5c479f848049fa6680b729c588) # Link 5.9 Source: https://docs.argyle.com/changelog/2024-10-02 User flow and navigation improvements. October 2, 2024 Link ![Link 5.9](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2024-10-02/link5.9_cover.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=383be8b59d02159da3953526458f5581) Link 5.9 is now available, and includes the following updates: * Login help is now shown more prominently after invalid credentials are entered on Link’s login screen, making it easier for users to natively reset their usernames and passwords and try logging in again. ![Image](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2024-10-02/link5.9_1.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=040fd856f8c39adc36adfdfb93bb2332) * (Web only) The initial screen shown to [returning users](https://docs.argyle.com/workflows/reconnecting-accounts#adjusting-links-initial-screen) can now be set to the “Your connections” screen, which displays the user's previous connections. This can be enabled in the “General settings” area of your [Flow settings](https://console.argyle.com/flows). ![Image](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2024-10-02/link5.9_2.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=dc0ef96010d8df4c62207b05b699bc4d) * On Link’s success screen, the “**Connect more employers**” button can now be optionally toggled ON in your [Flow settings](https://console.argyle.com/flows) for [direct login](https://docs.argyle.com/workflows/account-connections#direct-login) experiences. ![Image](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2024-10-02/link5.9_3.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=822bb6a880b164bab5dd0695e16e9ab2) * A new “**Find more employers**” button can now be shown when users are sent via [direct login](https://docs.argyle.com/workflows/account-connections#direct-login) to an unsupported employer or payroll platform (adjustable via [Flow settings](https://console.argyle.com/flows)). ![Image](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2024-10-02/link5.9_4.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=cec020fe6be11853add6d25649df6379) * Accounts that experience a `platform_temporarily_unavailable` [error](https://docs.argyle.com/api-reference/account-connection-errors#platformtemporarilyunavailable) will now automatically transition to the `full_auth_required` [error](https://docs.argyle.com/api-reference/account-connection-errors#fullauthrequired) when the ability to connect to the underlying payroll platform has been restored. The corresponding error screens in Link have been updated accordingly. ![Image](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2024-10-02/link5.9_5.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=9cf87df955bc975b2d68c0dfbd5a1fe3) * After users select a payroll provider and are asked for their employer, if they select “Can’t find your employer?” they will no longer be directed back to the redundant payroll provider selection screen. ![Image](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2024-10-02/link5.9_6.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=6dbb83a4c8f17966c107fa831186e4c9) * An improvement to Link’s exit navigation now ensures that users can re-attempt MFA submissions after an incorrect submission without losing their progress. ![Image](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2024-10-02/link5.9_7.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=a599e5a2205e45c5127f9e661f06a85d) * After successful document uploads, the “Done” button now closes Link. * Single-sign on (SSO) login hints are now larger. * (Web) UX compatibility adjustments were made for wide-screen resolutions. Web instances of Link 5 will automatically be upgraded to Link 5.9 and receive these latest features. Visit the following pages in our documentation to upgrade your respective Link SDK: * [iOS 5.9](https://argyle.com/docs/link/upgrade#ios) * [Android 5.9](https://argyle.com/docs/link/upgrade#android) * [React Native 5.9](https://argyle.com/docs/link/upgrade#react-native) * [Flutter 5.9](https://argyle.com/docs/link/upgrade#flutter) # Coverage enhancements Source: https://docs.argyle.com/changelog/2024-10-07 Argyle's coverage expands by 500,000+ employees. October 7, 2024 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) Recent enhancements have led to significant conversion improvements for **Apple** and **Luxottica** employees (Item ID’s `item_000222814` and `item_000222798`, respectively). Upgrades to Argyle’s Dayforce HCM integration have also expanded Argyle’s coverage by **500,000+ employees**, with the following employers now supported: * **Accenture**, represented by the Item ID `item_000207067` * **Analog Devices**, represented by the Item ID `item_000002566` * **Balfour Beatty**, represented by the Item ID `item_000004394` * **bioMerieux**, represented by the Item ID `item_000005392` * **Coty**, represented by the Item ID `item_000010360` * **Dewberry**, represented by the Item ID `item_000011834` * **Legrand**, represented by the Item ID `item_000023142` * **Nexteer Automotive**, represented by the Item ID `item_000027734` * **Performance Contracting, Inc.**, represented by the Item ID `item_000163554` * **Reliance**, represented by the Item ID `item_000032820` * **Swire Coca-Cola, USA**, represented by the Item ID `item_000037920` * **Sylvamo**, represented by the Item ID `item_000094090` # Coverage enhancements Source: https://docs.argyle.com/changelog/2024-10-18 Argyle's government sector coverage expands by 250,000 employees. October 18, 2024 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) Argyle now supports **State of California** employees, expanding our coverage by 250,000 additional workers. Users can connect their accounts in Link using the following Items: * **State of California**, represented by the Item ID `item_000046910` * **Cal Employee Connect**, represented by the Item ID `item_000246763` # Integration enhancements Source: https://docs.argyle.com/changelog/2024-10-25 Argyle is now fully integrated with nCino. October 25, 2024 Integrations ![Integrations update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/integrations.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1844d9bdf0a31d0b8c27962155e43a90) We're thrilled to announce our [nCino integration](https://docs.argyle.com/integrations/pos-los/ncino) is fully native. With Argyle now available within the nCino POS system, borrowers can securely share their income and employment details through a simple login connection. Argyle will automatically deliver paystubs, W2s, and verification reports that can be viewed within the nCino platform and Encompass. ***Reach out to your nCino customer success manager to enable these Argyle integrations today.*** # Link updates Source: https://docs.argyle.com/changelog/2024-10-29 New session_limit_reached account connection error has been added. October 29, 2024 Link ![Link update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/link.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=b6ea923ffd5a9eaa46c5b7425326d751) A new `session_limit_reached` [account connection error](https://docs.argyle.com/api-reference/account-connection-errors#sessionlimitreached) has been added. This error occurs when a payroll platform limits the number of simultaneous active sessions or devices that their users can be logged into at the same time. Argyle will not complete the connection to avoid signing the user out of their other active sessions. # Integration enhancements Source: https://docs.argyle.com/changelog/2024-11-04 Verification not completed email alerts and automated employer matching in Encompass. November 4, 2024 Integrations Console Automated email alerts for incomplete verifications are now available for all Argyle implementations. These alerts are **disabled by default** but can be enabled in the [Settings](https://console.argyle.com/settings/other-settings) section of Console. ![Image](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2024-11-04/integrations_1.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=2dfa2cb4200953fb7a44d14506587d2c) [Argyle’s Encompass integration](https://docs.argyle.com/integrations/pos-los/encompass) will now automatically populate [Employer Match](/changelog/2024-07-08) if the borrower’s employer found in their Encompass loan file is within Argyle’s coverage network. This setting is **enabled by default** but can be disabled within the [Developers](https://console.argyle.com/integrations) section of Console. ![Image](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2024-11-04/integrations_2.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=100cff61039f9bedd0ef4a7d1249a617) # Link 5.10 Source: https://docs.argyle.com/changelog/2024-11-06 Duplicate account prevention and connection improvements. November 6, 2024 Link Link 5.10 is now available, and includes the following updates: * Duplicate account connections are now prevented during the “Login help” account recovery process for certain Items. ![Image](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2024-11-06/link5.10_1.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=871e29beea5fa972b947aca670b9782e) * Users can now be prevented from searching for a different payroll provider when [direct login](https://docs.argyle.com/workflows/account-connections#direct-login) is used to connect them to a specific employer or payroll provider. This is disabled by default but can be enabled via [Flow settings](https://console.argyle.com/flows). ![Image](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2024-11-06/link5.10_2.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=cf5e8f60db2c0c46a785ace0db1401aa) * Payroll providers that require a Company or Org-level ID now provide tailored hints on where users can find these identifiers. ![Image](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2024-11-06/link5.10_3.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=cbe80dc9699720e8e00fc5e53e6317ec) * A “Done” button now appears when returning users submit [additional document uploads](https://docs.argyle.com/workflows/document-processing#additional-uploads-returning-users). ![Image](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2024-11-06/link5.10_4.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=6d78580c8d1ae2f5bdd8f19dee1fe3bf) * When viewing an existing connection, users can now exit Link using the “Done” button. ![Image](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2024-11-06/link5.10_6.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=a73520bcdb82c34dda8817ebd9d9966b) * Link’s response form submission screen has been updated to clarify that submitting a form is not equivalent to connecting a payroll account. ![Image](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2024-11-06/link5.10_7.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=d84fb6597f4ed97d3d71d64926f766f6) * (Web only) Link’s “X” exit button can now be disabled via [Flow settings](https://console.argyle.com/flows). This exit button remains on by default. ![Image](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2024-11-06/link5.10_5.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=fadef1a3af3b370ffcd6647472e5dc55) * (Web only) Users are asked to select their employer after submitting valid login credentials when connecting directly to certain payroll providers. Until a selection is made, a new [account connection error](https://docs.argyle.com/api-reference/account-connection-errors#invalidloginurl) `invalid_login_url` will occur. ![Image](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog/2024-11-06/link5.10_8.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=936ab90626c2d46744a05efa10bc8dad) * (Web only) Returning users can now close Link using the new “Back to” button when viewing their existing connections. ![Image](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2024-11-06/link5.10_9.png?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=67ca761257d09b2d782edec229b417a8) Web instances of Link 5 will automatically be upgraded to Link 5.10 and receive these latest features. Visit the following pages in our documentation to upgrade your respective Link SDK: * [iOS 5.10](https://argyle.com/docs/link/upgrade#ios) * [Android 5.10](https://argyle.com/docs/link/upgrade#android) * [React Native 5.10](https://argyle.com/docs/link/upgrade#react-native) * [Flutter 5.10](https://argyle.com/docs/link/upgrade#flutter) # API breaking changes Source: https://docs.argyle.com/changelog/2024-11-15 Legacy API v1 will be retired on March 31, 2025. November 15, 2024 API Breaking ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) On **March 31, 2025** we will be retiring our legacy API v1. Any calls made to `/v1` endpoints after this date will no longer function. Please complete your transition to API v2, which was [introduced in April 2023](https://argyle.com/blog/announcing-argyle-2/). To ensure a smooth transition: * Review our [Upgrade Guide](https://docs.argyle.com/upgrade-guide) for details on migrating to API v2. * If you are already using [API v2](https://docs.argyle.com/api-reference/users) exclusively, no further action is needed. * For help or assistance, contact us at **[support@argyle.com](mailto:support@argyle.com)** or reach out to your customer success manager. # API enhancements Source: https://docs.argyle.com/changelog/2024-11-19 cancel added as a new possible value for gig task events. November 19, 2024 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) `cancel` has been added as a new possible value for `task_details.events.type` returned by the [gigs endpoint](https://docs.argyle.com/api-reference/gigs#object-events-type). # Coverage enhancements Source: https://docs.argyle.com/changelog/2024-11-22 Support for new single sign-on (SSO) and multi-factor authentication (MFA) methods continues to increase the scope of Argyle’s coverage. November 22, 2024 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) This quarter, new SSO login methods for **700+ employers and payroll systems** have been added, including: * **Workday**, which now supports `F5` SSO * **Dayforce HCM**, which now supports `OneLogin` SSO Unique SSO and MFA combination have also been a top priority, with recent efforts allowing Argyle to support a number of new employers such as: * **Apple**, represented by the Item ID `item_000222814` * **City of New York**, represented by the Item ID `item_000008827` * **DaVita**, represented by the Item ID `item_000011353` * **AutoZone**, represented by the Item ID `item_000204544` * **Highmark Health**, represented by the Item ID `item_000018728` * **Health Care Services Corporation**, represented by the Item ID `item_000018400` * **United Rentals**, represented by the Item ID `item_000083442` * **New York University**, represented by the Item ID `item_000027710` * **Emory University**, represented by the Item ID `item_000013470` # Link 5.11 Source: https://docs.argyle.com/changelog/2024-12-02 Improvements to the login experience. December 2, 2024 Link Link 5.11 is now available, and includes the following updates: * A navigation link now appears when users attempt to connect to a payroll system that limits the number of active sessions. This lets users quickly log out and return to Link to connect their account. ![Image](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2024-12-02/link5.11_1.png?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=092e4e9e8123685b977080a003fc5cbd) * Native password resetting is now available for more login experiences. ![Image](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2024-12-02/link5.11_2.png?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=671a471ccae00c4f0884dbe2dadae645) * [Returning users](https://docs.argyle.com/workflows/reconnecting-accounts#returning-users-to-link) can now easily access previously uploaded documents. ![Image](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2024-12-02/link5.11_3.png?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=4e5431182b39fdd5c662676f8da996c7) * Automatic date formatting has been added for Web and Android users. iOS continues to use the built-in date picker introduced in [Link 5.8](/changelog/2024-08-01). ![Image](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2024-12-02/link5.11_4.png?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=b61bb0c861773ab0525e6cb719c6524b) Web instances of Link 5 will automatically be upgraded to Link 5.11 and receive these latest features. Visit the following pages in our documentation to upgrade your respective Link SDK: * [iOS 5.11](https://argyle.com/docs/link/upgrade#ios) * [Android 5.11](https://argyle.com/docs/link/upgrade#android) * [React Native 5.11](https://argyle.com/docs/link/upgrade#react-native) * [Flutter 5.11](https://argyle.com/docs/link/upgrade#flutter) # Link 5.12 Source: https://docs.argyle.com/changelog/2024-12-18 Duplicate account prevention improvements. December 18, 2024 Link ![Link 5.12](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2024-12-18/link5.12_cover.png?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=5305c8490806430b7da59c83a6fadc4f) Link 5.12 is now available, and includes the following updates: * Duplicate account connections are now prevented during login for certain Items. ![Image](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2024-12-18/link5.12_1.png?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=2e7195b667a50875959109e0a6e2f6f6) * We’ve updated our data-retrieval loading screens for a smoother, sleeker experience. ![Image](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2024-12-18/link5.12_2.png?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=124ae90bfa2233d1f2e0e82a4239c189) * Input text boxes now feature more prominent shading to better differentiate them from buttons. One new [Link error](https://docs.argyle.com/link/reference/error-codes) has been added: * `duplicate_account` — Login screen notification for certain Items when a user attempts to connect an already-connected account. Two new [account connection errors](https://docs.argyle.com/api-reference/account-connection-errors) have been added: * `existing_account_found` — Login help notification for certain Items when a user attempts to connect an already-connected account. * `all_employers_connected` — Login help notification for certain Items when a user attempts a connection and all accounts associated with their recovery details (name, phone number, and/or email) have already been connected. Web instances of Link 5 will automatically be upgraded to Link 5.12 and receive these latest features. Visit the following pages in our documentation to upgrade your respective Link SDK: * [iOS 5.12](https://argyle.com/docs/link/upgrade#ios) * [Android 5.12](https://argyle.com/docs/link/upgrade#android) * [React Native 5.12](https://argyle.com/docs/link/upgrade#react-native) * [Flutter 5.12](https://argyle.com/docs/link/upgrade#flutter) # API enhancements Source: https://docs.argyle.com/changelog/2025-01-07 Employments: A new way to filter identities, paystubs, and payroll documents. January 7, 2025 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) Today we’re introducing a new API endpoint called [employments](https://docs.argyle.com/api-reference/employments). This endpoint returns all individual employments associated with a user. The IDs of these employments can be used to filter the following Argyle data sets: * [Identities](https://docs.argyle.com/api-reference/identities#list) * [Paystubs](https://docs.argyle.com/api-reference/paystubs#list) * [Payroll Documents](https://docs.argyle.com/api-reference/payroll-documents#list) # Link updates Source: https://docs.argyle.com/changelog/2025-02-05 Excluded Items now appear in search. February 5, 2025 Link ![Link updates](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2025-02-05/link_updates_cover.png?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=c400566299cc9900198923397ccdf310) Employers or payroll providers you have excluded in your [Link Flow settings](https://console.argyle.com/flows) will now appear in Link’s search results. When selected, users will see a message that these connections are not supported. ![Image](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2025-02-05/link_updates_main.png?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=622fe6cbaa3cdcd2a0ef5db304b42025) # Integration enhancements Source: https://docs.argyle.com/changelog/2025-02-10 Argyle is now embedded within nCino, plus enhanced interoperability with Encompass. February 10, 2025 Integrations ![Integration enhancements](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2025-02-10/ncino_enc_cover.png?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=2008c3712a015c42c55944867184c801) Mortgage borrowers can now seamlessly connect their payroll accounts via Argyle within nCino when completing the **Employment & Income** section of their loan applications. * Direct-sourced data populates the application for a faster, less-error prone workflow. * Automatically obtain paystubs, W-2s, and GSE-approved verification reports. ![Image](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2025-02-10/ncino_enc_main.png?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=c8f429ce378d395820bcc0da213642d6) Argyle is also introducing complete interoperability between nCino and Encompass® by ICE Mortgage Technology®. * Documents and verification reports based on nCino connections can be passed directly to Encompass®. * URLA and GSE provider fields will auto-populate in Encompass®, simplifying submissions to automated underwriting systems (AUS) like Fannie Mae’s Desktop Underwriter® and Freddie Mac’s Loan Product Advisor®, while enhancing rep & warrant relief eligibility. ***Reach out to your nCino and Encompass® customer success managers to enable these Argyle integrations today.*** # API enhancements Source: https://docs.argyle.com/changelog/2025-02-13 Reports webhooks: Get notified when new reports can be generated. February 13, 2025 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) Today we’re introducing two new [reports webhooks](https://docs.argyle.com/api-reference/reports-webhooks): * `reports.ready` notifies you when an Argyle verification report can be generated after an initial account connection or reconnection. * `reports.generated` notifies you when a report has been successfully generated and can be retrieved. # API enhancements Source: https://docs.argyle.com/changelog/2025-02-17 Employer Search: A new API endpoint that can power in-app employer searches of Argyle’s coverage. February 17, 2025 API Today we’re introducing a new API endpoint called [Employer Search](https://docs.argyle.com/api-reference/employer-search). This endpoint can be used to create free-text employer search inputs in your applications. * The endpoint returns a list of employers that best match the user's query. * Visually display the search results, which can be continuously updated real-time as the employer is searched letter-by-letter. * When the user selects their employer, they can be [directly connected](https://docs.argyle.com/workflows/account-connections#direct-login) to that employer in Link and log in to their account. ![Image](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2025-02-17/employer-search.png?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=81b3d9b593c487475e5979522096a9a7) # Link 5.13 Source: https://docs.argyle.com/changelog/2025-02-19 Rich text multi-factor authentication and other improvements. February 19, 2025 Link ![Link 5.13](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2025-02-19/link5.13_cover.png?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=220124dfe4da634336a7b8e8ceee11c4) Link 5.13 is now available, and includes the following updates: * Rich text support has been added for multi-factor authentication (MFA) screens. ![Image](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2025-02-19/link5.13_1.png?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=4b6b928e0692c214059b640f79bb557e) * When uploading documents, users are reminded to submit clear and fully visible images. ![Image](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2025-02-19/link5.13_2.png?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=3e2318e0064f3d75acde97f7586fce27) * Users now see a “Not your employer?” option when [directly connected](https://docs.argyle.com/workflows/account-connections#direct-login) to specific Items, enabling them to return to full search if the Item is not their employer or payroll provider. ![Image](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2025-02-19/link5.13_3.png?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=6bca561ae7a8aac7b212319b31596f1c) * Link’s search component has been standardized across all search screens. ![Image](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2025-02-19/link5.13_4.png?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=12c89d9e4b457c73f86d39686c1a2f30) * `userSubmissionComplete` parameter added to [onClose](https://docs.argyle.com/link/reference/callbacks#onclose) callback. * iOS SDK size has been reduced by over 50% to less than 10MB. Web instances of Link 5 will automatically be upgraded to Link 5.13 and receive these latest features. Visit the following pages in our documentation to upgrade your respective Link SDK: * [iOS 5.13](https://argyle.com/docs/link/upgrade#ios) * [Android 5.13](https://argyle.com/docs/link/upgrade#android) * [React Native 5.13](https://argyle.com/docs/link/upgrade#react-native) * [Flutter 5.13](https://argyle.com/docs/link/upgrade#flutter) # Coverage enhancements Source: https://docs.argyle.com/changelog/2025-02-26 Significant growth in Argyle’s coverage over the last year. February 26, 2025 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) Over the past year, Argyle’s coverage has grown significantly. Here’s a look at some of the highlights: * We’ve added **80,000 new employers and payroll providers** to our coverage. And not just in name only, we have **fully verified 72,000 of these connections** with the rest underway. * **30 million more employees** are supported by our verified connections. * **800+ education** and **1200+ healthcare** employer connections were added and verified. * We’ve **more than doubled** the number of single sign-on (SSO) and multi-factor authentication (MFA) connection processes we support for these employers and payroll providers. # Link updates Source: https://docs.argyle.com/changelog/2025-02-28 Improvements to Link's home screen. February 28, 2025 Link ![Link updates](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2025-02-28/link_updates_cover.png?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=5779c1876b20f026dcb067a530263c9b) Instead of a multi-column layout, web versions of Link have been upgraded to a cleaner, easier to navigate 2-column design. This update enhances readability and has been found to improve user navigation, creating a more streamlined search process. ![Image](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2025-02-28/link_updates_main.png?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=6b3c9738b0f2b36b0d7a27976c990ffc) # Link updates Source: https://docs.argyle.com/changelog/2025-03-03 New multi_driver_account account connection error. March 3, 2025 Link ![Link update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/link.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=b6ea923ffd5a9eaa46c5b7425326d751) A new [account connection error](https://docs.argyle.com/api-reference/account-connection-errors#multidriveraccount) has been added: * `multi_driver_account` — This error occurs when a gig rideshare account is connected that has multiple drivers associated with it. Argyle only supports single-driver accounts due to data privacy. # Integration enhancements Source: https://docs.argyle.com/changelog/2025-03-05 Major improvements to Argyle’s existing Encompass® integration. March 5, 2025 Integrations ![Integration enhancements](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2025-03-05/encompass_cover.png?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=9b7f2af43b860a3c7ee220d2c9353896) We’ve made some major improvements to our existing [Encompass® integration](https://docs.argyle.com/integrations/pos-los/encompass/overview) that offer greater flexibility and functionality for lenders. **Streamlined Order Flow** * Argyle’s new single-page experience makes it easier to order verifications, track your order status, view verification reports and documents, and request re-verifications all in one place. **Transparent Report Tracking** * New order statuses provide the visibility needed to move loans forward without delays. * Situation-specific troubleshooting tips now appear when additional action is required from borrowers, helping you resolve issues as quickly as possible. **Notification Management** * You now have the flexibility to choose which team members should receive status updates, no matter where you are in the order process. **Instant Closing Verifications** * When recent borrower data is available, closing verification of employment (VOE) reports can now be generated instantly. ***Reach out to your Argyle customer success manager to learn more.*** # Coverage enhancements Source: https://docs.argyle.com/changelog/2025-03-10 Argyle’s new gig integration to inDrive. March 10, 2025 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) **inDrive**, a leading ride-hailing and mobility service provider, has been added to Argyle’s gig coverage. * **inDrive** can be accessed via the Item ID `item_000268429` # API enhancements Source: https://docs.argyle.com/changelog/2025-03-25 Pre-fill user contact information in Link and across Argyle’s integrations. March 25, 2025 API Known user details including first name, last name, phone number, and email can now be optionally provided when [creating](https://docs.argyle.com/api-reference/users#create) or [updating](https://docs.argyle.com/api-reference/users#update) users via the API. When provided, **this information will be used to pre-fill login and other borrower contact details in Link and across our Integrations**, streamlining the account connection process and improving the user experience. In 30 days, our API responses for [retrieving](https://docs.argyle.com/api-reference/users#retrieve), [updating](https://docs.argyle.com/api-reference/users#update), and [listing](https://docs.argyle.com/api-reference/users#list) users will begin to include these four new fields: `first_name`, `last_name`, `phone_number`, and `email`. ![Image](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2025-03-25/pre-filled.png?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=228d57f0ca19fec5a08cf0d1c0baa862) # Link 5.14 Source: https://docs.argyle.com/changelog/2025-04-02 Connection status indicators, duplicate account prevention, and MFA improvements. April 2, 2025 Link ![Link 5.14](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2025-04-02/link5.14_cover.png?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=87a8c45dca0d8ae9ace251fc10116949) Link 5.14 is now available, and includes the following updates: * New connection status indicators have been added. ![Image](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2025-04-02/link5.14_1.png?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=40175aef437bf12cf183ac2f07bd079f) * Duplicate account connections are now prevented during login for even more Items. ![Image](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2025-04-02/link5.14_2.png?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=db70f8a72b5e050e3b45bbdbe86b6b45) * Multi-factor authentication (MFA) now supports **date of birth** and **phone number** verification inputs. Additionally, **MFA screens can now display multiple input fields**. ![Image](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2025-04-02/link5.14_3.png?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=e27ffc7c4e4ea8a0fdd33b5adc1ea6a6) * Dominican Republic phone numbers are now supported. ![Image](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2025-04-02/link5.14_4.png?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=582dee6db71ab12380d7122232c4a898) * The success message has been updated for document uploads. * Users can now always search for a payroll provider if they are unable to find their employer in Link’s search results. Web instances of Link 5 will automatically be upgraded to Link 5.14 and receive these latest features. Visit the following pages in our documentation to upgrade your respective Link SDK: * [iOS 5.14](https://argyle.com/docs/link/upgrade#ios) * [Android 5.14](https://argyle.com/docs/link/upgrade#android) * [React Native 5.14](https://argyle.com/docs/link/upgrade#react-native) * [Flutter 5.14](https://argyle.com/docs/link/upgrade#flutter) # API enhancements Source: https://docs.argyle.com/changelog/2025-04-09 item_id added to gigs webhooks. April 9, 2025 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) `item_id` is now included in the payload of the following [gigs webhooks](https://docs.argyle.com/api-reference/gigs-webhooks): * `gigs.added` * `gigs.updated` * `gigs.removed` * `gigs.partially_synced` * `gigs.fully_synced` # Coverage enhancements Source: https://docs.argyle.com/changelog/2025-04-14 Argyle has achieved 75%+ verified coverage of the Fortune 1000. April 14, 2025 Coverage Our Fortune 1000 verified coverage — requiring at least one successful connection — expanded in the first quarter of 2025 by over **1.6 million employees** from 49 of the largest U.S. employers, including: * **Biogen**, represented by the Item ID `item_000268433` * **Boston Scientific**, represented by the Item ID `item_000005946` * **Coca-Cola**, represented by the Item ID `item_000009312` * **ConocoPhillips**, represented by the Item ID `item_000009977` * **Eli Lilly**, represented by the Item ID `item_000013305` * **Fidelity Information Services (FIS)**, represented by the Item ID `item_000146432` * **First Citizens Bank**, represented by the Item ID `item_000015039` * **Goldman Sachs**, represented by the Item ID `item_000016990` * **News Corp**, represented by the Item ID `item_000268431` * **Paramount Pictures**, represented by the Item ID `item_000229516` * **Western Digital**, represented by the Item ID `item_000268428` ![Image](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2025-04-14/verified_coverage_2025.png?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=62a47413ecea45c93f6f918d63577115) # Link updates Source: https://docs.argyle.com/changelog/2025-05-19 New insufficient_account_data account connection error. May 19, 2025 Link ![Link update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/link.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=b6ea923ffd5a9eaa46c5b7425326d751) A new [account connection error](https://docs.argyle.com/api-reference/account-connection-errors#insufficientaccountdata) has been added: * `insufficient_account_data` — This error occurs when the connected account has paystubs and tax documents available, but is missing essential profile information (e.g. name, employment status) needed for a full verification. # Link updates Source: https://docs.argyle.com/changelog/2025-05-27 Three new account connection errors have been added. May 27, 2025 Link ![Link update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/link.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=b6ea923ffd5a9eaa46c5b7425326d751) Three new [account connection errors](https://argyle.com/docs/api-reference/account-connection-errors) have been added: * `invalid_employer_identifier` — This error occurs when a user has entered invalid login information related to the employer, such as an invalid company ID. * `invalid_store_identifier` — This error occurs when a user has entered invalid login information related to their store or club, such as an invalid store number. * `unrecognized_employer_email` — This error occurs when a user has entered an email address during login with a domain address that is not associated with the selected employer. # Link 5.15 Source: https://docs.argyle.com/changelog/2025-05-29 Returning user and document upload improvements. Link pre-filling on mobile. May 29, 2025 Link ![Link 5.15](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2025-05-29/link5.15_cover.png?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=8e5155202814fd51313abe3fe99dd86b) Link 5.15 is now available, and includes the following updates: * Document upload category limits now persist for returning users. ![Image](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2025-05-29/link5.15_1.png?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=70ac87d26254502eae1be35a879e1fe5) * When document upload is enabled as a fallback, users that select employers or payroll providers that have been excluded from user flows are now given the option to upload documents. ![Image](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2025-05-29/link5.15_2.png?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=9179396e8cdf6b35d6d7b6f0a6d8f28c) * “Your connections” is now the default returning user landing page for direct logins and new Flows when users already have connected accounts via Argyle. ![Image](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2025-05-29/link5.15_3.png?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=2c7edc72d8516ef13ae6ff381c161b7d) * [Pre-filling user contact information](/changelog/2025-03-25) in Link is now supported for mobile implementations. ![Image](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2025-05-29/link5.15_4.png?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=1aefae50c75aebf2992450c0a2d84e80) * The default button copy for “Login help” has been changed to “Need help logging in?”. * The default button copy to exit Link has been updated to “Done”. * For invite flows, a success page is now shown after users submit uploaded documents. * Additional language added on document deletion screens clarifying that deletion from Argyle may not remove documents from other external systems. Web instances of Link 5 will automatically be upgraded to Link 5.15 and receive these latest features. Visit the following pages in our documentation to upgrade your respective Link SDK: * [iOS 5.15](https://argyle.com/docs/link/upgrade#ios) * [Android 5.15](https://argyle.com/docs/link/upgrade#android) * [React Native 5.15](https://argyle.com/docs/link/upgrade#react-native) * [Flutter 5.15](https://argyle.com/docs/link/upgrade#flutter) # System upgrades Source: https://docs.argyle.com/changelog/2025-05-30 Reports service upgrades: June 2, 2:00–5:00 AM EST May 30, 2025 Platform ![Platform update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/breaking.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=2c5e1520e37851960967e9d07b5275b8) We will be performing **system upgrades** to our reports service on **June 2, 2025, from 2:00 to 5:00 AM EST**. Individual report generation and retrieval will remain fully operational, though some secondary report services may experience brief interruptions. # New report designs Source: https://docs.argyle.com/changelog/2025-06-02 Updated verification report designs and API endpoints. June 2, 2025 API Console Integrations We’re excited to introduce refreshed **report designs and endpoints**. This update offers a cleaner, more consistent experience across report types, making it simpler to review and retrieve employment details. ![Image](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2025-06-02/reports_cover.gif?s=6cecce93c10669a33fe7bdca42662753) **Upgrade Benefits**: Our new reports structure **aligns with how you verify income and employment** — by employer rather than payroll account. ✔️  **Unified Layout:** Consistent design across all report types. ✔️  **Clearer Organization:** Distinct sections for each employment. ✔️  **Enhanced Readability:** Improved data structure for quicker decision-making.\ \ **API Updates**: See our [reports upgrade guide](https://docs.argyle.com/reports-upgrade-guide) for more information. * Report type is now specified as a path parameter when generating reports. * The structure of our JSON reports has been updated to align with our employment-centered redesign. **Current API and JSON formats will remain fully supported** as you test and adopt our new reports!\ \ *For guidance or support with upgrading, please contact your Argyle customer success manager.* # Link updates Source: https://docs.argyle.com/changelog/2025-06-03 Spanish, Chinese, and Russian languages now supported in Link. June 3, 2025 Link If you are [embedding Link](https://docs.argyle.com/link/initialization) within your website or application, you can now optionally specify the display language using our new `language` [initialization parameter](https://docs.argyle.com/link/initialization#optional-initialization-parameters). * Accepted languages are `EN` (English), `ES` (Spanish), `ZH` (Chinese), or `RU` (Russian). * Non-English language support is currently limited to [gig platforms](https://docs.argyle.com/overview/data-structure/items#types-of-items). ![Image](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2025-06-03/language.png?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=15667301dbe7b734e728c2b0c50d7b3d) # Argyle has updated its legal terms. Source: https://docs.argyle.com/changelog/2025-06-06 Argyle has updated its legal terms. June 6, 2025 Platform ![Platform update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/breaking.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=2c5e1520e37851960967e9d07b5275b8) Argyle has updated its legal terms to reflect the addition of open banking products and services, and has made related updates to the legal terms applicable to its open payroll platform. Please see the customer-facing [Legal Changelog](https://argyle.com/legal/customers/changelog/) for more detail. # Multi-path verifications Source: https://docs.argyle.com/changelog/2025-06-16 Verify with payroll, banking, and document uploads. June 16, 2025 Console API We’re introducing a brand new invitation experience that provides **multiple verification options** including direct payroll connections, connecting bank accounts, and uploading documents. * Payroll and document verifications are available when sending invites via Console. * All three verification methods are available when sending invites via the API. These additional verification methods can be toggled ON in the [Flows](https://console.argyle.com/flows) section of Console when creating Email/SMS templates. ![Image](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2025-06-16/multi_path_1.png?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=9c30749653832137922aa4f20832abb1) We’re also introducing an API-based method for embedding bank connections within your applications, which also allows you to generate the following [new verification reports](https://docs.argyle.com/api-reference/banking-overview#supported-report-types): * Verification of Assets (VOA) * Verification of Income (VOI) * Verification of Assets & Income (VOAI) *Visit our [Banking Implementation Guide](https://docs.argyle.com/api-reference/banking-overview) for more information.* ![Image](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2025-06-16/multi-path_2.png?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=b69c191c615a33374e44fb4cf02d3c76) Lastly, we’ve streamlined our verification emails and landing pages with a faster, more user-friendly, and higher-converting experience. ![Image](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2025-06-16/multi_path_3.png?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=6e9b49d2c4b0e2b7eeb037131e8d3dfa) These updates enhance invites sent via Console and our API, as well as shareable URLs. ![Image](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2025-06-16/multi_path_4.png?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=d57abaa6db60eae61e6d7056876dcd60) # API enhancements Source: https://docs.argyle.com/changelog/2025-06-27 Uploading documents via the API is now available. June 27, 2025 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) Documents can now be uploaded directly via Argyle’s API through the [user-uploads endpoint](https://docs.argyle.com/api-reference/user-uploads#upload). * Direct API file uploads expand [Argyle’s document processing capabilities](https://docs.argyle.com/workflows/document-processing), letting you combine documents received via email or other workflows alongside files already uploaded by users through Argyle Link. * Documents uploaded via the API are also compatible with [Argyle’s full OCR data extraction and authenticity checks](https://docs.argyle.com/integrations/ocr/ocrolus). # Coverage enhancements Source: https://docs.argyle.com/changelog/2025-07-02 Expanded Microsoft single sign-on (SSO) support. July 2, 2025 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) Over the past quarter, we’ve added **Microsoft single sign-on (SSO)** as a login method for 160+ additional employers, including: * **Chico's**, represented by the Item ID `item_000008386` * **Danone**, represented by the Item ID `item_000011224` * **Gannett**, represented by the Item ID `item_000016187` * **HelloFresh**, represented by the Item ID `item_000272911` * **Interpublic Group of Companies**, represented by the Item ID `item_000073721` * **Lamb Weston**, represented by the Item ID `item_000022700` * **Leidos Holdings**, represented by the Item ID `item_000268425` * **OhioHealth**, represented by the Item ID `item_000028687` * **Syngenta Group**, represented by the Item ID `item_000038011` * **Tillamook**, represented by the Item ID `item_000088377` * **WellSpan Health**, represented by the Item ID `item_000043058` # API enhancements Source: https://docs.argyle.com/changelog/2025-09-22 Invite delivery information has been added. September 22, 2025 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) A new `deliveries` array of objects is now returned by the [invites endpoint](https://docs.argyle.com/api-reference/invites#array-deliveries). This array provides detailed information about the delivery status of an invite, including: * `id` — Unique ID of the invite delivery * `method` — Delivery method: `email` or `sms` * `status` — Delivery status: `sent`, `delivered`, `undelivered`, or `opened` * `sent_at` — Timestamp when the invite was sent * `updated_at` — Timestamp when the delivery status was last updated # Coverage enhancements Source: https://docs.argyle.com/changelog/2025-09-24 Argyle's coverage expands by 600,000+ employees. September 24, 2025 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) New enhancements to our Dayforce HCM integration, including support for Google single sign-on (SSO), have expanded Argyle’s coverage by **600,000+ employees**. The following additional employers are now supported: * **ArcelorMittal**, represented by the Item ID `item_000003089` * **Balfour Beatty**, represented by the Item ID `item_000004394` * **Battelle Memorial Institute**, represented by the Item ID `item_000155221` * **Beam Suntory**, represented by the Item ID `item_000048434` * **Betfair**, represented by the Item ID `item_000163753` * **Colgate-Palmolive**, represented by the Item ID `item_000009419` * **Gentiva Health Services**, represented by the Item ID `item_000156648` * **Greystar Property Management,** represented by the Item ID `item_000272195` * **Princess Cruises,** represented by the Item ID `item_000181830` * **RELX**, represented by the Item ID `item_000272277` * **UL Solutions**, represented by the Item ID `item_000083850` * **Yves Saint Laurent**, represented by the Item ID `item_000116029` # Link updates Source: https://docs.argyle.com/changelog/2025-10-01 New auth_method_temporarily_unavailable account connection error. October 1, 2025 Link ![Link update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/link.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=b6ea923ffd5a9eaa46c5b7425326d751) A new [account connection error](https://docs.argyle.com/api-reference/account-connection-errors#authmethodtemporarilyunavailable) will be introduced **October 2, 2025**: * `auth_method_temporarily_unavailable` — The selected connection method is currently unavailable. When this error is shown, users will be guided to an alternative login option. # Document verifications Source: https://docs.argyle.com/changelog/2025-10-07 Doc VOI reports are now available. October 7, 2025 Integrations API We’re excited to [introduce Doc VOI](https://argyle.com/blog/doc-voi-smarter-faster-document-based-income-verification/), a new addition to Argyle’s verification stack that enables **automated income verifications from uploaded documents**. ✔️  **Accelerate underwriting:** Receive early assessments of AIM-eligible monthly income. ✔️  **Boost efficiency:** Automate your document reviews and income calculations. ✔️  **Complete verification waterfall:** Payroll, banking, and now documents — all through Argyle. ![Image](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2025-10-07/doc-voi_cover.png?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=1bdba8f9748917599b4ee617e1e1b5c6) *Doc VOI is available today in Argyle’s Encompass® integration and through our Partners API.* # API enhancements Source: https://docs.argyle.com/changelog/2025-10-22 Generating billing receipts via API is now available. October 22, 2025 API Billing receipts can now be generated directly via Argyle’s API using the [receipts endpoint](https://docs.argyle.com/api-reference/receipts), which returns a PDF listing all billable transactions for a given user. ![Image](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2025-10-22/billing_receipts.png?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=d39851705c027c93b4a01093faf9fd9d) # Nightfall added as new subprocessor. Source: https://docs.argyle.com/changelog/2025-10-31 Nightfall added as new subprocessor. October 31, 2025 Platform ![Platform update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/breaking.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=2c5e1520e37851960967e9d07b5275b8) Argyle has engaged Nightfall as a subprocessor in connection with data loss prevention services. Please visit our [Subprocessors](https://www.argyle.com/legal/open-payroll/subprocessors) page for more information. # API enhancements Source: https://docs.argyle.com/changelog/2025-11-20 Rewards program information for gig employments has been added. November 20, 2025 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) A new `rewards` array of objects is now returned by the [ratings endpoint](https://docs.argyle.com/api-reference/ratings). This array provides rewards program information for gig employments, including: * `program_name` — Name of the rewards program * `tier` — Current rewards program tier or status * `valid_through` — Date until the current tier or status is valid * `points` — Points earned in the current rewards period # API enhancements Source: https://docs.argyle.com/changelog/2025-12-04 API timestamp format will be standardized January 5, 2026. December 4, 2025 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) On **January 5, 2026**, timestamps returned across all Argyle endpoints and webhooks will be standardized to a single, uniform format, with any fields that currently use microsecond precision updated to **millisecond precision**: * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) with millisecond precision (3-digit fractional seconds) * Example: `YYYY-MM-DDTHH:MM:SS.mmmZ` This update requires no action for most integrations, but if you are validating timestamps with strict schemas or fixed-length parsing, please make any necessary adjustments before January 5. *For assistance, contact your Argyle customer success manager.* # Coverage enhancements Source: https://docs.argyle.com/changelog/2025-12-05 Argyle's coverage expands by 200,000+ employees. December 5, 2025 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) New enhancements to our UKG Pro integration, including support for Google single sign-on (SSO), have expanded Argyle’s coverage by **200,000+ employees**. This coverage expansion includes the following employers: * **Adobe**, represented by the Item ID `item_000207039` * **Arrow Electronics**, represented by the Item ID `item_000268396` * **Biogen**, represented by the Item ID `item_000268433` * **CommScope**, represented by the Item ID `item_000274989` * **Dycom Industries**, represented by the Item ID `item_000012750` * **Golden State Warriors**, represented by the Item ID `item_000222217` * **Ingersoll Rand**, represented by the Item ID `item_000273426` * **Leidos**, represented by the Item ID `item_000268425` * **MDU Resources**, represented by the Item ID `item_000025126` * **Medxcel**, represented by the Item ID `item_000176665` * **Monster Beverage**, represented by the Item ID `item_000026401` * **News Corp**, represented by the Item ID `item_000268432` * **Regal Rexnord**, represented by the Item ID `item_000272871` * **Sonic Automotive**, represented by the Item ID `item_000273107` # Updates to Customer Terms and DBA. Source: https://docs.argyle.com/changelog/2025-12-11 Updates to Customer Terms and DBA. December 11, 2025 Platform ![Platform update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/breaking.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=2c5e1520e37851960967e9d07b5275b8) We updated our [Open Payroll Customer Terms](https://argyle.com/legal/customers/open-payroll/customer-terms/) and [DPA](https://argyle.com/legal/customers/open-payroll/dpa/) to cover Argyle's new [Doc VOI offering](https://argyle.com/use-cases/doc-processing/). We made further updates to the Open Payroll Customer Terms and Open Banking Customer Terms to clarify the effect of purchases through Reseller, including revisions to the definition of “Service Order” and the relationship between Service Orders and orders placed for the Open Payroll Platform and Open Banking Platform via Resellers. Finally, we added provisions to the Open Payroll Customer Terms clarifying the nature of the Open Payroll Platform and Open Banking Platform and related services when ordered by state or federal instrumentalities. Please see the [Open Payroll Customer Terms](https://argyle.com/legal/customers/open-payroll/customer-terms/) and [DPA](https://argyle.com/legal/customers/open-payroll/dpa/), and [Open Banking Customer Terms](https://argyle.com/legal/customers/open-banking/customer-terms/) for more information. # Integration enhancements Source: https://docs.argyle.com/changelog/2025-12-17 Completion emails sent for re-verifications in Encompass. December 17, 2025 Integrations ![Integration enhancements](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2025-12-17/verification_cover.png?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=6ef9295f3e80126ae840abf103cff8ba) Verification completed emails are now sent for re-verifications ordered via Argyle’s Encompass® integration. This ensures loan officers are notified when a borrower reconnects accounts or completes required re-verification steps. ![Image](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2025-12-17/verification_body.png?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=705a178716355704be46b660c4e0c1a0) # Coverage enhancements Source: https://docs.argyle.com/changelog/2026-01-13 Argyle’s coverage is expanding rapidly, with exciting new improvements. January 13, 2026 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) We’ve expanded direct login to payroll platforms, giving employees a faster and more seamless way to connect to the following payroll providers: * **Workday**, represented by the Item ID `item_000274797` * **UKG Pro**, represented by the Item ID `item_000273410` * **Dayforce**, represented by the Item ID `item_000011368` * **BambooHR**, represented by the Item ID `item_000004422` * **PrismHR**, represented by the Item ID `item_000273112` * **SAP SuccessFactors**, represented by the Item ID `item_000274944` * **Online Wage Statements**, represented by the Item ID `item_000274813` # Coverage enhancements Source: https://docs.argyle.com/changelog/2026-01-20 Patriot payroll integration expands Argyle’s coverage. January 20, 2026 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) Patriot, a payroll provider for small businesses serving over 60,000 employers, has been added to Argyle’s coverage. * Patriot can be accessed via the Item ID `item_000276704` # Coverage enhancements Source: https://docs.argyle.com/changelog/2026-02-10 Viventium payroll integration expands Argyle’s coverage. February 10, 2026 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) Viventium, a payroll platform for healthcare providers serving **500,000+ employees**, is now available through Argyle. * Viventium can be accessed via the Item ID `item_000122815` # Link 5.18 Source: https://docs.argyle.com/changelog/2026-02-12 Document uploads can be restricted to PDF only. February 12, 2026 Link ![Link 5.18](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2026-02-12/cover_link518.png?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=9897b59ff142511cf6286e882ecad19f) Document uploads can be restricted to PDF file types by [adjusting your settings](https://docs.argyle.com/workflows/document-processing#restricting-to-only-pdfs) in the Flows section of Console. Link will adjust accordingly to guide users. ![Image](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2026-02-12/link518.png?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=8c26a85ef42d5c8ab14c29baa7700bb6) Web instances of Link 5 will automatically be upgraded to Link 5.18 and receive these latest features. # Mintlify added as new subprocessor. Source: https://docs.argyle.com/changelog/2026-02-20 Mintlify added as new subprocessor. February 20, 2026 Platform ![Platform update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/breaking.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=2c5e1520e37851960967e9d07b5275b8) Argyle has engaged Mintlify as a subprocessor in connection with hosting, storage, and AI chatbot services. Please visit our [Subprocessors](https://www.argyle.com/legal/open-payroll/subprocessors) page for more information. # Coverage enhancements Source: https://docs.argyle.com/changelog/2026-02-23 Waffle House has been added to Argyle’s coverage. February 23, 2026 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) Waffle House, a nationwide restaurant chain with **45,000+ employees**, is now available through Argyle. * Waffle House can be accessed via the Item ID `item_000071748` # Updates to Open Banking Customer Terms. Source: https://docs.argyle.com/changelog/2026-02-24 Updates to Open Banking Customer Terms. February 24, 2026 Platform ![Platform update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/breaking.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=2c5e1520e37851960967e9d07b5275b8) Argyle has updated its [Open Banking Customer Terms](https://www.argyle.com/legal/open-banking/customer-terms) to address access fees that may be imposed by financial institutions. # Link updates Source: https://docs.argyle.com/changelog/2026-02-25 Expanded Spanish language support is now available in Link. February 25, 2026 Link ![Link updates](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2026-02-25/spanish_cover.png?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=a174e0d465a559e94fd8c12cf2f4723a) If you are [embedding Link](https://docs.argyle.com/link/initialization) within your website or application, you can now offer a **fully localized Spanish experience across all employers and payroll providers** using the existing `language` [initialization parameter](https://docs.argyle.com/link/initialization#optional-initialization-parameters). * Previously, Spanish (`ES`) was only supported for gig platforms. ![Image](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2026-02-25/spanish.png?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=81170e953ed4e19c2f20b465e4e90775) # Coverage enhancements Source: https://docs.argyle.com/changelog/2026-02-27 Argyle has achieved 80%+ verified coverage of the Fortune 1000. February 27, 2026 Coverage Since the start of Q4 2025, our Fortune 1000 verified coverage (*requiring at least one successful connection*) has expanded by **2M+ employees** across 57 of the largest U.S. employers, including: * **Boeing**, represented by the Item ID `item_000274480` * **Capital One**, represented by the Item ID `item_000007202` * **Comcast**, represented by the Item ID `item_000009573` * **Concentrix**, represented by the Item ID `item_000091586` * **Fox**, represented by the Item ID `item_000015667` * **Meta**, represented by the Item ID `item_000025570` * **Netflix**, represented by the Item ID `item_000027458` * **PNC**, represented by the Item ID `item_000203063` * **Travelers**, represented by the Item ID `item_000040484` * **U.S. Bank**, represented by the Item ID `item_000268421` * **Wells Fargo**, represented by the Item ID `item_000063863` ![Image](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2026-02-27/verified_coverage_2026.png?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=03ecac67007b87e5d317de3e44233f33) # Link updates Source: https://docs.argyle.com/changelog/2026-03-03 New temporary_credentials account connection error. March 3, 2026 Link ![Link update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/link.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=b6ea923ffd5a9eaa46c5b7425326d751) A new [account connection error](https://docs.argyle.com/api-reference/account-connection-errors#temporary_credentials) has been added: * `temporary_credentials` — The user attempted to connect using a temporary password. A permanent password must be set before retrying. # Integration enhancements Source: https://docs.argyle.com/changelog/2026-03-16 Introducing Argyle’s 3-in-1 Verification Suite in Encompass®. March 16, 2026 Integrations ![Image](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2026-03-16/3in1_cover.png?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=5949e2a6e3c144574528e3ba37bfae2c) [**Argyle’s 3-in-1 Verification Suite**](https://docs.argyle.com/integrations/pos-los/encompass/verifications) is now available in Encompass®, bringing **Income & Employment and Asset verifications into a single workflow** where lenders can order for multiple borrowers, track each order independently, and receive Day 1 Certainty® and AIM eligibility determinations. ✔️  **Unified Verification Ordering:** Manage multiple verification types in one workflow. ✔️  **New Integrated Asset Verification:** Now available within Argyle’s Encompass® experience. ✔️  **Doc VOI Included:** Extend borrower coverage with document-based verifications. ✔️  **Updated Borrower Experience:** Enhanced invites and landing pages to guide borrowers. ✔️  **Enhanced Order Tracking:** Improved status visibility for each verification. ✔️  **Closing Verification Support:** Order closing employment verifications with refreshed data.\ \ *For more information and upgrade guidance, contact your Argyle Customer Success Manager.* # Coverage enhancements Source: https://docs.argyle.com/changelog/2026-03-23 Empeon payroll integration expands Argyle’s coverage. March 23, 2026 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) **Empeon**, a healthcare-focused payroll and HR management platform, is now available through Argyle. * Empeon can be accessed via the Item ID `item_000149182` # API enhancements Source: https://docs.argyle.com/changelog/2026-03-25 Added regular enum value to employment_type. March 25, 2026 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) We’ve added a new `regular` enum value to `employment_type` returned by the [identities endpoint](https://docs.argyle.com/api-reference/identities#schema-employment-type). * `regular` is used for ongoing employments where the employer does not provide a more specific classification beyond values such as permanent, W-2, or salaried. # Link updates Source: https://docs.argyle.com/changelog/2026-04-02 Two new account connection errors have been added. April 2, 2026 Link ![Link update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/link.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=b6ea923ffd5a9eaa46c5b7425326d751) Two new [account connection errors](https://docs.argyle.com/api-reference/account-connection-errors) have been added: * `login_cancelled_by_the_user` — The user exited Link’s login screen before submitting credentials during a multi-step login flow used by certain Items. * `known_employer_redirect` — The user was successfully redirected to their employer’s login screen after providing information that identified their employer. # Coverage enhancements Source: https://docs.argyle.com/changelog/2026-04-30 Adecco and Kelly payroll integrations expand Argyle’s coverage. April 30, 2026 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) We’ve expanded our coverage with two additional payroll integrations: * **Adecco**, a multinational staffing and recruiting firm supporting **700,000+ workers globally**, can now be accessed via the Item ID `item_000278004` * **Kelly**, a global staffing and workforce solutions provider with **400,000+ employees**, can now be accessed via the Item ID `item_000021929` # Integration enhancements Source: https://docs.argyle.com/changelog/2026-05-06 Re-verification emails in Encompass®. May 6, 2026 Integrations ![Image](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2026-05-06/email_reverifications.png?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=78e20f832592eb1ada2655c9e2f7c0ef) On May 18, Argyle will begin sending dedicated re-verification emails for Encompass® workflows, helping borrowers understand when they are being asked to refresh existing income, employment, or asset information instead of starting a new verification. The updated borrower experience includes: ✔️  **Re-verification email copy:** Borrowers are clearly asked to reverify their information so their application can move forward. Subject line, header, and subheader copy can be customized separately from initial verification emails. ✔️  **Updated action tiles and landing page guidance:** Borrowers can see what they need to reconnect, including income & employment and assets. ✔️  **Upgraded template support:** Existing Encompass flows will receive a default re-verification template automatically.\ \ The new messaging can be adjusted today in Console’s [Flow Editor](https://console.argyle.com/flows) and will be enabled by default for Encompass clients on May 18. *For questions or rollout guidance, contact your Argyle Customer Success Manager.* # Integration enhancements Source: https://docs.argyle.com/changelog/2026-05-13 Banking verification orders in Encompass® ASO. May 13, 2026 Integrations Argyle now supports Banking verification orders through Encompass® Automated Service Ordering (ASO), allowing lenders to automatically trigger asset and income verifications based on Encompass workflow rules and loan readiness conditions. This expands existing ASO support to both Payroll and Banking verification workflows. ![Image](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2026-05-13/aso_template.png?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=1622f69d91383a1f9c0f204535474e57) # Integration enhancements Source: https://docs.argyle.com/changelog/2026-05-14 Account filtering for Banking report refreshes in Encompass®. May 14, 2026 Integrations Argyle now supports account filtering for Banking report refreshes in Encompass®, allowing lenders to review and select which financial accounts are included in updated asset reports. ![Image](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2026-05-14/account_filtering.png?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=f46fa30fa0793bd96e88c0b0ff799ffd) # Link updates Source: https://docs.argyle.com/changelog/2026-05-18 New personal_data_access_not_granted account connection error. May 18, 2026 Link ![Link update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/link.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=b6ea923ffd5a9eaa46c5b7425326d751) A new [account connection error](https://docs.argyle.com/api-reference/account-connection-errors#personal_data_access_not_granted) has been added: * `personal_data_access_not_granted` — The user attempted to connect a recently created account and needs to grant data sharing permissions before retrying. # API enhancements Source: https://docs.argyle.com/changelog/2026-05-19 New fields added to bank accounts endpoints. May 19, 2026 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) On **May 28, 2026**, the following fields will be added to the [bank accounts](https://docs.argyle.com/api-reference/bank-accounts/list-all-bank-accounts) endpoints: * `real_account_number_last4` — Last four digits of the account number. * `balance` — Account balance amount. * `balance_date` — Timestamp for when the balance was recorded. * `last_updated_date` — Timestamp for when the account was last updated. * `market_segment` — Indicates whether the account is `personal` or `business`. * `last_transaction_date` — Timestamp of the latest transaction. * `oldest_transaction_date` — Timestamp of the oldest transaction. # API enhancements Source: https://docs.argyle.com/changelog/2026-05-20 New verifications.creation_failed webhook added. May 20, 2026 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) For verification orders created through third-party platforms, a new `verifications.creation_failed` webhook is now available for [direct integrations](https://docs.argyle.com/api-reference/verifications-webhooks/creation-failed) and [partner integrations](https://docs.argyle.com/api-reference/verifications-partners/verifications-creation-failed-webhook). The webhook is sent when a verification order cannot be created, making failed orders easier to detect and resolve. # Databricks added as new subprocessor. Source: https://docs.argyle.com/changelog/2026-05-21 Databricks added as new subprocessor. May 21, 2026 Platform ![Platform update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/breaking.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=2c5e1520e37851960967e9d07b5275b8) Argyle has engaged Databricks as a subprocessor in connection with data processing and storage services. Please visit our [Subprocessors](https://www.argyle.com/legal/open-payroll/subprocessors) page for more information. # Link updates Source: https://docs.argyle.com/changelog/2026-05-28 New login_gov_not_linked account connection error. May 28, 2026 Link ![Link update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/link.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=b6ea923ffd5a9eaa46c5b7425326d751) A new [account connection error](https://docs.argyle.com/api-reference/account-connection-errors#login_gov_not_linked) has been added: * `login_gov_not_linked` — The user needs to link their Login.gov account with the platform and then retry the account connection. # Coverage enhancements Source: https://docs.argyle.com/changelog/2026-06-01 Express Employment Professionals has been added to Argyle’s coverage. June 1, 2026 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) **Express Employment Professionals**, a leading staffing provider with 850+ franchise locations and 450,000+ employees, is now available through Argyle. * Express Employment Professionals can be accessed via the Item ID `item_000278124` # Integration enhancements Source: https://docs.argyle.com/changelog/2026-06-15 Import assets in Encompass®. June 15, 2026 Integrations Argyle now supports asset import from Banking VOA and VOAI reports in Encompass®, allowing lenders to review and import verified asset account data directly into the loan file. ![Image](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2026-06-15/import_assets.png?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=1e4be8ae5ae10491b5a4b63c1ba77434) # Integration enhancements Source: https://docs.argyle.com/changelog/2026-06-23 Argyle now integrates with Candor. June 23, 2026 Integrations ![Image](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2026-06-23/candor.png?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=5340ae4724518a8342abb7d62c380576) [Argyle now integrates with Candor](https://www.argyle.com/blog/argyle-now-integrates-directly-with-leading-ai-mortgage-underwriting-tool), allowing lenders to pair Argyle’s direct-source income, employment, and verification data with Candor’s AI mortgage underwriting and decisioning tools for faster, cleaner, real-time inputs to support qualifying income calculations, exception identification, and more confident loan decisions. # Coverage enhancements Source: https://docs.argyle.com/changelog/2026-07-02 Google and Microsoft have been added to Argyle’s coverage. July 2, 2026 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) Argyle now supports payroll connections for employees at **Google** and **Microsoft**. * **Google**, represented by the Item ID `item_000274752` * **Microsoft**, represented by the Item ID `item_000025785` This latest coverage expansion adds support for **800,000+ employees** and also includes major employers across retail, luxury, insurance, hospitality, healthcare, education, energy, and mortgage, including: * **Dominion Energy**, represented by the Item ID `item_000012324` * **Emerson**, represented by the Item ID `item_000013447` * **Four Seasons Hotels and Resorts**, represented by the Item ID `item_000015658` * **Gucci**, represented by the Item ID `item_000017757` * **Guaranteed Rate**, represented by the Item ID `item_000017726` * **Harvard University**, represented by the Item ID `item_000018179` * **Hilti**, represented by the Item ID `item_000018807` * **Labcorp**, represented by the Item ID `item_000022600` * **Liberty Mutual**, represented by the Item ID `item_000277166` * **Lululemon**, represented by the Item ID `item_000278228` * **Red Bull**, represented by the Item ID `item_000032648` # Enhanced government verifications Source: https://docs.argyle.com/changelog/2026-07-07 Enhanced government verifications are now available. July 7, 2026 API Link ![Image](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2026-07-07/changelog-gov-a.webp?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=2c826516d560ea032375ce63eee94364) We’re excited to share enhanced [Government verifications](https://www.argyle.com/blog/argyle-expands-consent-based-verification-platform-for-state-government-agencies), expanding Argyle’s consent-based verification platform to support income and employment verification for benefits eligibility workflows. ✔️ **Streamline eligibility reviews:** Receive `voie-government` PDF and JSON reports with configurable lookback periods that include monthly income summaries and paystub-level detail. ✔️ **Handle complex income:** Capture W-2 and gig earnings across multiple employers. ✔️ **Applicant certified:** Applicants can review and certify income and employment data and leave comments for caseworkers when they report an issue. *Learn more by visiting our [documentation](https://docs.argyle.com/api-reference/verifications-guide) or reaching out to your Argyle customer success manager.* # Integration enhancements Source: https://docs.argyle.com/changelog/2026-07-08 Banking VOAI and VOI income improvements. July 8, 2026 Integrations ![Image](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2026-07-08/banking_income_report_updates.png?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=8493a0097868ee19d726b401f6d47f7b) We have released automatic updates to our [Banking VOI and Banking VOAI reports](https://docs.argyle.com/api-reference/verifications-guide) to make income calculations more accurate and report outputs easier to review. ✔️ **Updated VOI and VOAI PDFs:** Banking VOI and Banking VOAI report PDFs have been refreshed to reflect the latest income calculation and report output updates. ✔️ **More accurate gross income calculations:** Updated tax assumptions and state-level logic improve net-to-gross estimates. ✔️ **Better income stream detection:** Payment app deposits like Venmo and Zelle, along with check/cash and wire deposits, are now evaluated more precisely so related deposits are grouped into income streams and unrelated deposits are less likely to be counted as income. ✔️ **Improved projected income logic:** Infrequent, older, low-dollar non-paycheck deposits, and identified tax refunds are less likely to be treated as active ongoing income or projected forward. ✔️ **New gross income fields in report JSON:** Banking VOI and VOAI JSON now includes `net_monthly[].gross` and `average_monthly_income_gross` on each income stream. # Consumer email notification beginning July 15, 2026. Source: https://docs.argyle.com/changelog/2026-07-09 Consumer email notification beginning July 15, 2026. July 9, 2026 Platform Beginning **July 15, 2026**, Argyle will automatically send an email notification to consumers after they successfully connect their Workday account to share their income and employment information through Argyle. The notification will be enabled by default for Workday connections. Consumers may also receive a separate notification directly from Workday. ![Image](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2026-07-09/notification.png?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=8507b27b68e37ba69ac52dea877932cc) # Coverage enhancements Source: https://docs.argyle.com/changelog/2026-07-14 ExponentHR support expands Argyle’s coverage. July 14, 2026 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) **ExponentHR**, an HR, payroll, and benefits platform serving **300,000+ employees**, is now available through Argyle. * ExponentHR can be accessed via the Item ID `item_000278120` # Coverage enhancements Source: https://docs.argyle.com/changelog/2026-07-15 Argyle expands franchise coverage. July 15, 2026 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) **Argyle has expanded its franchise coverage, with an additional 1,500+ Items added for corporate and franchise employers across 14 major brands**, including Burger King, Dairy Queen, Domino’s, Dunkin’, KFC, Little Caesars, McDonald’s, Panera Bread, Pizza Hut, Planet Fitness, Popeyes, Subway, Taco Bell, and Wendy’s. # Link updates Source: https://docs.argyle.com/changelog/2026-07-20 Improved invite and landing page guidance. July 20, 2026 Link We’ve improved invites and landing pages to provide more guidance throughout the verification process: * Email and SMS invites now list all requested verifications, including income, employment, and assets. * As users complete each verification, or if they encounter an issue, the landing page directs them to the next required step or another available option. * If users try to exit before all requested verifications are complete, they are prompted to optionally complete any remaining verifications. ![Image](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2026-07-20/link_ux.webp?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=a20c67c9e579491514d47890794b28e6) # Verification invites Source: https://docs.argyle.com/changelog/2026-08-12 Send verification invites by email or SMS. August 12, 2026 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) Verification invites can now be created through the [Verifications API](https://docs.argyle.com/api-reference/verifications-guide#invites). * After ordering one or more verifications, [create a session](https://docs.argyle.com/api-reference/verifications/create-a-session) with `type: invite` and provide the user’s email address, phone number, or both. # Custom sending domain Source: https://docs.argyle.com/changelog/2026-08-19 Send emails from your own domain. August 19, 2026 Console ![Console update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/console.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=8902f7b196ea043075ebcbb91c725787) Emails sent to consumers through Argyle can now come from an address on your own domain, such as `verifications@yourcompany.com`, instead of an Argyle email address. *Custom sender domains are currently available on request. Contact your Argyle Customer Success Manager to enable the feature, then follow the setup guide to configure it in Console.* # Coverage enhancements Source: https://docs.argyle.com/changelog/2026-08-24 Skyward support expands Argyle’s coverage. August 24, 2026 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) **Skyward**, one of the largest education platforms in the U.S. and a provider of K–12 HR and payroll software, is now available through Argyle, expanding coverage to more than **1,200 organizations**, including hundreds of school districts and municipalities across the country. * Skyward can be accessed via the Item ID `item_000283932` # New connection notifications Source: https://docs.argyle.com/changelog/2026-09-09 Get notified when users add connections after a verification. September 9, 2026 API Integrations ![Image](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2026-09-09/new_payroll_data.png?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=2430114d4dc3a62026f55cbd9dcee667) **Monitor new connections after verifications** * A new `verifications.connection_added` webhook is now available for [clients](https://docs.argyle.com/api-reference/verifications-webhooks/connection-added) and [partners](https://docs.argyle.com/api-reference/partners-webhooks/connection-added). It is sent when a user adds a new payroll account or connects a new banking institution after a verification reaches `COMPLETED` or `CANCELLED`. * For verifications initiated through Encompass or Consumer Connect, an email notification is also sent when a new connection is added. * In Encompass, a one-click option to refresh the verification with the newly connected data is shown. **Track additional account data availability** * The optional `data.resource.availability` object in [account webhook](https://docs.argyle.com/api-reference/accounts-webhooks/added) payloads now includes `shifts` and `user_uploads` for `accounts.added`, `accounts.updated`, `accounts.connected`, and `accounts.failed`. # Link updates Source: https://docs.argyle.com/changelog/2026-09-15 Real-time feedback on document uploads. September 15, 2026 Link ![Real-time feedback on document uploads](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2026-09-15/doc-upload_feedback.webp?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=0b812bfdf10059c03b3e8a5871aa068f) You can now enable two checks for document uploads via Link: * **Incorrect document type** — If a user uploads a different document type from the one requested, Link rejects the upload and directs them to submit the correct type. This check is available for paystub, W-2, and 1099 requests. * **Paystub recency** — Set how recent a paystub must be (30 days by default). Older paystubs are rejected, and users are directed to submit a more recent one. Both checks work with PDFs and images, and can be enabled for individual Link flows under **Document upload settings** in Console’s [Flow Editor](https://console.argyle.com/flows). # Broker-branded invites for wholesale mortgage Source: https://docs.argyle.com/changelog/2026-09-16 September 16, 2026 API Link Integrations Wholesale lenders can now send broker-branded borrower invites through [Argyle’s Verifications API](https://docs.argyle.com/verifications/wholesale-mortgage) and [Encompass® TPO Connect](https://docs.argyle.com/integrations/pos-los/encompass/tpo-connect). * **Broker-branded communication:** Email and SMS invites identify the broker, with contact details available in the email and landing page. * **API support:** Add broker details once per borrower using `external_metadata.broker`. The default wholesale flow provides broker-specific messaging without creating a separate flow for every broker. * **TPO Connect ordering:** Brokers can order payroll, asset, and document-based income verifications using the lender’s Argyle setup. Encompass Automated Service Ordering (ASO) also supports initial orders on broker-originated loans. ![Broker-branded email and SMS invites](https://mintcdn.com/argyle/PXFuBtNZSrQ9sKgY/images/changelog/2026-09-16/wholesale-broker-invites.webp?fit=max\&auto=format\&n=PXFuBtNZSrQ9sKgY\&q=85\&s=21ff46c55f3c229b4e668a3d1dc86ffb) # Coverage enhancements Source: https://docs.argyle.com/changelog/2026-09-28 OnPay support expands Argyle’s coverage. September 28, 2026 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) **OnPay**, a payroll and HR platform for small and medium-sized businesses, is now available, expanding Argyle’s coverage by **300,000+ employees**. * OnPay can be accessed via the Item ID `item_000028957` # API enhancements Source: https://docs.argyle.com/changelog/2026-10-01 1099 document authenticity is now available. October 1, 2026 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) Argyle’s existing OCR support for [1099 document uploads](https://docs.argyle.com/workflows/document-processing) now includes [authenticity analysis](https://docs.argyle.com/integrations/ocr/ocrolus) for 1099-MISC, 1099-K, 1099-R, and SSA-1099 forms. Authenticity scores and detailed authenticity information are available alongside existing OCR data. Results can be retrieved through the API or viewed in Console, including authenticity summaries. The existing `user_uploads.ocr_authenticity` webhook also provides notifications when results are available. # Updates to Customer Terms and consumer documents Source: https://docs.argyle.com/changelog/2026-10-01-legal Updates to Customer Terms and consumer documents October 1, 2026 Platform ![Platform update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/breaking.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=2c5e1520e37851960967e9d07b5275b8) We updated the Open Payroll Customer Terms and the documents they incorporate — the Data Protection Addendum, Support Policy, Service Levels and Subprocessor List — to cover upcoming releases for tax documents and employer outreach, to address customers that are consumer reporting agencies, and to describe how fees work for requests submitted through or delivered into third-party platforms, point-of-sale systems and loan origination systems. We also updated our consumer-facing documents, including the Consumer Terms, Privacy Notice, Cookie Policy and Messaging Policy, and retired the separate CCPA Notice, whose state-law disclosures now sit within the Privacy Notice. The updated versions are dated October 1, 2026 and are available at [argyle.com/legal](http://argyle.com/legal). # Integration enhancements Source: https://docs.argyle.com/changelog/2026-10-13 Income identification improvements in Banking VOI and VOAI reports. October 13, 2026 Integrations ![Income identification improvements in Banking VOI and VOAI reports](https://mintcdn.com/argyle/LQAZD5FLOF2MS7fD/images/changelog/2026-10-13/changelog-cover-banking.png?fit=max\&auto=format\&n=LQAZD5FLOF2MS7fD\&q=85\&s=d4f26488fbe6e8c59363f08f90884030) **Expected release: November 3, 2026** We’re updating our [Banking VOI and Banking VOAI reports](https://docs.argyle.com/verifications/reports-and-source-documents#example-reports) to better distinguish income from personal transfers, refunds, and other non-income deposits. ✔️ **Refined income confidence:** P2P, cash, and check deposits are evaluated using payer information and deposit patterns. **Deposits with limited supporting information are less likely to receive High confidence**, while recognizable paycheck and gig-platform income can remain High. ✔️ **Improved non-income filtering:** Better recognition of refunds, reimbursements, loan disbursements, and earned-wage advances reduces the likelihood that these deposits are counted as income. ✔️ **Clearer income stream names:** Cash and ATM deposit streams with an unidentified payer use more descriptive names that include the deposit category, making them easier to review. # Verifications in Console Source: https://docs.argyle.com/changelog/2026-10-21 Order payroll and banking verifications in Console. October 21, 2026 Console ![Order payroll and banking verifications in Console.](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/console-verifications.gif) The new [**Verifications**](https://console.argyle.com/verifications) page in Console brings payroll, banking, and Doc VOI results together for mortgage teams. * **Order payroll and banking verifications** from a single form, with income, employment, and asset verification options. * **Track orders by borrower or verification** with Consumer and Verification views, plus search and filters for status, report type, data source, and more. * **Review reports and supporting documents** for each borrower, including results from verifications ordered through our API, Encompass, or other partner systems. See our [Console Verifications guide](https://docs.argyle.com/console/verifications) for more details. # Link updates Source: https://docs.argyle.com/changelog/2026-10-26 Spanish language support on landing pages. October 26, 2026 Link ![Spanish language support on landing pages.](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/changelog-spanish-landing-page.png) We’ve expanded Spanish language support to Argyle landing pages: * Applicants can now switch between English and Spanish using a language toggle. The landing page automatically opens in Spanish when the browser is set to Spanish. * The selected language carries through to payroll and banking connections, with no need to select it again. *No configuration is required.* # Introducing Direct VOIE+ Source: https://docs.argyle.com/changelog/2026-10-27 Freddie Mac's monthly income calculations, alongside direct-source payroll data. October 27, 2026 API Console Integrations ![Freddie Mac's monthly income calculations, alongside direct-source payroll data.](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/direct-voie-plus-changelog.png) Direct VOIE+ is now available, adding monthly income calculations from Freddie Mac’s AIM Check API alongside the payroll data applicants share through Argyle. * **Assess financing options sooner:** Use Freddie Mac’s monthly income calculations to help structure loans earlier in the origination process. * **Reduce underwriting rework:** Spot differences between initial income estimates and Freddie Mac’s calculations before the file reaches underwriting. * **Keep your existing workflow:** Use Direct VOIE+ across Console, API, and Encompass without changing how you order verifications. *Contact your Argyle Customer Success Manager to enable Direct VOIE+ for your organization.* # Console enhancements Source: https://docs.argyle.com/changelog/2026-10-27-sandbox Create test users for income and employment scenarios. October 27, 2026 Console ![Create test users for income and employment scenarios.](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/custom-sandbox-changelog.png) You can now create custom Sandbox test users when previewing embedded flows in [Console Flows](https://console.argyle.com/flows). With **Sandbox mode** enabled, describe the income or employment scenario you want to test under **Create custom user** when testing embedded Flows. You’ll receive a username, test password, and guidance on which employer or payroll provider to select in Sandbox. Custom users are saved to your organization, so your team can reuse the same scenarios during testing. # API enhancements Source: https://docs.argyle.com/changelog/2026-10-28 Partner details added to verifications endpoints and webhooks. October 28, 2026 API ![API update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/api.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=1537fc09ccdfb211eeafbc1178e91f0b) A new `partner` object has been added to the [verifications endpoints](https://docs.argyle.com/api-reference/verifications/list-all-verifications) and verification webhook payloads for verifications ordered through a partner. It contains the partner’s `id` and includes its `name` when available. This update applies to client and partner integrations. Existing `channel` values are unchanged. # Link token renewal Source: https://docs.argyle.com/changelog/2026-10-29 Refreshing a Link session will require a token for the same user. October 29, 2026 Link API Breaking ![Link update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/link.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=b6ea923ffd5a9eaa46c5b7425326d751) Starting **November 30, 2026**, a [user token](https://docs.argyle.com/link/user-tokens) will no longer be usable to refresh a different user’s Link session. Using a token for a different user will return an `invalid_user_token` error. When a user token expires (or five minutes before expiration on Web), the `onTokenExpired` [callback](https://docs.argyle.com/link/reference/callbacks#ontokenexpired) is triggered. It provides an update function for replacing the current session’s token without closing and re-initializing Link. Alternatively, you can create a new user token for existing users through the API’s [create a user token endpoint](https://docs.argyle.com/api-reference/user-tokens/create-a-user-token) and use the returned token to initialize a new Link session. When refreshing a token, use the existing user. *If your token refresh flow already uses the same user, no changes are required.* # Coverage enhancements Source: https://docs.argyle.com/changelog/2026-11-05 HCMToGo support expands Argyle’s coverage. November 5, 2026 Coverage ![Coverage update illustration](https://mintcdn.com/argyle/spW0uZwUC4bDyMgL/images/changelog-generic/coverage.png?fit=max\&auto=format\&n=spW0uZwUC4bDyMgL\&q=85\&s=53b4b0b8bb5e1123d3004daef29b3c2c) **HCMToGo**, the mobile app employees use to access the UKG Ready payroll and HR platform through partner and white-label providers, is now supported, expanding Argyle’s coverage to approximately **34,000 employers** across PEOs, payroll bureaus, and reseller networks. A new **UKG Ready** connection option also allows users to connect through the platform directly. * HCMToGo can be accessed via the Item ID `item_000149212` * UKG Ready can be accessed via the Item ID `item_000289539` # Archive Source: https://docs.argyle.com/changelog/archive Browse all Argyle product updates and announcements. Years [2026](#2026) [2025](#2025) [2024](#2024) [2023](#2023) [2022](#2022) [2021](#2021) [2020](#2020) [2019](#2019) ## 2026 November 5 Coverage enhancements HCMToGo support expands Argyle’s coverage. [Open](/changelog/2026-11-05) October 29 Link token renewal Refreshing a Link session will require a token for the same user. [Open](/changelog/2026-10-29) October 28 API enhancements Partner details added to verifications endpoints and webhooks. [Open](/changelog/2026-10-28) October 27 Introducing Direct VOIE+ Freddie Mac's monthly income calculations, alongside direct-source payroll data. [Open](/changelog/2026-10-27) October 27 Console enhancements Create test users for income and employment scenarios. [Open](/changelog/2026-10-27-sandbox) October 26 Link updates Spanish language support on landing pages. [Open](/changelog/2026-10-26) October 21 Verifications in Console Order payroll and banking verifications in Console. [Open](/changelog/2026-10-21) October 13 Integration enhancements Income identification improvements in Banking VOI and VOAI reports. [Open](/changelog/2026-10-13) October 1 API enhancements 1099 document authenticity is now available. [Open](/changelog/2026-10-01) October 1 Updates to Customer Terms and consumer documents Updates to Customer Terms and consumer documents [Open](/changelog/2026-10-01-legal) September 28 Coverage enhancements OnPay support expands Argyle’s coverage. [Open](/changelog/2026-09-28) September 16 Broker-branded invites for wholesale mortgage Wholesale lenders can now send broker-branded borrower invites through Argyle’s Verifications API and Encompass® TPO Connect. [Open](/changelog/2026-09-16) September 15 Link updates Real-time feedback on document uploads. [Open](/changelog/2026-09-15) September 9 New connection notifications Get notified when users add connections after a verification. [Open](/changelog/2026-09-09) August 24 Coverage enhancements Skyward support expands Argyle’s coverage. [Open](/changelog/2026-08-24) August 19 Custom sending domain Send emails from your own domain. [Open](/changelog/2026-08-19) August 12 Verification invites Send verification invites by email or SMS. [Open](/changelog/2026-08-12) July 20 Link updates Improved invite and landing page guidance. [Open](/changelog/2026-07-20) July 15 Coverage enhancements Franchise coverage expands with 1,500+ additional Items. [Open](/changelog/2026-07-15) July 14 Coverage enhancements ExponentHR support expands Argyle’s coverage. [Open](/changelog/2026-07-14) July 9 Consumer email notification beginning July 15, 2026. Consumer email notification beginning July 15, 2026. [Open](/changelog/2026-07-09) July 8 Integration enhancements Banking VOAI and VOI income improvements. [Open](/changelog/2026-07-08) July 7 Enhanced government verifications Enhanced government verifications are now available. [Open](/changelog/2026-07-07) July 2 Coverage enhancements Google and Microsoft have been added to Argyle’s coverage. [Open](/changelog/2026-07-02) June 23 Integration enhancements Argyle now integrates with Candor. [Open](/changelog/2026-06-23) June 15 Integration enhancements Import assets in Encompass®. [Open](/changelog/2026-06-15) June 1 Coverage enhancements Express Employment Professionals has been added to Argyle’s coverage. [Open](/changelog/2026-06-01) May 28 Link updates New login\_gov\_not\_linked account connection error. [Open](/changelog/2026-05-28) May 21 Databricks added as new subprocessor. Databricks added as new subprocessor. [Open](/changelog/2026-05-21) May 20 API enhancements New verifications.creation\_failed webhook added. [Open](/changelog/2026-05-20) May 19 API enhancements New fields added to bank accounts endpoints. [Open](/changelog/2026-05-19) May 18 Link updates New personal\_data\_access\_not\_granted account connection error. [Open](/changelog/2026-05-18) May 14 Integration enhancements Account filtering for Banking report refreshes in Encompass®. [Open](/changelog/2026-05-14) May 13 Integration enhancements Banking verification orders in Encompass® ASO. [Open](/changelog/2026-05-13) May 6 Integration enhancements Re-verification emails in Encompass®. [Open](/changelog/2026-05-06) April 30 Coverage enhancements Adecco and Kelly payroll integrations expand Argyle’s coverage. [Open](/changelog/2026-04-30) April 2 Link updates Two new account connection errors have been added. [Open](/changelog/2026-04-02) March 25 API enhancements Added regular enum value to employment\_type. [Open](/changelog/2026-03-25) March 23 Coverage enhancements Empeon payroll integration expands Argyle’s coverage. [Open](/changelog/2026-03-23) March 16 Integration enhancements Introducing Argyle’s 3-in-1 Verification Suite in Encompass®. [Open](/changelog/2026-03-16) March 3 Link updates New temporary\_credentials account connection error. [Open](/changelog/2026-03-03) February 27 Coverage enhancements Argyle has achieved 80%+ verified coverage of the Fortune 1000. [Open](/changelog/2026-02-27) February 25 Link updates Expanded Spanish language support is now available in Link. [Open](/changelog/2026-02-25) February 24 Updates to Open Banking Customer Terms. Updates to Open Banking Customer Terms. [Open](/changelog/2026-02-24) February 23 Coverage enhancements Waffle House has been added to Argyle’s coverage. [Open](/changelog/2026-02-23) February 20 Mintlify added as new subprocessor. Mintlify added as new subprocessor. [Open](/changelog/2026-02-20) February 12 Link 5.18 Document uploads can be restricted to PDF only. [Open](/changelog/2026-02-12) February 10 Coverage enhancements Viventium payroll integration expands Argyle’s coverage. [Open](/changelog/2026-02-10) January 20 Coverage enhancements Patriot payroll integration expands Argyle’s coverage. [Open](/changelog/2026-01-20) January 13 Coverage enhancements Argyle’s coverage is expanding rapidly, with exciting new improvements. [Open](/changelog/2026-01-13) ## 2025 December 17 Integration enhancements Completion emails sent for re-verifications in Encompass. [Open](/changelog/2025-12-17) December 11 Updates to Customer Terms and DBA. Updates to Customer Terms and DBA. [Open](/changelog/2025-12-11) December 5 Coverage enhancements Argyle's coverage expands by 200,000+ employees. [Open](/changelog/2025-12-05) December 4 API enhancements API timestamp format will be standardized January 5, 2026. [Open](/changelog/2025-12-04) November 20 API enhancements Rewards program information for gig employments has been added. [Open](/changelog/2025-11-20) October 31 Nightfall added as new subprocessor. Nightfall added as new subprocessor. [Open](/changelog/2025-10-31) October 22 API enhancements Generating billing receipts via API is now available. [Open](/changelog/2025-10-22) October 7 Document verifications Income verifications from uploaded documents. [Open](/changelog/2025-10-07) October 1 Link updates New auth\_method\_temporarily\_unavailable account connection error. [Open](/changelog/2025-10-01) September 24 Coverage enhancements Argyle's coverage expands by 600,000+ employees. [Open](/changelog/2025-09-24) September 22 API enhancements Invite delivery information has been added. [Open](/changelog/2025-09-22) July 2 Coverage enhancements Expanded Microsoft single sign-on (SSO) support. [Open](/changelog/2025-07-02) June 27 API enhancements Uploading documents via the API is now available. [Open](/changelog/2025-06-27) June 16 Multi-path verifications Verify with payroll, banking, and document uploads. [Open](/changelog/2025-06-16) June 6 Argyle has updated its legal terms. Argyle has updated its legal terms. [Open](/changelog/2025-06-06) June 3 Link updates Spanish, Chinese, and Russian languages now supported in Link. [Open](/changelog/2025-06-03) June 2 New report designs Updated verification report designs and API endpoints. [Open](/changelog/2025-06-02) May 30 System upgrades Reports service upgrades: June 2, 2:00–5:00 AM EST [Open](/changelog/2025-05-30) May 29 Link 5.15 Returning user and document upload improvements. Link pre-filling on mobile. [Open](/changelog/2025-05-29) May 27 Link updates Three new account connection errors have been added. [Open](/changelog/2025-05-27) May 19 Link updates New insufficient\_account\_data account connection error. [Open](/changelog/2025-05-19) April 14 Coverage enhancements Argyle has achieved 75%+ verified coverage of the Fortune 1000. [Open](/changelog/2025-04-14) April 9 API enhancements item\_id added to gigs webhooks. [Open](/changelog/2025-04-09) April 2 Link 5.14 Connection status indicators, duplicate account prevention, and MFA improvements. [Open](/changelog/2025-04-02) March 25 API enhancements Pre-fill user contact information in Link and across Argyle’s integrations. [Open](/changelog/2025-03-25) March 10 Coverage enhancements Argyle’s new gig integration to inDrive. [Open](/changelog/2025-03-10) March 5 Integration enhancements Major improvements to Argyle’s existing Encompass® integration. [Open](/changelog/2025-03-05) March 3 Link updates New multi\_driver\_account account connection error. [Open](/changelog/2025-03-03) February 28 Link updates Easier to navigate 2-column home screen design. [Open](/changelog/2025-02-28) February 26 Coverage enhancements Significant growth in Argyle’s coverage over the last year. [Open](/changelog/2025-02-26) February 19 Link 5.13 Rich text multi-factor authentication and other improvements. [Open](/changelog/2025-02-19) February 17 API enhancements Employer Search: A new API endpoint that can power in-app employer searches of Argyle’s coverage. [Open](/changelog/2025-02-17) February 13 API enhancements Reports webhooks: Get notified when new reports can be generated. [Open](/changelog/2025-02-13) February 10 Integration enhancements Argyle is now embedded within nCino, plus enhanced interoperability with Encompass. [Open](/changelog/2025-02-10) February 5 Link updates Excluded Items now appear in search. [Open](/changelog/2025-02-05) January 7 API enhancements Employments: A new way to filter identities, paystubs, and payroll documents. [Open](/changelog/2025-01-07) ## 2024 December 18 Link 5.12 Duplicate account prevention improvements. [Open](/changelog/2024-12-18) December 2 Link 5.11 Improvements to the login experience. [Open](/changelog/2024-12-02) November 22 Coverage enhancements Significant growth in Argyle’s single sign-on (SSO) support. [Open](/changelog/2024-11-22) November 19 API enhancements cancel added as a new possible value for gig task events. [Open](/changelog/2024-11-19) November 15 API breaking changes Legacy API v1 will be retired on March 31, 2025. [Open](/changelog/2024-11-15) November 6 Link 5.10 Duplicate account prevention and connection improvements. [Open](/changelog/2024-11-06) November 4 Integration enhancements Verification not completed email alerts and automated employer matching in Encompass. [Open](/changelog/2024-11-04) October 29 Link updates New session\_limit\_reached account connection error has been added. [Open](/changelog/2024-10-29) October 25 Integration enhancements Argyle is now fully integrated with nCino. [Open](/changelog/2024-10-25) October 18 Coverage enhancements Argyle's government sector coverage expands by 250,000 employees. [Open](/changelog/2024-10-18) October 7 Coverage enhancements Argyle's coverage expands by 500,000+ employees. [Open](/changelog/2024-10-07) October 2 Link 5.9 User flow and navigation improvements. [Open](/changelog/2024-10-02) September 16 Link updates Connect more employers button added to Link's login success screen. [Open](/changelog/2024-09-16) September 3 Coverage enhancements Argyle's coverage expands by 450,000+ employees. [Open](/changelog/2024-09-03) August 30 Link updates Three new account connection errors have been added. [Open](/changelog/2024-08-30) August 29 API enhancements military and benefits added as new possible values for employment\_type [Open](/changelog/2024-08-29) August 28 API enhancements Re-introducing Argyle's user forms endpoint and webhooks. [Open](/changelog/2024-08-28) August 22 API enhancements API secret obfuscation for improved security. [Open](/changelog/2024-08-22) August 20 API enhancements Automate employer search inputs in your applications. [Open](/changelog/2024-08-20) August 14 API enhancements Quality of life upgrades to Argyle's invites endpoint. [Open](/changelog/2024-08-14) August 8 Link updates New feature for payroll accounts with multiple employments coming soon. [Open](/changelog/2024-08-08) August 1 Link 5.8 Payroll connection experience improvements. [Open](/changelog/2024-08-01) July 31 Coverage enhancements Argyle's healthcare sector coverage expands by 200,000+ employees. [Open](/changelog/2024-07-31) July 30 Authenticity Summary in Console Authenticity information for uploaded documents. [Open](/changelog/2024-07-30) July 18 Link updates New credentials\_managed\_by\_organization account connection error. [Open](/changelog/2024-07-18) July 9 API enhancements Argyle's new endpoint for manually uploaded documents. [Open](/changelog/2024-07-09) July 8 Employer match Match users with their employers for a streamlined connection process. [Open](/changelog/2024-07-08) July 5 Link updates New full\_auth\_required account connection error. [Open](/changelog/2024-07-05) July 3 API enhancements New last\_sent\_at property added for better webhook management. [Open](/changelog/2024-07-03) June 28 Coverage enhancements Argyle has achieved 70% verified coverage of the Fortune 500. [Open](/changelog/2024-06-28) May 30 URL modifications An enhanced way to share direct links to Argyle's payroll connection experience. [Open](/changelog/2024-05-30) May 29 Coverage enhancements Argyle's coverage expands by 450,000+ employees. [Open](/changelog/2024-05-29) May 21 API enhancements Two new fields added to users.fully\_synced webhook. [Open](/changelog/2024-05-21) May 15 Manage your teams with Groups Today we're introducing a new Console setting: Groups. [Open](/changelog/2024-05-15) May 8 Coverage enhancements Education coverage expands by 600 employers. [Open](/changelog/2024-05-08) May 1 API enhancements Authenticity information available for uploaded documents. [Open](/changelog/2024-05-01) April 17 Link 5.7 Major enhancements to document uploads. [Open](/changelog/2024-04-17) April 2 Automated reminders Today we're introducing a new Console setting — Automated reminders. [Open](/changelog/2024-04-02) March 8 API breaking changes file\_url field will require basic authentication headers on April 8, 2024. [Open](/changelog/2024-03-08) March 5 API enhancements The /item-notifications endpoint has been deprecated. [Open](/changelog/2024-03-05) February 29 API enhancements original\_hire\_date added to the identities endpoint. [Open](/changelog/2024-02-29) February 14 Link 5.6 Redesigned connection success and reconnection screens. [Open](/changelog/2024-02-14) January 18 API enhancements Additional fields returned when retrieving reports in JSON. [Open](/changelog/2024-01-18) ## 2023 December 22 Coverage enhancements Historical gigs data adjustment on January 15, 2024. [Open](/changelog/2023-12-22) December 18 HubSpot added as new subprocessor. HubSpot added as new subprocessor. [Open](/changelog/2023-12-18) December 13 Link 5.5 Payroll providers sorted by popularity. [Open](/changelog/2023-12-13) December 4 API breaking changes Gross pay type consolidation on January 3, 2024. [Open](/changelog/2023-12-04) November 29 API enhancements New daily possible value added for base\_pay.period [Open](/changelog/2023-11-29) November 15 Shareable URLs and multiple Invite Templates are now available. Today we're releasing some game-changing new features to Console Flows. [Open](/changelog/2023-11-15) November 14 Link updates Username and password recovery with identifying information. [Open](/changelog/2023-11-14) November 13 API breaking changes Weak cipher suite are being removed on December 13, 2023. [Open](/changelog/2023-11-13) November 7 API enhancements Gigs endpoint now returns additional data fields. [Open](/changelog/2023-11-07) November 3 Thena added as new subprocessor. Thena added as new subprocessor. [Open](/changelog/2023-11-03) October 31 Integration enhancements Argyle is now available within Encompass. [Open](/changelog/2023-10-31) October 18 Link 5.4 More prominent Login help button and image previews. [Open](/changelog/2023-10-18) September 27 API breaking changes Renamed Item fields [Open](/changelog/2023-09-27) September 18 API enhancements Easier change tracking for supported data fields and deposit switch capabilities. [Open](/changelog/2023-09-18) September 9 Link 5.3 Improved returning user experience. [Open](/changelog/2023-09-09) September 8 Console enhancements Faster report generation times. [Open](/changelog/2023-09-08) August 1 Console enhancements Invite experience improvements have arrived. [Open](/changelog/2023-08-01) July 12 Link 5.2 Payroll connection experience improvements. [Open](/changelog/2023-07-12) July 1 Console enhancements Console's Connections page has been redesigned. [Open](/changelog/2023-07-01) June 26 Coverage enhancements Last week Argyle launched a new integration to Heartland. [Open](/changelog/2023-06-26) June 15 API enhancements New filters for Items are now supported. [Open](/changelog/2023-06-15) June 14 Coverage enhancements Last week Argyle launched a new integration to Curri. [Open](/changelog/2023-06-14) June 12 API enhancements ongoing\_refresh enhancements [Open](/changelog/2023-06-12) June 6 Console enhancements Payroll connection experience customizations. [Open](/changelog/2023-06-06) June 2 API enhancements New external\_id user field introduced. [Open](/changelog/2023-06-02) May 25 Ocrolus added as new subprocessor. Ocrolus added as new subprocessor. [Open](/changelog/2023-05-25) May 17 Link 5.1 Customizable home screen tabs. [Open](/changelog/2023-05-17) May 16 API enhancements New mapping\_status Item fields introduced. [Open](/changelog/2023-05-16) May 11 Coverage enhancements Last week Argyle launched a new integration to PrimePay. [Open](/changelog/2023-05-11) May 10 API enhancements Earliest and most recent payout dates added to income totals endpoint. [Open](/changelog/2023-05-10) May 9 API enhancements New shifts endpoint introduced. [Open](/changelog/2023-05-09) May 8 API enhancements Items webhooks are now available. [Open](/changelog/2023-05-08) May 1 Console enhancements Connections page improvements. [Open](/changelog/2023-05-01) April 26 API enhancements Retrieve data refresh frequency. [Open](/changelog/2023-04-26) April 15 Link updates Flutter SDK is now available. [Open](/changelog/2023-04-15) April 14 API enhancements Retrieve Argyle verification reports in JSON. [Open](/changelog/2023-04-14) April 6 API v2 An optimized, more secure API that performs. [Open](/changelog/2023-04-06) April 5 Link 5.0 The most intuitive payroll connection experience ever. [Open](/changelog/2023-04-05) April 4 Console 3.0 Improved navigation, simpler terminology, and easier-to-access features. [Open](/changelog/2023-04-04) March 12 Coverage enhancements Last week Argyle launched a new integration to Care.com. [Open](/changelog/2023-03-12) March 6 API enhancements Webhook performance enhancements. [Open](/changelog/2023-03-06) February 22 Coverage enhancements Last week Argyle launched a new integration to State of New York. [Open](/changelog/2023-02-22) February 21 Coverage enhancements More multi-factor authentication (MFA) and single sign-on (SSO) methods supported. [Open](/changelog/2023-02-21) February 1 Coverage enhancements Symantec VIP multi-factor authentication now supported. [Open](/changelog/2023-02-01) January 31 Console enhancements Redesigned user profiles in Console. [Open](/changelog/2023-01-31) January 23 API enhancements Two additional IP addresses for webhooks. [Open](/changelog/2023-01-23) January 10 Coverage enhancements Digital paystubs are now available. [Open](/changelog/2023-01-10) ## 2022 December 31 Console enhancements How invites are sent has been redesigned. [Open](/changelog/2022-12-31) December 20 Coverage enhancements Last week Argyle launched a new integration to PepsiCo. [Open](/changelog/2022-12-20) December 19 API enhancements 1099 documents now supported by Ocrolus OCR. [Open](/changelog/2022-12-19) December 16 API enhancements Changes to user invites object. [Open](/changelog/2022-12-16) December 15 API enhancements New currency field added to pay allocations endpoint. [Open](/changelog/2022-12-15) December 12 Coverage enhancements Additional integrations have been added to Argyle's coverage. [Open](/changelog/2022-12-12) December 6 API enhancements Reports can now be generated via Argyle's API. [Open](/changelog/2022-12-06) November 30 Console enhancements Filter conversion by Link Flow in Console's Dashboard. [Open](/changelog/2022-11-30) November 28 Coverage enhancements Instawork integration now supports deposit switching. [Open](/changelog/2022-11-28) November 22 Link 4.7 Deposit switch enhancements. [Open](/changelog/2022-11-22) October 31 Console enhancements Sign up to Console with your Microsoft account! [Open](/changelog/2022-10-31) October 28 API enhancements New documents endpoint filters. [Open](/changelog/2022-10-28) October 17 Coverage enhancements Additional integrations have been added to Argyle's coverage. [Open](/changelog/2022-10-17) October 6 API enhancements New users.fully\_synced webhook. [Open](/changelog/2022-10-06) September 30 Console enhancements UI Toolkit in Figma for Link screens is now available. [Open](/changelog/2022-09-30) September 27 API enhancements New data fields for employee breaks added. [Open](/changelog/2022-09-27) September 26 Coverage enhancements Additional integrations have been added to Argyle's coverage. [Open](/changelog/2022-09-26) September 20 API enhancements New Income Totals endpoint. [Open](/changelog/2022-09-20) September 19 Coverage enhancements Additional integrations have been added to Argyle's coverage. [Open](/changelog/2022-09-19) September 15 API enhancements retired added as new status property for employments. [Open](/changelog/2022-09-15) September 12 Link 4.6 Images files are now supported by document upload. [Open](/changelog/2022-09-12) September 9 Link updates Shorter expiration time for user tokens. [Open](/changelog/2022-09-09) September 2 Console enhancements Sign up to Console with your Google account! [Open](/changelog/2022-09-02) September 1 API enhancements New activities data fields for accepting and cancelling. [Open](/changelog/2022-09-01) August 29 Coverage enhancements Additional integrations have been added to Argyle's coverage. [Open](/changelog/2022-08-29) August 24 Link 4.5 Login screen redesign. [Open](/changelog/2022-08-24) August 16 API enhancements Error testing in Sandbox. [Open](/changelog/2022-08-16) August 15 Coverage enhancements Additional integrations have been added to Argyle's coverage. [Open](/changelog/2022-08-15) August 11 API enhancements Unit for deposit switches to cards. [Open](/changelog/2022-08-11) August 9 API enhancements New payout field for net pay distributions. [Open](/changelog/2022-08-09) August 4 Link 4.4 Intro screen customizations and end of Link 3.0 support. [Open](/changelog/2022-08-04) August 3 API enhancements New data fields added to payouts endpoint. [Open](/changelog/2022-08-03) August 2 Coverage enhancements Additional integrations have been added to Argyle's coverage. [Open](/changelog/2022-08-02) August 1 Console enhancements New conversion dashboard and duplicating Link customizations. [Open](/changelog/2022-08-01) July 20 Link updates Removing bank accounts via deposit switches introduced. [Open](/changelog/2022-07-20) July 13 Link 4.3 New callbacks and login screen improvements. [Open](/changelog/2022-07-13) July 8 Console enhancements New activity dashboard and billing enhancements. [Open](/changelog/2022-07-08) June 30 Coverage enhancements Additional integrations have been added to Argyle's coverage. [Open](/changelog/2022-06-30) June 28 API enhancements Two new document OCR webhooks have been added. [Open](/changelog/2022-06-28) June 22 API breaking changes Removal of the finances endpoint. [Open](/changelog/2022-06-22) June 21 API enhancements Two new properties added to the Link Items endpoint. [Open](/changelog/2022-06-16) June 16 API enhancements Field and type validations for deposit switches. [Open](/changelog/2022-06-21) June 15 Link 4.2 Document upload and form fallback improvements. [Open](/changelog/2022-06-15) June 7 API enhancements New fields added to Pay Distribution Updated webhook. [Open](/changelog/2022-06-07) June 6 Coverage enhancements Additional integrations have been added to Argyle's coverage. [Open](/changelog/2022-06-06) May 26 API enhancements Deposit switch enhancements. [Open](/changelog/2022-05-26) May 24 Coverage enhancements Additional integrations have been added to Argyle's coverage. [Open](/changelog/2022-05-24) May 20 API enhancements New fields added to pay allocations endpoint. [Open](/changelog/2022-05-20) May 9 Coverage enhancements Additional integrations have been added to Argyle's coverage. [Open](/changelog/2022-05-09) May 5 API enhancements Deposit switch (card) updates [Open](/changelog/2022-05-05) May 4 Link 4.1 Developer testing and deposit switch error improvements. [Open](/changelog/2022-05-04) April 25 Coverage enhancements Additional integration has been added to Argyle's coverage. [Open](/changelog/2022-04-25) April 21 API enhancements New property returned by the Pay Distribution Updated webhook. [Open](/changelog/2022-04-21) April 19 Coverage enhancements Data availability speed enhancements to Argyle's integrations. [Open](/changelog/2022-04-19) April 13 Link updates Deposit switches to debit cards are now supported. [Open](/changelog/2022-04-13) April 11 Coverage enhancements Additional integrations have been added to Argyle's coverage. [Open](/changelog/2022-04-11) April 7 Link 4.0 Argyle has released Link 4.0, an updated version of Link that includes: A new intro screen experience that is customizable through Flows in Console A modern, simple, and breathable search screen layout An improved login experience Simplified multi-factor authentication (MFA) experiences Clearer error messaging [Open](/changelog/2022-04-07) April 3 Coverage enhancements Additional integrations have been added to Argyle's coverage. [Open](/changelog/2022-04-03) April 2 Console enhancements Argyle free trials are now available. [Open](/changelog/2022-04-02) April 1 API enhancements file\_url URL active times have been reduced to 15 minutes. [Open](/changelog/2022-04-01) March 31 API breaking changes Webhooks will be sent from an additional IP address. [Open](/changelog/2022-03-31) March 28 Link 4.0 coming soon On April 7, 2022 a new Link 4.0 version will be released, focusing on visual enhancements. [Open](/changelog/2022-03-28) March 23 Coverage enhancements Additional integrations have been added to Argyle's coverage. [Open](/changelog/2022-03-23) March 15 Console enhancements Quality of life enhancements to Console. [Open](/changelog/2022-03-15) March 13 Coverage enhancements Additional integrations have been added to Argyle's coverage. [Open](/changelog/2022-03-13) March 10 API enhancements Three new data fields have been added to Argyle's API. [Open](/changelog/2022-03-10) March 6 Coverage enhancements Additional integrations have been added to Argyle's coverage. [Open](/changelog/2022-03-06) March 4 API breaking changes The count parameter will be removed March 31, 2022. [Open](/changelog/2022-03-04) March 3 Link updates The enable\_suggestions DDS configuration parameter has been deprecated. [Open](/changelog/2022-03-03) February 27 Coverage enhancements Additional integrations have been added to Argyle's coverage. [Open](/changelog/2022-02-27) February 23 API enhancements file\_url time limits will be reduced to 15 minutes. [Open](/changelog/2022-02-23) February 20 Coverage enhancements Additional integrations have been added to Argyle's coverage. [Open](/changelog/2022-02-20) February 13 Coverage enhancements Additional integrations have been added to Argyle's coverage. [Open](/changelog/2022-02-13) February 9 Link updates Minimum supported Android and iOS versions for Link SDK updated. [Open](/changelog/2022-02-09) February 8 Link updates Full paycheck deposit switches are now available. [Open](/changelog/2022-02-08) January 31 Console enhancements Introductory learning modal has been added to Console. [Open](/changelog/2022-01-31) January 28 Link updates Automated deposit switch flows for returning users. [Open](/changelog/2022-01-28) January 21 Link updates Removing user-made allocations from deposit switches. [Open](/changelog/2022-01-21) January 20 Link updates Sandbox test credentials have changed. [Open](/changelog/2022-01-20) January 12 API enhancements Item ID's have been added to the link-items endpoint. [Open](/changelog/2022-01-12) January 5 Link updates The onError Link callback has been added for Web Link. [Open](/changelog/2022-01-05) January 4 API enhancements Uuid's are replacing string-based Item ID's. [Open](/changelog/2022-01-04) ## 2021 December 27 Console enhancements Navigation enhancements are now available in Console. [Open](/changelog/2021-12-27) December 20 API enhancements Status information has been added for Link items. [Open](/changelog/2021-12-20) December 16 Link updates The payroll provider fallback has been added to Link. [Open](/changelog/2021-12-16) December 14 API breaking changes Known Link Item limitations have been added, and duplicate activity data prevention has been improved. [Open](/changelog/2021-12-14) December 13 API updates Argyle's systems are not vulnerable to the log4j critical exploitation bug. [Open](/changelog/2021-12-13) December 7 API breaking changes Pagination has been added to Argyle's API. [Open](/changelog/2021-12-07) December 3 API breaking changes argyle.io is now argyle.com [Open](/changelog/2021-12-03) December 2 Link updates Direct logins to incorrect employers have been improved. [Open](/changelog/2021-12-02) November 18 Link updates Percentage allocations are now available for deposit switches. [Open](/changelog/2021-11-18) November 8 API enhancements inactive is now a possible status value for pay allocations. [Open](/changelog/2021-11-08) November 7 Console enhancements Subscribing to webhooks through Console is now available. [Open](/changelog/2021-11-07) November 6 Link updates Documents can now be uploaded through Link. [Open](/changelog/2021-11-06) November 5 API enhancements The forms endpoint has been added to Argyle's API. [Open](/changelog/2021-11-05) September 9 Console enhancements Link can now be customized via Console. [Open](/changelog/2021-09-09) August 25 Link updates Connection hints are now available in Link. [Open](/changelog/2021-08-25) August 12 Link updates Analytics are now available for Link. [Open](/changelog/2021-08-12) August 5 API breaking changes user or account parameters are now required when listing activities. [Open](/changelog/2021-08-05) July 12 Console enhancements The Coverage tab has been introduced to Console. [Open](/changelog/2021-07-12) July 7 API enhancements Four new data fields have been added to the payouts endpoint. [Open](/changelog/2021-07-07) July 1 API enhancements Two new deposit switch errors have been added. [Open](/changelog/2021-07-01) June 30 Link updates New Link customization parameters are now available. [Open](/changelog/2021-06-30) June 27 API enhancements New Link item search parameters are now available. [Open](/changelog/2021-06-27) June 17 API enhancements Link item logos can now be retrieved via the API. [Open](/changelog/2021-06-17) June 8 Link updates You can now choose whether to allow editing during deposit switches. [Open](/changelog/2021-06-08) June 2 API enhancements Link items can now be searched via Argyle's API. [Open](/changelog/2021-06-02) June 1 Link updates Bank accounts can now be removed through deposit switches. [Open](/changelog/2021-06-01) May 31 Link updates Edit suggestions can now be added to deposit switches. [Open](/changelog/2021-05-31) May 26 API enhancements Achievement fields have been added to the reputations endpoint. [Open](/changelog/2021-05-26) May 20 API enhancements A new reports endpoint has been added. [Open](/changelog/2021-05-20) May 19 API enhancements New invite template parameters are available. [Open](/changelog/2021-05-19) May 16 API enhancements Link items can now be specified when sending invites via the API. [Open](/changelog/2021-05-16) May 12 API enhancements The type of Link item is now an available field. [Open](/changelog/2021-05-12) May 11 Console enhancements New invite customizations are now available. [Open](/changelog/2021-05-11) May 5 Link 3.0 is now available Visit our Link Upgrade Guide to learn how to upgrade to Link's latest version. [Open](/changelog/2021-05-05) April 27 Console enhancements Console now supports deposit switches and bulk invites. [Open](/changelog/2021-04-28) April 27 Console enhancements Invite enhancements in Console have been introduced. [Open](/changelog/2021-04-27) April 25 API enhancements New data fields are now available in the employments and payouts endpoints. [Open](/changelog/2021-04-25) April 13 API enhancements Accounts object now returned in accounts webhooks' payloads. [Open](/changelog/2021-04-13) April 11 API enhancements Invites via Argyle's API is now available. [Open](/changelog/2021-04-11) March 21 API enhancements New deposit switch errors added. [Open](/changelog/2021-03-21) March 17 Console enhancements Console 2.0 is live! [Open](/changelog/2021-03-17) March 16 API enhancements Metadata and error messages have been added. [Open](/changelog/2021-03-16) March 8 API enhancements Users can now be created via the API. [Open](/changelog/2021-03-08) March 3 API enhancements New available date field added to the documents endpoint. [Open](/changelog/2021-03-03) March 2 API enhancements New Link Item field added to Activities endpoint. [Open](/changelog/2021-03-02) February 28 API enhancements New bank account type value was added. [Open](/changelog/2021-02-28) February 27 API enhancements New employment status has been added. [Open](/changelog/2021-02-27) January 26 API enhancements New deposit switch object added to accounts endpoint and Link Item filter added. [Open](/changelog/2021-01-26) January 10 Link updates Smart deposit switch routing has been enhanced. [Open](/changelog/2021-01-10) January 7 API enhancements New account error is now available. [Open](/changelog/2021-01-07) January 6 Console enhancements Sandbox testing has been enhanced. [Open](/changelog/2021-01-06) ## 2020 December 21 Link updates New DDS configuration parameter added. [Open](/changelog/2020-12-21) December 1 API enhancements New document\_id field added to payouts endpoint. [Open](/changelog/2020-12-01) November 30 API enhancements New features object added to Link Items endpoint [Open](/changelog/2020-11-30) November 22 Link updates Control Link UI when outside elements are selected. [Open](/changelog/2020-11-22) November 10 API enhancements New source field added to accounts endpoint. [Open](/changelog/2020-11-10) November 8 API enhancements Pay Data Structure Guide is now available. [Open](/changelog/2020-11-08) October 28 API enhancements Introducing a new Link Items endpoint. [Open](/changelog/2020-10-28) October 25 API enhancements Introducing a new employments endpoint. [Open](/changelog/2020-10-25) October 13 Link updates Deposit switching is now supported. [Open](/changelog/2020-10-13) May 13 API enhancements New account connection statuses and error codes. [Open](/changelog/2020-05-13) January 9 API breaking changes Activity data enhancements. [Open](/changelog/2020-01-09) ## 2019 December 31 API enhancements Account errors have been introduced. [Open](/changelog/2019-12-31) # Email/SMS Templates Source: https://docs.argyle.com/console/flows/email-sms-templates Invite users via text or email to connect their payroll accounts. ## Overview Invites let users enter Link directly from an email or SMS message, without the need to embed Link in your website or application. * Invites are sent from the [Connections](https://console.argyle.com/connections) section of Console. * Email/SMS templates are customizations that can be applied to invites. * Multiple email/SMS templates can be created, each with their own customized email and/or text messaging, landing page, Link connection experience, and success page. ## Creating email/SMS templates ![You can create Email/SMS Templates in the Flows section of Console.](https://mintcdn.com/argyle/EtHVUNI_SMseJQur/images/argyle-guides/console/email-sms-templates/1-email-sms.png?fit=max\&auto=format\&n=EtHVUNI_SMseJQur\&q=85\&s=a64206dfcae79984151fc1e5a87a5ae0) To create an email/SMS template: 1. Sign in to Console with an **Admin**, **Full member**, or **Developer** account. (See [roles and permissions](/console/management/members#roles-and-permissions)) 2. Navigate to the [Flows](https://console.argyle.com/flows) section of Console. 3. Click **+ New Flow** then select **Email/SMS Template**. 4. Add [customizations](/console/flows/email-sms-templates#customizations), name your Email/SMS Template, and save. 5. Saved templates can be selected from the **Template** dropdown when [sending invites](/console/flows/email-sms-templates#sending-invites). > [!NOTE] > > In Console, you can filter your [Connections](https://console.argyle.com/connections) and the **Conversion** section of the [Dashboard](https://console.argyle.com/dashboard) by individual Flow. ## Wholesale mortgage templates Mortgage accounts can create separate retail and wholesale email/SMS templates. Ask your Customer Success Manager to enable wholesale flow creation if the wholesale option is not available. 1. Open **Flows**, select **+ New Flow**, then **Email/SMS Template**. 2. Select **Mortgage Wholesale** to start with broker-branded messaging, or **Mortgage Retail** for lender-branded messaging. 3. Customize the template, name it, and save. The default wholesale template uses the borrower's broker details at send time, so one template can serve multiple brokers. It has no logo by default and skips Link's introduction and employment history screens. > [!NOTE] > > Use `[Broker_company]` in a custom wholesale template to insert the broker's company name from `external_metadata.broker.company_name` ([API](/verifications/wholesale-mortgage#add-broker-details-to-the-borrower)) or **TPO Company Name** in Encompass ([TPO Connect](/integrations/pos-los/encompass/tpo-connect#configure-the-borrower-experience)). Contact your Customer Success Manager if your wholesale workflow requires Employment History before enabling it in a custom flow. Use a wholesale template for [wholesale API invites](/verifications/wholesale-mortgage#choose-the-invite-flow) or [TPO Connect](/integrations/pos-los/encompass/tpo-connect#configure-the-borrower-experience). A custom template is optional: the default wholesale experience works without creating one. The retail/wholesale choice applies to email/SMS templates only. ## Employer match If the user's employer is already known, when [sending invites](/console/flows/email-sms-templates#sending-invites) Console members can search Argyle's coverage for that employer by selecting **Employer match**. ![Employer match let's you search for the user's employer and send them a direct link to that employer in their invitation.](https://mintcdn.com/argyle/EtHVUNI_SMseJQur/images/argyle-guides/console/email-sms-templates/10-email-sms.png?fit=max\&auto=format\&n=EtHVUNI_SMseJQur\&q=85\&s=d4cebb319b96d586256fea67f6fcb2aa) * Selecting **Add to verification** for a *single employer* will adjust the invite so the user is sent directly to that employer's login screen in Link, bypassing search entirely. * Selecting **Add to verification** for *multiple employers* will adjust the invite so the user is only shown the selected employers, streamlining their search experience in Link. Employer match is an optional feature that can only be used with **Search** [email/SMS templates](/console/flows/email-sms-templates#creating-emailsms-templates). ![Employer match can be used only with Search email/sms flows.](https://mintcdn.com/argyle/YfkJ8p61ic0_0yX5/images/argyle-guides/console/email-sms-templates/9-email-sms.png?fit=max\&auto=format\&n=YfkJ8p61ic0_0yX5\&q=85\&s=60cc2c9359d079342e5da9244494c6c9) Employer match can be enabled in the [Other settings](https://console.argyle.com/settings/other-settings) section of Console. ![Employer match can be enabled in the Other settings section of Console.](https://mintcdn.com/argyle/EtHVUNI_SMseJQur/images/argyle-guides/console/email-sms-templates/11-email-sms.png?fit=max\&auto=format\&n=EtHVUNI_SMseJQur\&q=85\&s=b374e4fa1c83de56fcd29a7946fcd7d3) ## Sending invites ### Inviting new users 1. Sign in to Console with an **Admin**, **Full member**, or **Operations** account. (See [roles and permissions](/console/management/members#roles-and-permissions)) 2. From the **Connections** page, select **Start verification**. ![Invite new members in the Connections area of Console.](https://mintcdn.com/argyle/YfkJ8p61ic0_0yX5/images/argyle-guides/console/email-sms-templates/2-email-sms.png?fit=max\&auto=format\&n=YfkJ8p61ic0_0yX5\&q=85\&s=a3d9a7771ca66d3504b4710305827601) 3. Choose your invite **method** (email, SMS, or both) and fill out the **Recipient** details. > [!NOTE] > > Choosing **Email and SMS** is recommended and generally provides the best overall response rate.\**Any email and/or phone number provided will automatically pre-fill Link's login screen to assist users during login.* 4. (Optional) Select a saved **Email/SMS Template** from the dropdown to apply your customized Link settings. > [!NOTE] > > If no **Email/SMS Template** is selected, the default invite experience will be used. If only one Email/SMS Template has been created, it will automatically be applied to sent invites. 5. (Optional) Select a [group](/console/management/groups). 6. (Optional) Tag the invited user with an [external identifier](/overview/data-structure/users#external-identifiers). 7. Fill out the invite recipient's contact information. 8. (Optional) To invite multiple users at the same time, select **Bulk upload** and upload a CSV file ([example CSV](https://res.cloudinary.com/argyle-media/raw/upload/v1671566710/docs-2022/Guides/Argyle%20Console/Console%20FAQ/bulk_invite_example.csv)) with the users' contact information. ![The invite creation screen of Console.](https://mintcdn.com/argyle/YfkJ8p61ic0_0yX5/images/argyle-guides/console/email-sms-templates/3-email-sms.png?fit=max\&auto=format\&n=YfkJ8p61ic0_0yX5\&q=85\&s=6b5a69a6ea63885cb4c2cec7f932d694) 8. Select **Preview** to review the email, landing page, Link experience, or success message of the invitation. ![Where to find the link that takes you to invite settings.](https://mintcdn.com/argyle/YfkJ8p61ic0_0yX5/images/argyle-guides/console/email-sms-templates/4-email-sms.png?fit=max\&auto=format\&n=YfkJ8p61ic0_0yX5\&q=85\&s=bd60fa01a8ab51bfa2e0abb8f313f32a) 9. Select **Next**. 10. (Optional) Cc additional members of your team to be notified by email when the user has connected a payroll account. ![The last step before sending an invite where you can cc other members of your team.](https://mintcdn.com/argyle/EtHVUNI_SMseJQur/images/argyle-guides/console/email-sms-templates/12-email-sms.png?fit=max\&auto=format\&n=EtHVUNI_SMseJQur\&q=85\&s=eae367d1ab1f92df7d80e4f1a3e053cf) > [!NOTE] > > 11. **Send** the invitation > > * You will be notified by email when the user has connected a payroll account. > * You can filter sent invitations by status, income source, flow, or sender as well as search for specific [external identifiers](/overview/data-structure/users#external-identifiers) from the [Connections](https://console.argyle.com/connections) section of Console. ![The Flow filter in the Connections section of Console lets you filter users by what Link Flow they experienced.](https://mintcdn.com/argyle/YfkJ8p61ic0_0yX5/images/argyle-guides/console/email-sms-templates/5-email-sms.png?fit=max\&auto=format\&n=YfkJ8p61ic0_0yX5\&q=85\&s=f1e5790fb5e9efe5e6e6fe7c58188590) ### Automated reminders In [Console Settings](https://console.argyle.com/settings/other-settings), you can configure **automated reminders** for invites: * Sent to the user when an invite remains unopened after a configured number of days. * Sent via the original invite method (email, SMS, or both). * Applied to all new invites sent after the setting is enabled in Console. > [!NOTE] > > Only one reminder will be sent to invited users. ![Automated reminders can be configured so that users who have an unopened invite are sent a reminder to connect their payroll accounts through Argyle.](https://mintcdn.com/argyle/YfkJ8p61ic0_0yX5/images/argyle-guides/console/email-sms-templates/8-email-sms.png?fit=max\&auto=format\&n=YfkJ8p61ic0_0yX5\&q=85\&s=330f81e4d59106f727856a1e70c5e03f) ### Reconnecting existing users Users may need to return to Link for few reasons: * As part of their payroll system's [multi-factor authorization (MFA) process](/workflows/account-connections#completing-mfa). * To [re-verify a disconnected account](/workflows/reconnecting-accounts#invites) (a one-click, no credentials needed process). * To connect additional accounts—the user started a new job, for example. * To revoke access to previously connected accounts. ![You can resend invites through the Connections page of Console.](https://mintcdn.com/argyle/YfkJ8p61ic0_0yX5/images/argyle-guides/console/email-sms-templates/6-email-sms.png?fit=max\&auto=format\&n=YfkJ8p61ic0_0yX5\&q=85\&s=69508b3b1b06943f59b89163e093a309) Users can return to Link (and access their existing accounts) at any time through the original invite they received. Invites never expire. If the user has lost their original invite, a copy invite can be resent [via the API](/api-reference/invites#resend-invite) or Console using these steps: > [!NOTE] > > 1. Navigate to the [Connections](https://console.argyle.com/connections) section of Console. > > 2. Hover over the user to reveal: > > * A **Resend** icon, allowing you resend an invite to the user with one click. > * A **Sent by** tag, which can be clicked to copy a unique URL that you can send directly to the user. After receiving the resent invite or unique URL, the user will be able to access and if needed, reconnect their previously connected accounts. ## Customizations ### Branding * Add your company name, logo, and an accent color for the landing and success page. > [accordion] Recommended logo dimensions and format > > * **Height:** At least 80 px. > * **Width:** Scale proportionally to preserve your logo's aspect ratio. > * **Format:** PNG preferred, with a transparent background where possible. > * **Padding:** No extra whitespace around the logo is needed. ### Document upload settings When document uploads are **enabled** for either the intro screen, the search and connect screen, the success screen, and/or as a fallback verification method: * Customize the text of the document upload submission screen. * Select the document upload categories you would like to display. Choose whether a selected category is optional or required. If required, specify how many documents are needed for the category. * The "Miscellaneous" category can be re-named. ### Invite * Customize the text and icons of your email and/or SMS message. > [accordion] Note: Dynamic text is available for text customizations: > > * \[Company] inserts the name of your company. > * \[Name] inserts the full name of the invited user. > * \[Member\_email] inserts the email address of the Console member who sends the invitation. > * \[Broker\_company] inserts the broker's company name for wholesale mortgage templates. ### Landing page * Select which verification methods to allow (at least one must be selected): * Connect payroll account (direct payroll connections) * Connect bank account ([financial institution connections](/api-reference/banking-overview)) > [!NOTE] > > Only applicable when [sending invites](/api-reference/invites) via API. * Upload income documents (fallback-only toggle is within dropdown) * Customize the text of the landing page. > [accordion] Note: Dynamic text is available for text customizations: > > * \[Company] inserts the name of your company. > * \[Name] inserts the full name of the invited user. > * \[Member\_email] inserts the email address of the Console member who sends the invitation. > * \[Broker\_company] inserts the broker's company name for wholesale mortgage templates. ### Argyle Link #### Intro screen * Enable, brand, and customize Link's optional introduction screen. * Optionally enable [document uploads](/workflows/document-processing) from the introduction screen. #### Search and connect: * Adjust Link's default text. > [!NOTE] > > Link's default text is generalized to maximize the percentage of users that are able to successfully connect their payroll accounts in wide variety of use cases, but can be adjusted as needed to suit your use case or branding requirements. * Adjust Link's payroll connection process: * **Search**: Users can search for their employer or payroll provider. You can adjust which [types of Items](/overview/data-structure/items#types-of-items) are shown and the appearance of Link's home screen. * **List**: Only show Items you specify to users in Link. * **Direct login**: [Directly connect](/workflows/account-connections#direct-login) users to a specific Item. * **Doc upload**: Let users [upload employment documents](/workflows/document-processing) directly from their device. ![Select fallback experience to view different options you can give users who cannot find or connect to their payroll account.](https://mintcdn.com/argyle/YfkJ8p61ic0_0yX5/images/argyle-guides/console/email-sms-templates/7-email-sms.png?fit=max\&auto=format\&n=YfkJ8p61ic0_0yX5\&q=85\&s=eb88d3425a9d7cf7d5e16f838930ab88) * Omit individual Items from Link search, or specific types of Items based on their [mapping status](/overview/data-structure/items#mapping-status). * **Fallback experiences**: Choose what users are shown after submitting invalid credentials or if they are unable to find their employer/payroll provider: * **Form**: Present users with a question form asking them to list their employer or payroll provider. Forms can be retrieved [via Console](/overview/data-structure/accounts#console) or [via the API](/api-reference/user-forms). * **Document upload**: Let users upload employment documents directly from their device. Uploaded documents can be [retrieved](/workflows/document-processing#retrieving-uploaded-documents) via Console or via the API. * **Callback**: Closes Link and triggers the `onCantFindItemClicked` [callback](/link/reference/callbacks#oncantfinditemclicked). #### Success screen: * Adjust the text shown after a user successfully connects a payroll account. * Allow users to connect additional (more than one) payroll account. * Allow users to upload documents after a successful connection. ### Success page * Customize the text shown to users after they exit Link. * Add an exit button and (optionally) redirect users back to your website or application. # Embedded Experiences Source: https://docs.argyle.com/console/flows/embedded-experiences Configure the embedded Link experience for your website or application. Embed and configure the payroll connection experience users complete through Link. ## Overview Link can be embedded directly within your website or application. * Embedded experiences customize Link's default payroll connection process. * Embedded experiences can *only* be applied to embedded instances of Link. > [!NOTE] > > Visit our [Link Initialization Guide](/link/initialization) for technical information on how to embed Link. * Multiple embedded experiences can be created, each with their own customized Link connection experience. ## Creating embedded experiences ![You can create Embedded Experience flows in the Flows section of Console.](https://mintcdn.com/argyle/YfkJ8p61ic0_0yX5/images/argyle-guides/console/embedded-experiences/1-embedded.png?fit=max\&auto=format\&n=YfkJ8p61ic0_0yX5\&q=85\&s=d751d26602100af76706e616def4d601) To create an embedded experience flow: 1. Sign in to Console with an **Admin**, **Full member**, or **Developer** account. (See [roles and permissions](/console/management/members#roles-and-permissions)) 2. Navigate to the [Flows](https://console.argyle.com/flows) section of Console. 3. Select **+ New Flow** then select **Embedded Experience**. 4. Add [customizations](/console/flows/embedded-experiences#customizations), name your embedded experience, and save. > [!NOTE] > > In Console, you can filter your [Connections](https://console.argyle.com/connections) and the **Conversion** section of the [Dashboard](https://console.argyle.com/dashboard) by individual Flow. ## Testing your flow Enable **Sandbox mode** in Console and open your flow's preview to test the connection experience with sample users. Under **Create custom user**, you can also describe an income or employment scenario to create a custom test user. ## Applying embedded experiences to Link > [!NOTE] > > 1. Navigate to the [Flows](https://console.argyle.com/flows) section of Console. > 2. Copy the ID (e.g. `V32M5YBC`) of the embedded experience you want to apply. > 3. Use the ID as the value for the `flow_id` parameter in your [Link initialization code](/link/initialization). ![Copy flow\_id values from your Embedded Experiences in the Flows section of Console.](https://mintcdn.com/argyle/YfkJ8p61ic0_0yX5/images/argyle-guides/console/embedded-experiences/2-embedded.png?fit=max\&auto=format\&n=YfkJ8p61ic0_0yX5\&q=85\&s=5a30ba0f09f43e9111052c12df2e3d16) ## Customizations ### Branding * Add your company name. ### Document upload settings When document uploads are **enabled** for either the intro screen, search and connect screen, and/or the success screen: * Customize the text of the document upload submission screen. * Select the document upload categories you would like to display. Choose whether a selected category is optional or required. If required, specify how many documents are needed for the category. * The "Miscellaneous" category can be re-named. ### Intro screen * Enable, brand, and customize Link's optional introduction screen. ### Search and connect * Adjust Link's default text. > [!NOTE] > > Link's default text is generalized to maximize the percentage of users that are able to successfully connect their payroll accounts in wide variety of use cases, but can be adjusted as needed to suit your use case or branding requirements. * Adjust Link's payroll connection process: * **Search**: Users can search for their employer or payroll provider. You can adjust which [types of Items](/overview/data-structure/items#types-of-items) are shown and the appearance of Link's home screen. * **List**: Only show Items you specify to users in Link. * **Direct login**: [Directly connect](/workflows/account-connections#direct-login) users to a specific Item. * **Doc upload**: Let users [upload employment documents](/workflows/document-processing) directly from their device. ![Select fallback experience to view different options you can give users who cannot find or connect to their payroll account.](https://mintcdn.com/argyle/YfkJ8p61ic0_0yX5/images/argyle-guides/console/embedded-experiences/3-embedded.png?fit=max\&auto=format\&n=YfkJ8p61ic0_0yX5\&q=85\&s=f73ebfcb59c84e38e1401e73acf968d9) * Omit individual Items from Link search, or specific types of Items based on their [mapping status](/overview/data-structure/items#mapping-status). * **Fallback experiences**: Choose what users are shown after submitting invalid credentials or if they are unable to find their employer/payroll provider: * **Form**: Present users with a question form asking them to list their employer or payroll provider. Forms can be retrieved [via Console](/overview/data-structure/accounts#console) or [via the API](/api-reference/user-forms). * **Document upload**: Let users upload employment documents directly from their device. Uploaded documents can be [retrieved](/workflows/document-processing#retrieving-uploaded-documents) via Console or via the API. * **Callback**: Closes Link and triggers the `onCantFindItemClicked` [callback](/link/reference/callbacks#oncantfinditemclicked). ### Success screen * Adjust the text shown after a user successfully connects a payroll account. * Allow users to connect additional (more than one) payroll account. * Allow users to upload documents after a successful connection. # Shareable URLs Source: https://docs.argyle.com/console/flows/shareable-urls Create URLs that link to Argyle's payroll connection experience. ## Overview Shareable URLs connect your users to a hosted Link experience where they can connect their payroll accounts. > [!NOTE] > > These URLs are universal, and can be shared as standalone URL hyperlinks. * Multiple shareable URLs can be created, each with their own customized landing page, Link connection experience, and success page. * Unique [external identifiers](/overview/data-structure/users#external-identifiers) can be associated with each shareable URL, allowing you to map users to specific campaigns, branches, or console members. * With [URL modifications](/console/flows/shareable-urls#url-modifications), you can modify the URL path to overwrite: 1. Who receives an email notification when there is a successful connection through the shareable URL. 2. Which external identifier should be associated with the Shareable URL. ## Creating shareable URLs ![You can create Shareable URLs in the Flows section of Console.](https://mintcdn.com/argyle/aansYe1yBfuMPbbh/images/argyle-guides/console/shareable-urls/1-shareable.png?fit=max\&auto=format\&n=aansYe1yBfuMPbbh\&q=85\&s=de088b849ab251fed7a31f5c83b52167) To create and customize a shareable URL: 1. Sign in to Console with an **Admin**, **Full member**, or **Developer** account. (See [roles and permissions](/console/management/members#roles-and-permissions)) 2. Navigate to the [Flows](https://console.argyle.com/flows) section of Console. 3. Check if you have the Sandbox mode toggle ON or OFF. > [!NOTE] > > When the Sandbox toggle is ON, shareable URLs will connect to Argyle's Sandbox Testing environment, which allows you to [connect sample users](/overview/sandbox-testing#connect-sample-users). 4. Click **+ New Flow** then select **Shareable URL**. 5. Add [customizations](/console/flows/shareable-urls#customizations), name your shareable URL flow, and save. > [!NOTE] > > In Console, you can filter your [Connections](https://console.argyle.com/connections) and the **Conversion** section of the [Dashboard](https://console.argyle.com/dashboard) by individual Flow. ## URL modifications After creating and saving a Shareable URL using the steps above, it will look like this: `https://verify.argyle.com/connect-url/{unique_code}` URL modifications let you overwrite the (1) **email notification recipient** and (2) **external identifier** while keeping other saved customizations. > [!NOTE] > > 1. When creating a Shareable URL in the [Flows section of Console](https://console.argyle.com/flows), in **General settings**, add a whitelisted company email domain. This is for security, and ensures only someone from your organization can be notified by email. > 2. Add the email and/or external identifier to the end of the Shareable URL: ```text theme={} Examples: Email overwrite: https://verify.argyle.com/connect-url/{unique_code}?reply_to=your_email@yourcompany.com External identifier overwrite: https://verify.argyle.com/connect-url/{unique_code}?external_id=winter_campaign Email and external identifier overwrite: https://verify.argyle.com/connect-url/{unique_code}?reply_to=your_email@yourcompany.com&external_id=winter_campaign ``` #### Notable: * Only one email can be specified at the end of the URL. * If no overwrite is used, the email(s) and/or external identifier saved in Console will be used. * If the overwrite email does not end in a whitelisted email domain address, the email(s) saved in Console will be used. ![External identifiers and email notification recipients can be associated with a specific Shareable URL in the Flows section of Console.](https://mintcdn.com/argyle/YfkJ8p61ic0_0yX5/images/argyle-guides/console/shareable-urls/5-shareable.png?fit=max\&auto=format\&n=YfkJ8p61ic0_0yX5\&q=85\&s=5c6f6ff1ee18ae06106fb010ea2cf9fb) ## Sending shareable URLs Shareable URLs are standalone URLs you can include anywhere on your website, within emails or direct ad campaigns, inside your applications, or in any other method of contact with your users. ## Deactivating shareable URLs > [!NOTE] > > Shareable URLs can be deactivated (and re-activated) individually in the Flows section of Console via the more actions (three vertical dots) dropdown. Deactivated shareable URLs are marked as **Disabled** in Console and will present a special "No action needed" landing page. ## Reconnecting users Within the Connections section of Console, users that originally entered Link via a shareable URL will be indicated by a green paperclip icon. If a user needs to return to Link to [reconnect an account](/workflows/reconnecting-accounts), hover over the green paperclip icon and click to copy a unique URL *specific to this individual user*. Sharing this unique URL with the user will allow them to return to Link to reconnect their existing accounts (no login credentials needed). ![Copy shareable URLs from the Connections page in Console. They will be unique to the user that originally clicked the shareable URL.](https://mintcdn.com/argyle/YfkJ8p61ic0_0yX5/images/argyle-guides/console/shareable-urls/2-shareable.png?fit=max\&auto=format\&n=YfkJ8p61ic0_0yX5\&q=85\&s=ed112f63f497c561530cf043f18dd9f7) ## Customizations ### Branding * Add your company name, logo, and an accent color for the landing and success page. > [accordion] Recommended logo dimensions and format > > * **Height:** At least 80 px. > * **Width:** Scale proportionally to preserve your logo's aspect ratio. > * **Format:** PNG preferred, with a transparent background where possible. > * **Padding:** No extra whitespace around the logo is needed. ### General settings * Choose whether to receive an email after a successful payroll connection. * Choose whether to use [external identifiers](/overview/data-structure/users#external-identifiers), which will be attached to any user who clicks on this unique shareable URL. * Whitelist an email domain that can be used with [URL modifications](/console/flows/shareable-urls#url-modifications). ### Document upload settings When document uploads are **enabled** for either the intro screen, search and connect screen, and/or the success screen: * Customize the text of the document upload submission screen. * Select the document upload categories you would like to display. Choose whether a selected category is optional or required. If required, specify how many documents are needed for the category. * The "Miscellaneous" category can be re-named. ### Landing page * Customize the text of the landing page. > [accordion] Note: Dynamic text is available for text customizations: > > * \[Company] inserts the name of your company. > * \[Member\_email] inserts the email address of the Console member who sends the invitation. ### Argyle Link #### Intro screen * Enable, brand, and customize Link's optional introduction screen. * Optionally enable [document uploads](/workflows/document-processing) from the introduction screen. #### Search and connect: * Adjust Link's default text. > [!NOTE] > > Link's default text is generalized to maximize the percentage of users that are able to successfully connect their payroll accounts in wide variety of use cases, but can be adjusted as needed to suit your use case or branding requirements. * Adjust Link's payroll connection process: * **Search**: Users can search for their employer or payroll provider. You can adjust which [types of Items](/overview/data-structure/items#types-of-items) are shown and the appearance of Link's home screen. * **List**: Only show Items you specify to users in Link. * **Direct login**: [Directly connect](/workflows/account-connections#direct-login) users to a specific Item. * **Doc upload**: Let users [upload employment documents](/workflows/document-processing) directly from their device. ![Select fallback experience to view different options you can give users who cannot find or connect to their payroll account.](https://mintcdn.com/argyle/YfkJ8p61ic0_0yX5/images/argyle-guides/console/shareable-urls/4-shareable.png?fit=max\&auto=format\&n=YfkJ8p61ic0_0yX5\&q=85\&s=112bda7a3a2ab741ed630ea039382b93) * Omit individual Items from Link search, or specific types of Items based on their [mapping status](/overview/data-structure/items#mapping-status). * **Fallback experiences**: Choose what users are shown after submitting invalid credentials or if they are unable to find their employer/payroll provider: * **Form**: Present users with a question form asking them to list their employer or payroll provider. Forms can be retrieved [via Console](/overview/data-structure/accounts#console) or [via the API](/api-reference/user-forms). * **Document upload**: Let users upload employment documents directly from their device. Uploaded documents can be [retrieved](/workflows/document-processing#retrieving-uploaded-documents) via Console or via the API. #### Success screen: * Adjust the text shown after a user successfully connects a payroll account. * Allow users to connect additional (more than one) payroll account. * Allow users to upload documents after a successful connection. ### Success page * Customize the text shown to users after they exit Link. * Add an exit button and (optionally) redirect users back to your website or application. # Custom Sending Domain Source: https://docs.argyle.com/console/management/custom-sender-domain Send supported user invitation and data-sharing emails from your organization's domain. ## Overview By default, Argyle sends user invitation and data-sharing request emails from `notifications@argyle.com`. With a custom sending domain, you can configure these emails to come from your own domain instead — for example, `verifications@yourlender.com`. This means users receive emails from a domain they already recognise and trust, which typically improves open rates and conversion rates. *** ## How it works You provide your domain and a from address. Argyle generates a set of DNS records that authenticate your domain with our email infrastructure. Once your IT team adds those records and you verify them, Argyle will send all user emails from your configured address. Argyle does not access your mailbox or connect to your email system. No mailbox credentials or MFA are required. The DNS records authorize our email provider to send emails on behalf of your domain. The setup is a one-time DNS change. Once verified, no ongoing action is required from your side. *** ## Prerequisites * Access to your organisation's DNS settings (or a contact at your IT team who does) * A domain you control (e.g. `yourlender.com`) * A from address on that domain (e.g. `verifications@yourlender.com`) *** ## Setup steps ### 1. Open Console settings In the Argyle Console, go to **Settings → Other settings → Custom sending domain**. ### 2. Enter your domain and from address * **Sending domain:** enter your root domain, e.g. `yourlender.com` * **From address:** enter the address users will see, e.g. `verifications@yourlender.com` Click **Generate DNS records**. > [!NOTE] > > The **from address** is the sender address users see. It does not need to have a mailbox, but we recommend using an address your team monitors because users may email it directly. This address is not used as the default **reply-to** address. ![Enter a sending domain and from address in the Custom sending domain section of Console.](https://mintcdn.com/argyle/mOB-_jzLmsMpMm5o/images/console/management/custom-sender-domain/1-domain-entry.png?fit=max\&auto=format\&n=mOB-_jzLmsMpMm5o\&q=85\&s=353c6c043764492ea4a93931ed9b7d73) ### 3. Add DNS records Argyle will generate 3 CNAME records. Share these with your IT team and ask them to add all 3 to your DNS provider (e.g. Cloudflare, Route 53, GoDaddy). > [!NOTE] > > If your DKIM records are managed by another provider, add the two DKIM values in that provider instead. See [Troubleshooting](#troubleshooting) for details. ![Copy the generated CNAME records into your DNS provider, then verify them in Console.](https://mintcdn.com/argyle/rfGA8EI5CsX1j57k/images/console/management/custom-sender-domain/2-dns-records.png?fit=max\&auto=format\&n=rfGA8EI5CsX1j57k\&q=85\&s=161d305ef772175b3562c6a48ea09707) | Record | Type | What it does | | - | - | - | | Return-Path | CNAME | SPF authentication — authorises Argyle to send on behalf of your domain | | DKIM key 1 | CNAME | Email signing key — proves emails haven't been tampered with in transit | | DKIM key 2 | CNAME | Backup signing key, rotated automatically for ongoing security | DNS changes can take up to 48 hours to propagate, though they typically complete within a few hours. ### 4. Verify Once your IT team has added the records, return to Console and click **Verify records**. Argyle will check each record and confirm the setup. If verification fails, the Console will show which records were not found. Check that the values were entered correctly and try again after allowing more time for propagation. ### 5. Done Once verified, Argyle will send all user emails from your configured address. You'll see a confirmation in Console and can remove the custom domain at any time. *** ## Troubleshooting | Symptom | Cause | Fix | | - | - | - | | Records added but not found | Your DNS provider may have automatically appended the domain, e.g. `arg._domainkey.example.com.example.com`. | Enter the host without the domain suffix, e.g. `arg._domainkey`. | | DKIM records show `Not found` | Your `_domainkey` subdomain may be delegated to a separate email authentication provider. | [Follow the check below](#check-whether-your-dkim-is-managed-by-another-provider). If it is delegated, add the DKIM values in that provider instead of your DNS host. | ### Check whether your DKIM is managed by another provider Some organizations use a dedicated email authentication service to manage DKIM centrally. When they do, DKIM records added directly to your DNS host are ignored — they have to be added in that service instead. 1. Open [Google Admin Toolbox](https://toolbox.googleapps.com/apps/dig/#NS/). 2. Enter `_domainkey.yourdomain.com` in **Name**, replacing `yourdomain.com` with your domain. Select **NS** and press **Enter**. 3. Read the result: * **No records found** — your DKIM isn't delegated. Add the records in your own DNS host, and check the auto-appended domain issue above. * **A nameserver is returned** (for example, `ns.vali.email`) — your DKIM is managed by that provider. Add both DKIM values in their dashboard instead. 4. Once the records are added, return to Console and click **Verify again**. The Return-Path record always goes in your own DNS host, whether or not DKIM is delegated. *** ## Removing a custom domain To stop using your custom domain, click **Remove** in Console. Argyle will revert to sending from `notifications@argyle.com`. You can set up a new domain at any time by going through the setup steps again. *** ## FAQ **Will users see any Argyle branding in the email address?** Once verified, the from address will show exactly what you configured (e.g. `verifications@yourlender.com`). Argyle will only be mentioned in the footer. **Does this affect email deliverability?** It improves it. Emails sent from an authenticated domain are less likely to land in spam. The DNS records you add are the industry-standard mechanism (DKIM and SPF) for proving the email is legitimate. **Can we use a subdomain instead of the root domain?** The setup will use a subdomain for authentication infrastructure behind the scenes, but the from address will use your root domain. You only need to provide the root domain. **What if our IT team needs more context on the DNS records?** The 3 CNAME records are standard email authentication records used by email providers. They do not grant Argyle any access to your domain or email systems — they only allow Argyle to send emails on your behalf with proper authentication. **Can we configure more than one custom sending domain?** No. Argyle currently supports only one custom sending domain, which applies across all flows. # Developers Source: https://docs.argyle.com/console/management/developers Accessing API keys through Console. ## Overview Production and Sandbox API keys can be created in [Console](https://console.argyle.com/api-keys). * API keys are an `id` and `secret` combination used to [authenticate API requests](/api-guide/overview#authentication). * Sandbox API keys allow you to retrieve sample data. * Production API keys are used when connecting real accounts. > [!NOTE] > > API key secrets are only visible during API key creation and partially obfuscated thereafter. Please ensure you copy and securely store API secrets when creating new API keys. ## API keys ![API keys are found in the Developers section of Console.](https://mintcdn.com/argyle/NMp3ek9jel7nGcQ8/images/console/management/developers/1-developers.png?fit=max\&auto=format\&n=NMp3ek9jel7nGcQ8\&q=85\&s=7b8c8d4f629ae5768e8a55aa446e297d) You can generate as many sets of Sandbox and Production API keys in Console as needed. For example, you could have a set of API keys for every [Console member](/console/management/members) on your team, or sets of API keys that correspond to a specific Console member [role](/console/management/members#roles-and-permissions). Argyle provides both Sandbox and Production [API environments](/api-guide/overview#environments). In the Sandbox API environment for example, authorize requests using your Sandbox API key and secret, and make requests to various endpoints using the Sandbox `https://api-sandbox.argyle.com/v2` base URL. To generate new API keys: 1. Select "Create API key" in the upper-right of the [API keys section of Console](https://console.argyle.com/api-keys). 2. In the pop-up, enter a name for the new set of API keys and select an environment. ![Generate new API keys through Console.](https://mintcdn.com/argyle/NMp3ek9jel7nGcQ8/images/console/management/developers/2-developers.png?fit=max\&auto=format\&n=NMp3ek9jel7nGcQ8\&q=85\&s=f16cf8b3b8e7c3869b1b6b1b12261a8f) # Groups Source: https://docs.argyle.com/console/management/groups Organize invitations and connections across your company. > [!NOTE] > > Groups let Admins organize the Console members who send invitations. > [!NOTE] > > * Console members can be organized into groups in the [Settings](https://console.argyle.com/settings/groups) section of Console. > * Please reach out to your Customer Success Manager to enable this feature. ## Overview Groups determine which users are visible in the [Connections](https://console.argyle.com/connections) section of Console. > [!NOTE] > > Groups control visibility within Console. They are not a comprehensive data permissioning system. Visibility depends on each Console member's role: * **Admin** and **Full Member** [roles](/console/management/members#roles-and-permissions) can view all users across your organization. * **Operations** roles can only view users invited by members of their group(s). * **Operations (limited)** roles can only view users they invite. **Exceptions:** > [!NOTE] > > 1\.  **Operations** roles that are not in any group (ungrouped) can also view all users across your organization.\\ > > 2\. **Operations** and **Operations (limited)** roles can also view specific users if they were Cc'd on the original invite. Console members can be organized by branch, office, geographical location, department, team, etc. according to your organizational needs. ![Groups let you manage invitations and connections across different teams in your organization.](https://mintcdn.com/argyle/NMp3ek9jel7nGcQ8/images/console/management/groups/1-groups.png?fit=max\&auto=format\&n=NMp3ek9jel7nGcQ8\&q=85\&s=a8ee753b2f1c4bf3b11ccfa26328ec41) ## Creating groups > [!NOTE] > > Only [Admins](/console/management/members#roles-and-permissions) can create and manage groups. 1. Within the **Groups** tab in the [Settings](https://console.argyle.com/settings/groups) section of Console, select **Create new group**. 2. Name and save the group, then select the group and click **Add members**. * Any existing Console member within your organization can be added to a group. * New team members can also be invited to Console, added to the group, and assigned a role. > [!NOTE] > > Members can be added in bulk using commas or a new line per member, allowing you to copy and paste directly from an Excel or CSV file. ## Filtering by group Invited users can be filtered by group in the [Connections](https://console.argyle.com/connections) section of Console. > [!NOTE] > > * **Admin** and **Full Member** roles can filter by any group. > * **Operations** roles can only filter their groups. ![Groups can be used to filter users in the Connections section of Console.](https://mintcdn.com/argyle/NMp3ek9jel7nGcQ8/images/console/management/groups/3-groups.png?fit=max\&auto=format\&n=NMp3ek9jel7nGcQ8\&q=85\&s=29c13751b5107c169aa10677c4228975) ## Group selection Groups can be selected from a dropdown when [sending invites](/console/flows/email-sms-templates#sending-invites). > [!NOTE] > > This determines which Console members can view the invited user in the [Connections](https://console.argyle.com/connections) section of Console. * **Operations** roles will only see their groups within the dropdown. * If the **Organization** group is selected, the invited user will be visible for **Admin**, **Full Member**, and ungrouped **Operations** roles. * If a specific group is selected, the invited user will be visible for **Admin**, **Full Member**, and **Operations** roles (if the **Operations** member is also in the selected group). ![Groups can be selected from the dropdown when sending and invite or starting a verification.](https://mintcdn.com/argyle/NMp3ek9jel7nGcQ8/images/console/management/groups/2-groups.png?fit=max\&auto=format\&n=NMp3ek9jel7nGcQ8\&q=85\&s=64a045888618569673cc396d94a23d66) ## Assigning Flows to groups By assigning Link Flows to a group, only those Flows will be selectable when sending invites when the respective group is chosen. ![Only assigned Link Flows will be shown to their respective groups.](https://mintcdn.com/argyle/NMp3ek9jel7nGcQ8/images/console/management/groups/5-groups.png?fit=max\&auto=format\&n=NMp3ek9jel7nGcQ8\&q=85\&s=4a4c125676be74fb75d4e60e4f8a014c) Flows can be assigned to groups in the [Settings](https://console.argyle.com/settings/groups) section of Console: 1. Select an existing group. 2. Select **Assign Flows**. ![You can restrict Groups to specific Link Flows when managing groups in Console.](https://mintcdn.com/argyle/NMp3ek9jel7nGcQ8/images/console/management/groups/4-groups.png?fit=max\&auto=format\&n=NMp3ek9jel7nGcQ8\&q=85\&s=7c6dc75315f9d9fcf3697ab689c75229) Flows can also be assigned to groups directly through the [Flows](https://console.argyle.com/flows) section of Console: ![You can also assign a Flow to a group from the Flows section of Console.](https://mintcdn.com/argyle/NMp3ek9jel7nGcQ8/images/console/management/groups/6-groups.png?fit=max\&auto=format\&n=NMp3ek9jel7nGcQ8\&q=85\&s=70cc7c5d30805144f144cc6416ef05e8) ## Managing groups > [!NOTE] > > Only [Admins](/console/management/members#roles-and-permissions) can edit and delete groups. Within the **Groups** tab in the [Settings](https://console.argyle.com/settings/groups) section of Console, select an existing group. * Click **Delete group** and confirm to delete a group. * Add, edit, or remove group members using the action buttons. > [!NOTE] > > Deleted groups will still be available as a filter in the Connections section of Console. > [accordion] FAQ when adding/removing individual members of an existing group. > > Q. What happens when a Console member *not currently in a group* is added to a group? > A. The Console member's previously invited users will immediately become visible to the group's members. Future users this Console member invites will also be visible to the group members. > > > [!NOTE] > > > > Q. What happens when a Console member that is *already in one or more groups* is added to an additional group? > > A. The Console member's previously invited users will not be made visible to the group's members. Future users this Console member invites will be visible to the group members. > > Q. What happens when a Console member is *removed* from a group? > A. The Console member's previously invited users will remain visible to the remaining members of the group. Future users this Console member invites will not be visible to the remaining group members going forward. ## Embedded Link and groups If you are [embedding Link](/link/initialization) within your website or application: 1. Create or edit an existing [API key](https://console.argyle.com/api-keys). 2. Assign a group to the API key. When embedding Link, if the `userToken` [parameter](/link/initialization/overview#required-initialization-parameters) was created using this API key, the user will automatically be assigned to the respective group. > [!NOTE] > > A `userToken` is returned in the API response when [creating users](/api-reference/users#create). > [!NOTE] > > Deleting a group will also delete the associated API key. Any users that were already assigned to a specific group by the deleted API key however will remain associated with that group. ![Groups can be assigned to Argyle API keys for use with embedded Link implementations.](https://mintcdn.com/argyle/NMp3ek9jel7nGcQ8/images/console/management/groups/7-groups.png?fit=max\&auto=format\&n=NMp3ek9jel7nGcQ8\&q=85\&s=1c8ad7b6f4bc95e7cebc1a1a800cb5e2) # Integrations Source: https://docs.argyle.com/console/management/integrations Connecting third party services via Console. ## Overview Argyle integrates with a variety of third party business systems and services. Reach out to our team if you have a specific integration in mind, or visit our dedicated [Integrations Guides](/integrations/pos-los/encompass/verifications) for step-by-step walkthroughs of currently supported integrations. * Subscribe to our [Changelog](https://changelog.argyle.com/) to stay up-to-date as new integrations are released. ## Quick integrations An increasing number of integrations can be added through a special quick set-up process via Console. For these third party integrations, simply navigate to the [Integrations section of Console](https://console.argyle.com/integrations) under **Developers** and submit your relevant third party keys. ### Ocrolus Ocrolus is a commonly used third party OCR service for [documents uploaded through Argyle](/workflows/document-processing) via Link. * Visit our [Ocrolus OCR Guide](/integrations/ocr/ocrolus) for more information. ### Encompass Verify income, employment, documents, and assets within the Encompass® by ICE Mortgage Technology® platform. * Visit our [Encompass Integration Guide](/integrations/pos-los/encompass/verifications) for more information. > [!NOTE] > > *Argyle is not affiliated with, sponsored by, or endorsed by Encompass. A customer's right to use Encompass is subject to its separate agreement with Encompass (or otherwise with its authorized resellers or other contracting partners), if any.* ### Empower Verify income and employment within the Empower® LOS platform. * Visit our [Empower Integration Guide](/integrations/pos-los/empower) for more information. > [!NOTE] > > *Argyle is not affiliated with, sponsored by, or endorsed by Empower. A customer's right to use Empower is subject to its separate agreement with Empower (or otherwise with its authorized resellers or other contracting partners), if any.* ### nCino Argyle can be integrated with the nCino platform to enhance your [Loan Origination System (LOS)](/integrations/pos-los/loan-origination-systems) and [Point of Sale (POS) systems](/integrations/pos-los/point-of-sale-systems). * Visit our [nCino Guide](/integrations/pos-los/ncino) for more information. > [!NOTE] > > *Argyle is not affiliated with, sponsored by, or endorsed by nCino. A customer's right to use nCino is subject to its separate agreement with nCino (or otherwise with its authorized resellers or other contracting partners), if any.* ### Day 1 Certainty and AIM Achieve Day 1 Certainty® from Fannie Mae and AIM eligibility from Freddie Mac through Argyle income and employment verifications. * Visit our [Day 1 Certainty® and AIM guide](/integrations/d1c-aim/verifications) for more information. # Members & Permissions Source: https://docs.argyle.com/console/management/members Managing roles and permissions in Console. Invite different members of your team through Console, and determine what role you want them to have. The role determines their access to user data, API keys, billing, and other permissions. ## Adding team members 1. Sign in to Console with an [Admin](/console/management/members#admin) account. 2. Navigate to the **Members** tab within the **Settings** section of Console. 3. Select **Add members**. ![Add team members in the Settings area of Console.](https://mintcdn.com/argyle/YfkJ8p61ic0_0yX5/images/argyle-guides/console/management/members-permissions/1-members.png?fit=max\&auto=format\&n=YfkJ8p61ic0_0yX5\&q=85\&s=3232120aae17cc493827b58fe7efc501) 4. In the pop-up menu, select a [role](/console/management/members#roles-and-permissions) for the new member depending on the permissions you would like them to have. You can also optionally assign them to a [group](/console/management/groups) if this functionality is enabled. 5. Add the email addresses of the members you would like to invite to Console. Members can be added in bulk using commas or a new line per member, allowing you to copy and paste directly from an Excel or CSV file. 6. Select **Invite members**. > [!NOTE] > > The invited team member will receive an email with instructions on setting up their Console account. ## Roles and permissions ### Admin * Can invite or delete Console members. * Can create [groups](/console/management/groups), and add or remove members from groups. * Can [send invites](/console/flows/email-sms-templates#sending-invites) and view connected accounts. * Can access API keys. * Can use all Console capabilities. ### Full member * Same permissions as Admins, except: * Cannot invite or delete Console members. * Cannot create, edit, or delete groups. ### Operations * Can send invites and view connected accounts. * Cannot invite or delete Console members. * Cannot create, edit, or delete groups. * Cannot access API keys. * Cannot access the Dashboard, Flows, Coverage, Webhooks, and Billing sections of Console. * Can be restricted from using Sandbox mode in Console (see [Other Settings](https://console.argyle.com/settings/other-settings)). ### Operations (limited) * Same permissions as Operations, except: * Cannot view connected accounts related to invites sent by *other Console members*, unless Cc'd on the original invite. ### API developer * Can access API keys. * Can only view metadata related to connected accounts, such as connection status or account ID's. * Cannot view personal user data or send invites. * Cannot invite or delete Console members. * Cannot create, edit, or delete groups. * Cannot access the Billing section of Console. # Webhooks Source: https://docs.argyle.com/console/management/webhooks Subscribe to event notifications through Console. * Visit the [API Reference](/api-reference/users-webhooks/fully-synced) for a full list of available webhooks and their descriptions. * Visit the [API Webhooks Guide](/api-guide/webhooks) to learn more about subscribing to webhooks via the API. ## Overview Webhooks notify you in real-time when important events occur, such as: * A new payroll connection is attempted. * Data retrieval from a recently connected account has completed. * New data was found during [ongoing refresh](/overview/ongoing-refresh) of a previously connected account. > [!NOTE] > > Webhooks are not specific to individual accounts. The [`ratings.added`](/api-reference/ratings-webhooks/added) webhook for example is sent every time a new rating is available for any connected account. ## Subscribing to webhooks > [!NOTE] > > Each [environment](/api-guide/overview#environments) (Sandbox and Production) requires its own webhook subscriptions. Subscriptions do not transfer between environments. 1. Navigate to the [Webhooks section of Console](https://console.argyle.com/webhooks) under **Developers**. 2. Select "Create a new webhook". ![Webhooks can be created in the Developers section of Console.](https://mintcdn.com/argyle/NMp3ek9jel7nGcQ8/images/console/management/webhooks/1-webhooks.png?fit=max\&auto=format\&n=NMp3ek9jel7nGcQ8\&q=85\&s=18bfcdd90f2d946eeb61a63fcea37d9a) 3. Fill in the following fields: * **Name** — Your name for this particular set of webhook subscriptions. * **URL** — Where you want webhooks to be sent. This can be either a backend URL that you manage, or a URL provided by a webhook management service. > [!NOTE] > > Argyle delivers webhooks from four static IP addresses: > [!NOTE] > > * `34.27.251.226` > * `34.122.50.253` > * `35.188.163.115` > * `35.226.53.251` * **Secret** — (Optional) A secret word or phrase that can be used to [authenticate webhooks](/api-guide/webhooks#verifying-webhooks) you receive. 4. Choose your desired set of webhooks. * `partially_synced` webhooks require you to input how many days of data must be synced during the initial data retrieval process of a newly connected account before the webhook is sent. * Webhooks with `{}` following their names, when selected individually ("Specific event(s)"), return additional account information in the webhook payload if the "include resource" box is checked (found below the list of webhooks). ![You can subscribe to webhooks through Console.](https://mintcdn.com/argyle/NMp3ek9jel7nGcQ8/images/console/management/webhooks/2-webhooks.png?fit=max\&auto=format\&n=NMp3ek9jel7nGcQ8\&q=85\&s=e83c242eca7b697d919fbe5d7dfbdd03) # Overview Source: https://docs.argyle.com/console/overview Console is where you learn about, manage, and operate Argyle. ## Getting started If you haven't already, [log in](https://console.argyle.com/) to begin exploring Console first-hand. ![View and manage data users share through Argyle in Console.](https://mintcdn.com/argyle/zs6lb-w1jQV9DVbr/images/overview/how-argyle-works/3-how-argyle-works.png?fit=max\&auto=format\&n=zs6lb-w1jQV9DVbr\&q=85\&s=1106b7f4f15e8975df2090e84a497cd2) We've designed Console in a way that walks you through how to: * Get started connecting accounts. * Select a **Connection** to view data and generate reports. * Invite someone, yourself, or a [test user](/overview/sandbox-testing) to connect an account through Link. * Use the **Dashboard** to monitor accounts and view other metrics. * Find developer tools, including API keys. ## Test mode When the "Sandbox mode" toggle at the top of Console is enabled, all of Console switches into a testing environment. You can customize Link's payroll connection experience in **Flows** and test it on sample users, see the sample accounts appear in the **Connections** tab, and select a sample user to view their payroll data or generate a report. Or, head over to **Settings** to test out different email and text invite templates. When previewing embedded flows, you can also [create custom Sandbox users](/overview/sandbox-testing#create-custom-users) for specific income and employment scenarios and reuse them across your organization. After testing, disable the "Sandbox mode" toggle to begin connecting real accounts. ## Sections of Console ### Dashboard * See which employers and payroll platforms are the most selected. * Compare how many account connections have happened across different time periods. * Check which Link customizations have the highest connection success rate, and where users drop off. ### Flows * Customize and preview account connections in Link. * Adjust Link to enable [document uploading](/workflows/document-processing) or bypass search to [directly connect](/workflows/account-connections#direct-login) a user to a specific payroll login. ### Connections * View successful and attempted account connections. * Invite and re-send invites, or check the status of a previously sent invite. * Monitor accounts to make sure they continue to be [continuously scanned for new data](/overview/ongoing-refresh). * Select a connected account to view payroll data, payroll documents, and generate reports. ### Coverage * Explore Argyle's extensive list of supported payroll connections. * Filter and sort Items by their [type](/overview/data-structure/items#types-of-items), [health status](/overview/data-structure/items#health-status), [mapping status](/api-reference/items#object-mapping_status), or whether they support [ongoing refresh](/overview/ongoing-refresh). * Select a specific Item to see exactly which data fields are supported. ### Developers * Obtain and create API keys. * Subscribe to and manage automatic [webhook notifications](/console/management/webhooks). * Integrate third party business systems. ### Settings * Manage membership roles, billing, and access permissions. * Enable or disable organization-level features and user invitation settings. ### Get started * Zoom out to learn more about different parts of Console and Argyle. ### Contact support * Select the **?** to reach out if you need assistance. # Verifications Source: https://docs.argyle.com/console/verifications Order, track, and review payroll and banking verifications in Console. Use **Verifications** in [Console](https://console.argyle.com/) to order payroll and banking verifications, follow their progress, and download the reports. Consumers use an invitation link to share their data through Argyle. > [!NOTE] > > Contact your Customer Success Manager to enable verifications in Console. You can also track [verifications ordered through Encompass, the API, or other partner systems](#orders-from-other-systems) and download their reports in Console. Manage these orders in the system where they were placed. ## Order a verification 1. Sign in to Console, open **Verifications**, and select **Order verification**. 2. Select a **Flow**, if prompted. The flow determines the consumer experience and the options shown in the form. 3. Choose the reports you need. You can order income and employment, assets, or both, depending on the products enabled for your organization. | Section | Report options | | - | - | | **Income and employment** | Payroll VOIE or Payroll VOE | | **Assets** | Banking VOA, Banking VOAI, or Banking VOE | For payroll, you can optionally select the consumer's employers. For banking, choose an **Account history** period using a preset or a custom start date. ![Income and employment and Assets sections of the Console order form.](https://mintcdn.com/argyle/iwmWf-j2l2xQ82RU/images/argyle-guides/console/verifications/order-reports.png?fit=max\&auto=format\&n=iwmWf-j2l2xQ82RU\&q=85\&s=14bb59d16caf9f070547e08afbbb62ba) 4. If **Send invite via** is shown, choose from the available options: **Email and SMS (recommended)**, **Email only**, or **SMS only**. The options depend on your organization's settings. 5. Enter the consumer's first and last name, plus the contact details required for your invitation method. Banking orders also require the consumer's state and either their date of birth or SSN. You can optionally add a loan number for your internal reference. 6. Select **Submit order**, review the confirmation, and confirm the order. ![Send invite via and Consumer sections of the Console order form.](https://mintcdn.com/argyle/iwmWf-j2l2xQ82RU/images/argyle-guides/console/verifications/order-invitation.png?fit=max\&auto=format\&n=iwmWf-j2l2xQ82RU\&q=85\&s=12bb3263f30049fae95c77a0908338ac) For email or SMS orders, the consumer receives an invitation via the selected method. If your organization uses manual sharing, **Send invite via** is hidden and submitting the order generates a link without sending email or SMS. Use **Copy link** to share it with the consumer. You can follow each verification's progress in Console after the consumer opens the invitation and shares their payroll or banking data. ## Find and track verifications Switch between two views on the **Verifications** page: * **Consumer view** groups verifications by consumer and shows the latest verification for each product. * **Verification view** shows each verification as a separate row, including earlier orders for the same consumer. Search by name, email, phone number, or loan number. Use the status tabs or **Filters** to narrow the list by status, report type, data source, created date, requester, or origin. For example, filter by **Origin** to find verifications ordered through Encompass. | Status | What it means | | - | - | | **Pending** | The consumer still needs to complete the requested steps. | | **In progress** | Data is syncing or the verification is being processed. | | **Action required** | Select the consumer to review the issue and recommended next steps. | | **Completed** | Results are available to review. | | **Cancelled** | The verification has ended without completion. | ## Review reports and documents Select a consumer. The **Income and employment** and **Assets** sections show verification status, data sources, and available reports. Hover over a verification's status to see when it was ordered and who requested it. Use the download button beside a report to open its PDF. Payroll paystubs and tax documents are also available when provided by the connected source. [Doc VOI](/verifications/verification-types/document-voi) results appear alongside payroll and banking verifications. You can review available results and documents. Ordering Doc VOI verifications in Console will be made available in the future. ![Completed payroll and banking verifications with reports, paystubs, and tax documents available to download.](https://mintcdn.com/argyle/iwmWf-j2l2xQ82RU/images/argyle-guides/console/verifications/reports-and-documents.png?fit=max\&auto=format\&n=iwmWf-j2l2xQ82RU\&q=85\&s=e9556672dd2ab2297fdc351e9959be8c) ## Managing Console orders ### Resend an invitation or copy its link For invitations sent by email or SMS, use **Resend** to send the invitation again through the original channels. Use **Copy link** to copy a connection invitation URL you can send directly to the consumer. These actions are available from the list or the consumer's details when an invitation is available. ![Copy link and Resend actions at the top of a consumer's details.](https://mintcdn.com/argyle/iwmWf-j2l2xQ82RU/images/argyle-guides/console/verifications/invitation-actions.png?fit=max\&auto=format\&n=iwmWf-j2l2xQ82RU\&q=85\&s=98e8f4e415fcf18d87858c7379f6240f) ### Refresh a completed verification Open the consumer and select **Refresh** in the relevant section. Choose an available report type and follow the option shown: * **Instant refresh:** When the existing connection supports a refresh, generate a new report without asking the consumer to take action. * **Request updated data:** If the consumer needs to reconnect, follow the prompts to request updated data. * **Use existing data:** When offered, generate a report using the data already available. This does not ask the consumer to reconnect or provide newer data. For eligible banking refreshes, you can also adjust the account history and select which accounts to include. The resulting report is added to the consumer's report history; previous reports remain available. ![Refresh Assets panel with report type, account history, account selection, and Generate report controls.](https://mintcdn.com/argyle/iwmWf-j2l2xQ82RU/images/argyle-guides/console/verifications/refresh-verification.png?fit=max\&auto=format\&n=iwmWf-j2l2xQ82RU\&q=85\&s=27bf4819fd0d643fe5129f0c57a2c052) ### Cancel an order Use **Cancel** on a verification in **Pending** or **Action required**, then confirm the cancellation. Cancelling an order does not delete accounts the consumer has already connected. To start again after cancellation, select **Order verification** from the consumer's details. Existing consumer information is prefilled in the order form. ## Orders from other systems Verifications ordered through the API, Encompass, or another partner system are view-only in Console. You can review their status and download available reports and documents. Send reminders, refresh, or cancel those verifications in the system where they were ordered. ## Test in Sandbox Enable **Sandbox mode** in Console to try the verification workflow with test data. See [Sandbox Testing](/overview/sandbox-testing) for test users and connection credentials, and turn Sandbox mode off before ordering for real consumers. # Data APIs Source: https://docs.argyle.com/data-apis/overview Retrieve payroll records, uploaded documents, and OCR results. Use the Data APIs when your application needs payroll records, uploaded documents, or OCR results for its own workflow. See [Verifications vs. Data APIs](/overview/verifications-vs-data-apis) to compare individual records with completed reports and choose your implementation path. Users connect their payroll accounts through [Link](/link/overview). Your application tracks each account independently, waits for the required data, and retrieves the relevant resources from the API. > [!NOTE] > > The Data APIs workflow on this page does not apply to banking. For bank connections and reports, use [Banking Verifications](/verifications/verification-types/banking). The account connection steps below apply to payroll data; for uploaded documents and OCR results, see [Document uploads](#document-uploads). ## Implementation path **1. Create or reuse a user** Reuse the person's existing [user ID](/overview/data-structure/users) if they have already used another product with your organization. Otherwise, [create a user](/api-reference/users/create-a-user) and store the returned ID with your internal record. **2. Start the connection experience** Create a [user token](/api-reference/user-tokens/create-a-user-token), then launch [embedded or hosted Link](/link/initialization/overview). **3. Track connected accounts** Subscribe to the [`accounts.added`](/api-reference/accounts-webhooks/added), [`accounts.updated`](/api-reference/accounts-webhooks/updated), and [`accounts.failed`](/api-reference/accounts-webhooks/failed) webhooks. Treat each connected account as an independent data source. **4. Wait for the data you need** Use resource webhooks and the [`users.fully_synced`](/api-reference/users-webhooks/fully-synced) webhook to determine when the required data is available. See [Data Delivery and Readiness](/overview/data-delivery). **5. Retrieve data sets** Retrieve identities, paystubs, payroll documents, gigs, shifts, vehicles, ratings, and other available resources through the corresponding endpoints. When using identities with paystubs or payroll documents, use the `employment` field to [match records for the same employment](/overview/data-structure/employments). An account can contain records from more than one job. ## Data structure Argyle organizes connected payroll data around [users](/overview/data-structure/users), [accounts](/overview/data-structure/accounts), [employments](/overview/data-structure/employments), [data sets](/overview/data-structure/data-sets), and [Items](/overview/data-structure/items). > [card] [Data Delivery and Readiness](/overview/data-delivery) > > Understand when initial data is available and which webhooks indicate progress. > [card] [Ongoing Refresh](/overview/ongoing-refresh) > > Monitor connected accounts for new data and required reconnections. ## Document uploads Users can upload documents through [Link](/workflows/document-processing#user-uploads-within-link), or you can [upload files through the API](/api-reference/user-uploads/upload-a-document). A payroll connection is not required. Retrieve the files through [User Uploads](/api-reference/user-uploads). When OCR is enabled, use [OCR webhooks](/integrations/ocr/ocrolus#ocr-webhooks) to track processing and retrieve the results from `metadata.ocr_documents[]` on the upload object. See [Document Uploads](/workflows/document-processing) for setup instructions and [OCR and Authenticity](/integrations/ocr/ocrolus) for result fields and errors. ## Verticals Some verticals use direct Data APIs; others use the Verifications lifecycle. [Explore Verticals](/verticals) to find implementation guidance for your industry or program. > [!NOTE] > > If you need a standardized verification lifecycle and report instead of direct resource retrieval, start with [Verifications](/verifications/overview). # Guides Source: https://docs.argyle.com/guides Choose how you want to build with Argyle. > [card] [Verifications](/verifications/overview) > > Order payroll, banking, and Doc VOI verifications, then track each request and retrieve completed reports. > [card] [Data APIs](/data-apis/overview) > > Retrieve payroll records, uploaded documents, and OCR results through the API. ## Tools and workflows > [card] [Overview](/overview/how-argyle-works) > > Learn how Argyle works, how data is structured, and how to test in Sandbox. > [card] [Workflows](/workflows/account-connections) > > Build account connection and document upload workflows. > [card] [Integrations](/integrations/pos-los/encompass/verifications) > > Connect Argyle to the POS, LOS, and partner systems your team uses. > [card] [Console](/console/overview) > > View and manage data, customize settings, and test in Sandbox. > [card] [Link](/link/overview) > > Let users connect accounts by email, text, or directly in your product. > [card] [API Guide](/api-guide/overview) > > Get started with authentication, webhooks, and Postman. # Build with Argyle Source: https://docs.argyle.com/index Choose a verification workflow or build directly with data users share through Argyle. ## Guides > [card] [Verifications](/verifications/overview) > > Order payroll, banking, and Doc VOI verifications, then track each request and retrieve completed reports. > [card] [Data APIs](/data-apis/overview) > > Retrieve payroll records, uploaded documents, and OCR results through the API. > [card] [Use Cases](/verticals) > > Implementation guides for mortgage, tenant screening, lending, and other verticals. > [card] [Link](/link/overview) > > Let users connect accounts by email, text, or directly in your product. > [card] [Console](/console/overview) > > View and manage data, customize settings, and test in Sandbox. > [card] [Integrations](/integrations/pos-los/encompass/verifications) > > Connect Argyle to the POS, LOS, and partner systems your team uses. > [card] [API Guide](/api-guide/overview) > > Get started with Argyle's APIs, webhooks, and Postman. ## References > [card] [API Reference](/api-reference/overview) > > Endpoints and webhooks, example requests and responses, and error codes. # Day 1 Certainty® and AIM Source: https://docs.argyle.com/integrations/d1c-aim/verifications Achieve Day 1 Certainty® and AIM eligibility through Argyle income and employment verifications. ## Overview Income and employment verification reports can support: * Day 1 Certainty® through [Fannie Mae's Desktop Underwriter® (DU®) validation service](https://singlefamily.fanniemae.com/media/9011/display). * Assessment of borrower income and employment through [Freddie Mac's asset and income modeler (AIM)](https://sf.freddiemac.com/tools-learning/loan-advisor/our-solutions/aim-asset-income-modeler). > [!NOTE] > > Reach out to your Customer Success Manager to enable Argyle's Day 1 Certainty and AIM functionality. 1. Borrowers [connect their payroll accounts](/workflows/account-connections) and share payroll data through Link. 2. The completed verification provides a report and the required reference number. 3. Lenders submit the reference number to Fannie Mae's DU validation service and/or Freddie Mac's Loan Product Advisor® (LPASM℠) with the loan casefile. Fannie Mae and Freddie Mac receive the verification report and underlying income and employment data. After the information is validated, Day 1 Certainty® or AIM eligibility is returned for eligible loans. ## Console ### Generating verification reports 1. After a borrower has connected their payroll account(s), go to the [Connections](https://console.argyle.com/connections) section of Console. 2. Select the individual borrower from the Connections table. 3. Select **Generate report**. See [Reports](/overview/data-structure/reports) for the current API paths. ![Select a report type.](https://mintcdn.com/argyle/lpddaw6ggr_B1oHD/images/argyle-guides/overview/reports/2-reports.png?fit=max\&auto=format\&n=lpddaw6ggr_B1oHD\&q=85\&s=d34aa1c9917451462bb1600912714f82) ### Locating reference numbers A `Reference #` is listed at the top of the verification report and can be submitted to Fannie Mae for Day 1 Certainty® and Freddie Mac for AIM eligibility determinations. ![The reference number will be listed at the top of the report.](https://mintcdn.com/argyle/YfkJ8p61ic0_0yX5/images/argyle-guides/integrations/d1c/2-D1C.png?fit=max\&auto=format\&n=YfkJ8p61ic0_0yX5\&q=85\&s=6afe80846c7711a64ef2d41799036262) ## API ### Webhooks Argyle provides a [`reports.ready`](/api-reference/reports-webhooks/ready) webhook that will notify you when sufficient data has been retrieved from the borrower's connected payroll account(s) to generate a verification report. You can subscribe to this webhook [via Console](/console/management/webhooks), or via the API by sending a POST request to `https://api.argyle.com/v2/webhooks`. In the API request body, include a JSON object in the following format: ```json theme={} { "events": ["reports.ready"], "name": "My webhook", "url": "https://your-webhook-backend.com", "secret": "" // Optional. } ``` The `reports.ready` webhook's payload provides a list of the borrower's payroll accounts that have synced a sufficient amount of data to be used in the report. > [!NOTE] > > The [accounts.connected](/api-reference/accounts-webhooks/connected) and [accounts.failed](/api-reference/accounts-webhooks/failed) webhooks can be used to track multiple account connections. Compare them to the accounts listed in the `reports.ready` webhook payload to determine when to generate a report. ```json theme={} { "event": "reports.ready", "name": "name-for-the-webhook-subscription", "data": { "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69", "resource": { "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69", "external_id": "March Connection", "accounts": [ { "id": "0185a8b8-60eb-80ca-7482-5f24504573f7", "last_synced_at": "2024-01-08T12:55:04.016Z" }, { "id": "0187c66e-e7e5-811c-b006-2232f00f426a", "last_synced_at": "2024-01-08T12:58:06.023Z" } ], "documents": [] } } } ``` ### Requesting verification reports Send a **POST** request to the [reports endpoint](/api-reference/reports#generate) — `https://api.argyle.com/v2/reports/voie-mortgage` > [!NOTE] > > The [report type](/api-reference/reports#generate-type) is specified in the request path — e.g. `/voie-mortgage` or `/voe-mortgage` In the API request body, include a JSON object in the format below: ```json theme={} { "user": "018b8255-4ab1-be4b-aa2c-e9ff41d75809" // ID of the user } ``` The initial API response will include the `id` of the report. After the report is generated, this `id` can be used to retrieve the report and is also the `Reference #` that can be submitted to Fannie Mae and/or Freddie Mac. ```json theme={} { "id": "e0dbf946-a400-419c-946f-0adc7b5fbe36", // ID of the report "user": "018b8255-4ab1-be4b-aa2c-e9ff41d75809", "reference_id": "e0dbf946-a400-419c-946f-0adc7b5fbe36", "generated_at": "2024-01-23T20:46:03.254Z", "created_at": "2024-01-23T20:46:03.254Z", "type": "voie-mortgage", "status": "generating", "file_url": "www.argyle.com/storagename/pdf", "json_url": "www.argyle.com/storagename/json", "accounts": [ { "id": "0185a8b8-60eb-80ca-7482-5f24504573f7", "item": "item_123456789", "last_synced_at": "2024-01-08T12:55:04.016Z" }, { "id": "0187c66e-e7e5-811c-b006-2232f00f426a", "item": "item_000000001", "last_synced_at": "2024-01-08T12:58:06.023Z" } ], "metadata": {}, "last_synced_at": "2024-01-08T12:58:06.023Z", "external_id": "March Connection" } ``` ### Retrieving reference numbers Send a **GET** request to the reports endpoint — `https://api.argyle.com/v2/reports/{id}` > [!NOTE] > > Include the `id` of the report as the path parameter. The report object returned in the API response will contain: * An `id` field with the `Reference #` that can be submitted to both Fannie Mae and Freddie Mac. * A `metadata` object containing the eligible accounts and employments (as determined by Fannie Mae and Freddie Mac's guidelines) that were included in the report. ```json theme={} { "id": "e0dbf946-a400-419c-946f-0adc7b5fbe36", // Reference number "user": "018b8255-4ab1-be4b-aa2c-e9ff41d75809", "reference_id": "e0dbf946-a400-419c-946f-0adc7b5fbe36", "generated_at": "2024-01-23T20:46:03.254Z", "created_at": "2024-01-23T20:46:03.254Z", "type": "voie-mortgage", "status": "generated", "file_url": "www.argyle.com/storagename/pdf", "json_url": "www.argyle.com/storagename/json", "last_synced_at": "2024-01-22T16:44:25.889Z", "accounts": [ { "id": "0185a8b8-60eb-80ca-7482-5f24504573f7", "item": "item_123456789", "last_synced_at": "2024-01-08T12:55:04.016Z" }, { "id": "0187c66e-e7e5-811c-b006-2232f00f426a", "item": "item_000000001", "last_synced_at": "2024-01-08T12:58:06.023Z" } ], "metadata": { "d1c_report": { "status": "available", "accounts": [ "0185a8b8-60eb-80ca-7482-5f24504573f7", // D1C eligible account "0187c66e-e7e5-811c-b006-2232f00f426a", // D1C eligible account ], "employments": [ "b967118b-7d81-3c1b-bce0-c24d631cf5aa", "c235635a-5c55-2b8e-eba5-d99a326ad7ea", ] }, "aim_report": { "status": "available", "accounts": [ "0185a8b8-60eb-80ca-7482-5f24504573f7", // AIM eligible account "0187c66e-e7e5-811c-b006-2232f00f426a", // AIM eligible account ], "employments": [ "b967118b-7d81-3c1b-bce0-c24d631cf5aa", "c235635a-5c55-2b8e-eba5-d99a326ad7ea" ] } }, "external_id": "March Connection" } ``` If the loan is not eligible for Day 1 Certainty and/or AIM, `not_available` will be shown in the `metadata` object in the respective area: ```json theme={} "metadata": { "d1c_report": { "status": "not_available", "accounts": [], "employments": [] }, "aim_report": { "status": "not_available", "accounts": [], "employments": [] } } ``` If you are retrieving a report's contents in JSON format via the report's `json_url`, the `report_id` field will list the `Reference #`: ```json theme={} { "report_id": "e0dbf946-a400-419c-946f-0adc7b5fbe36", // Reference number "type": "voie-mortgage", "user_id": "018051aa-f7a9-a0db-2f38-6cfa325e9d69", "external_id": "March Connection", "created_at": "2024-03-15T18:44:53.830Z", "last_synced_at": "2024-01-08T12:58:06.023Z", "metadata": { "d1c_report": { "status": "available", "accounts": [ "0185a8b8-60eb-80ca-7482-5f24504573f7", "0187c66e-e7e5-811c-b006-2232f00f426a", ], "employments": [ "b967118b-7d81-3c1b-bce0-c24d631cf5aa", "c235635a-5c55-2b8e-eba5-d99a326ad7ea", ] }, "aim_report": { "status": "available", "accounts": [ "0185a8b8-60eb-80ca-7482-5f24504573f7", "0187c66e-e7e5-811c-b006-2232f00f426a", ], "employments": [ "b967118b-7d81-3c1b-bce0-c24d631cf5aa", "c235635a-5c55-2b8e-eba5-d99a326ad7ea" ] } }, "employments": [ { "employment": "b967118b-7d81-3c1b-bce0-c24d631cf5aa", "account": "0185a8b8-60eb-80ca-7482-5f24504573f7", "last_synced_at": "2024-01-08T12:55:04.016Z", "source": "Worknight", "first_name": "Bob", "last_name": "Jones", "full_name": "Bob Jones", "birth_date": "1980-10-10", "ssn": "522-09-1191", "phone_number": "+18009000010", "email": "bob@email.com", "employee_address": { "line1": "342 Fence Rd", "line2": null, "city": "New York", "state": "NY", "postal_code": "10014", "country": "US" }, "employer": "Whole Goods", "employer_address": { "line1": "852 North W St", "line2": null, "city": "New York", "state": "NY", "postal_code": "10014", "country": "US" }, "status": "active", "employment_type": "full-time", "job_title": "Store Manager", "base_pay": { "amount": "75372.62", "currency": "USD", "period": "annual" }, "pay_cycle": "monthly", "start_date": "2020-08-28", "original_hire_date": "2020-08-28", "end_date": null, "length_of_work": { "years": "2", "months": "6" }, "last_pay_period_end_date": "2023-03-22", "last_paystub_date": "2023-03-24", "income": [ { "period": "2023", "currency": "USD", "gross_pay": { "total": "25124.20", "base": "25124.20", "overtime": "0.00", "commission": "0.00", "bonus": "0.00", "other": "0.00" } }, { "period": "2022", "currency": "USD", "gross_pay": { "total": "82866.32", "base": "81653.65", "overtime": "0.00", "commission": "881.09", "bonus": "331.58", "other": "0.00" } }, { "period": "2021", "currency": "USD", "gross_pay": { "total": "87854.76", "base": "81653.65", "overtime": "5774.51", "commission": "426.60", "bonus": "0.00", "other": "0.00" } } ], "monthly_income": { "argyle": { "total": "7102.33", "base": "6902.55", "overtime": "165.94", "bonus": "5.22", "commission": "28.62", "other": "0.00" } }, "callouts": [] }, { "employment": "c235635a-5c55-2b8e-eba5-d99a326ad7ea", "account": "0187c66e-e7e5-811c-b006-2232f00f426a", "last_synced_at": "2024-01-08T12:58:06.023Z", "source": "Bullseye", "first_name": "Bob", "last_name": "Jones", "full_name": "Bob Jones", "birth_date": "1980-10-10", "ssn": "522-09-1191", "phone_number": "+18009000010", "email": "bob@email.com", "employee_address": { "line1": "342 Fence Rd", "line2": null, "city": "New York", "state": "NY", "postal_code": "10014", "country": "US" }, "employer": "Bullseye", "employer_address": { "line1": "119 Green Ridge", "line2": null, "city": "New York", "state": "NY", "postal_code": "10014", "country": "US" }, "status": "active", "employment_type": "part-time", "job_title": "Clerk", "base_pay": { "amount": "61030.57", "currency": "USD", "period": "annual" }, "pay_cycle": "monthly", "start_date": "2020-06-29", "original_hire_date": "2020-06-29", "end_date": null, "length_of_work": { "years": "2", "months": "9" }, "last_pay_period_end_date": "2023-02-23", "last_paystub_date": "2023-02-24", "income": [ { "period": "2023", "currency": "USD", "gross_pay": { "total": "20848.92", "base": "20343.52", "overtime": "0.00", "commission": "0.00", "bonus": "505.40", "other": "0.00" } }, { "period": "2022", "currency": "USD", "gross_pay": { "total": "68070.08", "base": "66116.44", "overtime": "0.00", "commission": "777.54", "bonus": "1176.10", "other": "0.00" } }, { "period": "2021", "currency": "USD", "gross_pay": { "total": "68378.52", "base": "66116.44", "overtime": "0.00", "commission": "641.94", "bonus": "1620.14", "other": "0.00" } } ], "monthly_income": { "argyle": { "total": "5683.51", "base": "5512.92", "overtime": "0.00", "bonus": "119.51", "commission": "51.08", "other": "0.00" } }, "callouts": [] } ] } ``` ## Encompass When you use the Argyle Encompass® integration, the required GSE report identifiers are populated automatically in the loan file. See the [Day 1 Certainty® and AIM section](/integrations/pos-los/encompass/verifications#day-1-certainty-and-aim) of the Encompass Guide for details and the payroll and Doc VOI field mappings. ## Empower Visit the [Day 1 Certainty® and AIM section](/integrations/pos-los/empower#day-1-certainty-and-aim) of our Empower Guide for more information on submitting reference numbers through the Empower® LOS platform. ## MeridianLink Reference numbers can be submitted for Day 1 Certainty® through the [MeridianLink® LOS platform](https://www.meridianlink.com/solutions/loan-origination-system/). 1. [Copy a `Reference #` from the verification report.](/integrations/d1c-aim/verifications#locating-reference-numbers) 2. Within the MeridianLink® LOS: 1. Open the **Services** dropdown in the left sidebar and select **Submit to DO / DU**. 2. In the **DU Validation** section: 1. Select `Argyle` as the **3rd Party Data Provider Name**. 2. Insert the `Reference #` from Argyle's report into the **Reference Number** field. 3. Submit the loan to Fannie Mae's DU® validation service. ## LendingPad 1. Select **Income Asset Verification** from the **Loan Application** dropdown. 2. Select `Income` as the **Type**. 3. Select `Argyle` as the **Contact**. 4. [Copy a `Reference #` from the verification report.](/integrations/d1c-aim/verifications#locating-reference-numbers). 5. Paste the `Reference #` as the **Identifier**. 6. Submit the loan file for AUS as normal. ![Argyle can be submitted through LendingPad AUS.](https://mintcdn.com/argyle/YfkJ8p61ic0_0yX5/images/argyle-guides/integrations/d1c/5-D1C.png?fit=max\&auto=format\&n=YfkJ8p61ic0_0yX5\&q=85\&s=783da008a7fc59b773f0a580db313eb5) ## Byte BytePro's Fannie Mae and Freddie Mac LPA interfaces let you reissue verifications via **Verification Services**. ![Argyle can be submitted through Byte LOS.](https://mintcdn.com/argyle/YfkJ8p61ic0_0yX5/images/argyle-guides/integrations/d1c/6-D1C.png?fit=max\&auto=format\&n=YfkJ8p61ic0_0yX5\&q=85\&s=b482e6da67eaa62932d45e157dedaf42) 1. Select `Interfaces > Fannie Mae` or `Interfaces > Freddie Mac` 2. Select either: * `DO` or `DU XIS` for Fannie Mae * `LPA System-to-System` for Freddie Mac 3. Proceed to **Verification Services**. 4. On the **Edit Service Order** screen: * Select your `Vendor Type` > [!NOTE] > > * Use `Other` + `Argyle` for Fannie Mae > * Use `Other` + `ARGL` for Freddie Mac * Select your `Verification Type` > [!NOTE] > > * Select `Income` * Input the `Reference Number` > [!NOTE] > > * Include the borrower's `Social Security Number` before Argyle's [`Reference Number`](/integrations/d1c-aim/verifications#locating-reference-numbers) > * Use a colon `:` separator: > * For example: `1112224444:018d226-945d-64c6-1a0e-c10ab893707e` > * Values are case-sensitive and may include non-alphanumeric characters such as hyphens # OCR and Authenticity Source: https://docs.argyle.com/integrations/ocr/ocrolus OCR and Authenticity information for document uploads. Argyle offers uploaded document processing through [Ocrolus' optical character recognition (OCR) service](https://www.ocrolus.com/). The text within uploaded documents is scanned, and the authenticity of the document is evaluated. The results are made available to view directly in Console or retrieve via Argyle's API. > [!NOTE] > > Ocrolus is available for W-2, 1099, and paystub [document uploads](/workflows/document-processing). ![Image showing the process of integrating third party OCR data with Argyle.](https://mintcdn.com/argyle/X2Ud-Ls5bpXC3Xsk/images/argyle-guides/integrations/document-ocr-processors/1-OCR.png?fit=max\&auto=format\&n=X2Ud-Ls5bpXC3Xsk\&q=85\&s=6de9ad37fde8b3ebf60776ae3d35fa3a) ## Uploading documents Documents can be uploaded via Argyle's API or directly by users through Argyle Link. > [!NOTE] > > Refer to our [Document Processing Guide](/workflows/document-processing#uploading-documents) for more information on setting up document uploads. ## Document classification After documents are uploaded, you can optionally choose to classify the documents. This classification pre-processing step will return: * The document type (e.g. paystubs or W-2) * Key data fields (e.g. pay date or year) This document information can be used to decide which documents are sent to full OCR data extraction and authenticity analysis (i.e. send only paystubs to full OCR). > [!NOTE] > > If you are interested in document classification, reach out to your Argyle customer success manager. ## Retrieving OCR data ### Console ![Uploaded document OCR information can be viewed by selecting the JSON toggle within the Connections sections of Console.](https://mintcdn.com/argyle/X2Ud-Ls5bpXC3Xsk/images/argyle-guides/integrations/document-ocr-processors/2-OCR.png?fit=max\&auto=format\&n=X2Ud-Ls5bpXC3Xsk\&q=85\&s=15a597c09e758e006539b57076d826f8) 1. Select an individual user within the [Connections](https://console.argyle.com/connections) section of Console. 2. When viewing **Uploaded documents**: * An `OCR` tag is shown when OCR data is available. * The **Authenticity** column will display the document's [Authenticity score](/integrations/ocr/ocrolus#authenticity-scores). 3. Click the `{} JSON` toggle to view OCR data and detailed Authenticity information. * The [`ocr_documents`](/api-reference/user-uploads#object-metadata-ocr_documents) array contains OCR and authenticity results for each detected document. > [!NOTE] > > Refer to Ocrolus' documentation for [data field descriptions](https://docs.ocrolus.com/docs/capture) and [how document authenticity is evaluated](https://docs.ocrolus.com/docs/authenticity-score). 4. Click the `View summary` button to view a summary of authenticity information for the uploaded document. > [!NOTE] > > Additional OCR data including employee, employer, and income details will also be shown for paystubs. ![Summary information of document authenticity returned by Ocrolus can be viewed in Console.](https://mintcdn.com/argyle/X2Ud-Ls5bpXC3Xsk/images/argyle-guides/integrations/document-ocr-processors/3-OCR.png?fit=max\&auto=format\&n=X2Ud-Ls5bpXC3Xsk\&q=85\&s=46a236fa361202ed5b0c193b1e16c898) ### API Uploaded documents can be retrieved through Argyle's [`/user-uploads`](/api-reference/user-uploads) endpoint. `metadata.ocr_documents` contains OCR and authenticity results for each document detected within the uploaded file. > [accordion] Example JSON — Uploaded document with OCR and Authenticity data > > ```json theme={} > { > "id": "0187bf23-cd80-118d-c0b8-58023e21c8e5", > "account": "01856c65-43b6-8b5d-b32a-56b8fbda5c28", > "document_type": "paystub", > "file_url": "www.argyle.com/storagename", > "file_name": "2024_10_paystub.pdf", > "status": "submitted", > "metadata": { > "ocr_data": {}, // Deprecated in favor of ocr_documents > "ocr_authenticity": {}, // Deprecated in favor of ocr_documents.ocr_authenticity > "ocr_authenticity_score": 40, // Deprecated in favor of ocr_documents.ocr_authenticity_score > "ocr_documents": [ > { > "ocr_data": { > "uuid": "d38a23ef-835e-4e72-a5d3-9fefc3e5a989", > "status": "COMPLETED", > "net_pay": { > "totals": { > "ytd_pay": { > "amount": null, > "currency": null > }, > "current_pay": { > "amount": "426.93", > "currency": "USD" > }, > "description": "NET PAY", > "canonical_description": null > }, > "distribution_details": [ > { > "bank_name": null, > "current_pay": { > "amount": "426.93", > "currency": "USD" > }, > "description": "CHECKING 1699", > "account_number": "1699", > "bank_account_type": "CHECKING" > } > ] > }, > "doc_uuid": "3b43a2fb-0b2b-4c9b-a24c-26e216c3426f", > "earnings": { > "totals": [ > { > "ytd_pay": { > "amount": "1399.80", > "currency": "USD" > }, > "current_pay": { > "amount": "427.05", > "currency": "USD" > }, > "description": "GROSS PAY", > "current_hours": "28.47", > "canonical_description": null > } > ], > "subtotals": [ > { > "ytd_pay": { > "amount": "1324.80", > "currency": "USD" > }, > "current_pay": { > "amount": "427.05", > "currency": "USD" > }, > "description": "REGULAR", > "current_rate": "15.0000", > "current_hours": "28.47", > "canonical_description": "REGULAR PAY" > }, > { > "ytd_pay": { > "amount": "75.00", > "currency": "USD" > }, > "current_pay": { > "amount": "45.00", > "currency": "USD" > }, > "description": "SURGE PREM $ 5", > "current_rate": "5.000", > "current_hours": "9.00", > "canonical_description": "OTHER" > } > ] > }, > "employee": { > "name": "BOB JONES", > "address": { > "city": null, > "line1": "759 VICTORIA PLAZA", > "line2": null, > "state_code": "NY", > "postal_code": "10014" > }, > "taxpayer_id": { > "id_type": null, > "last_4_digits": null > }, > "marital_status": "SINGLE" > }, > "employer": { > "name": "WAREHOUSE SERVICES INC", > "address": { > "city": "SEATTLE", > "line1": "202 WESTLAKE AVE N", > "line2": null, > "state_code": "WA", > "postal_code": "98109" > } > }, > "book_uuid": "b6ded9fb-72b9-45ab-b788-deeeb424bc4b", > "confidence": "EXACT_MATCH", > "deductions": { > "totals": [], > "subtotals": [ > { > "ytd_pay": { > "amount": "20.30", > "currency": "USD" > }, > "current_pay": { > "amount": "6.85", > "currency": "USD" > }, > "description": "MEDICARE TAX", > "canonical_description": "MEDICARE TAX" > }, > { > "ytd_pay": { > "amount": "14.00", > "currency": "USD" > }, > "current_pay": { > "amount": "9.00", > "currency": "USD" > }, > "description": "MO STATE INCOME TAX", > "canonical_description": "STATE TAX" > }, > { > "ytd_pay": { > "amount": "86.79", > "currency": "USD" > }, > "current_pay": { > "amount": "29.27", > "currency": "USD" > }, > "description": "SOCIAL SECURITY TAX", > "canonical_description": "SOCIAL SECURITY TAX" > } > ] > }, > "ocr_page_count": 1, > "paystub_details": { > "pay_date": "2020-12-28", > "pay_frequency": null, > "paystub_provider": "ADP", > "pay_period_end_date": "2020-12-26", > "pay_period_start_date": "2020-12-16", > "pay_frequency_captured": "NOT LISTED" > }, > "doc_page_numbers": [ > 1 > ], > "rejection_reason": null, > "confidence_scores": [ > { > "key": "earnings.subtotals[0].current_hours", > "confidence": 1.0 > }, > { > "key": "earnings.subtotals[0].ytd_pay.amount", > "confidence": 1.0 > }, > { > "key": "deductions.subtotals[2].current_pay.amount", > "confidence": 1.0 > }, > { > "key": "net_pay.distribution_details[0].account_number", > "confidence": 1.0 > }, > { > "key": "deductions.subtotals[0].description", > "confidence": 1.0 > }, > { > "key": "earnings.subtotals[0].description", > "confidence": 1.0 > }, > { > "key": "earnings.totals[0].current_hours", > "confidence": 1.0 > }, > { > "key": "earnings.subtotals[1].description", > "confidence": 1.0 > }, > { > "key": "deductions.subtotals[0].ytd_pay.amount", > "confidence": 1.0 > }, > { > "key": "deductions.subtotals[0].current_pay.amount", > "confidence": 1.0 > }, > { > "key": "net_pay.distribution_details[0].current_pay.amount", > "confidence": 1.0 > }, > { > "key": "earnings.totals[0].current_pay.amount", > "confidence": 1.0 > }, > { > "key": "net_pay.distribution_details[0].bank_account_type", > "confidence": 1.0 > }, > { > "key": "deductions.subtotals[1].ytd_pay.amount", > "confidence": 1.0 > }, > { > "key": "earnings.subtotals[1].ytd_pay.amount", > "confidence": 1.0 > }, > { > "key": "deductions.subtotals[2].ytd_pay.amount", > "confidence": 1.0 > }, > { > "key": "earnings.subtotals[0].current_pay.amount", > "confidence": 1.0 > }, > { > "key": "earnings.subtotals[1].current_rate", > "confidence": 1.0 > }, > { > "key": "deductions.subtotals[1].current_pay.amount", > "confidence": 1.0 > }, > { > "key": "earnings.totals[0].ytd_pay.amount", > "confidence": 1.0 > }, > { > "key": "earnings.subtotals[0].current_rate", > "confidence": 1.0 > }, > { > "key": "net_pay.totals.current_pay.amount", > "confidence": 1.0 > }, > { > "key": "earnings.subtotals[1].current_pay.amount", > "confidence": 1.0 > }, > { > "key": "deductions.subtotals[2].description", > "confidence": 1.0 > }, > { > "key": "deductions.subtotals[1].description", > "confidence": 1.0 > }, > { > "key": "earnings.subtotals[1].current_hours", > "confidence": 1.0 > }, > { > "key": "employment_details.annual_salary.amount", > "confidence": 1.0 > }, > { > "key": "employee.address.city", > "confidence": 1.0 > }, > { > "key": "employee.address.line1", > "confidence": 1.0 > }, > { > "key": "employee.address.line2", > "confidence": 1.0 > }, > { > "key": "employee.address.postal_code", > "confidence": 1.0 > }, > { > "key": "employee.address.state_code", > "confidence": 1.0 > }, > { > "key": "employee.name", > "confidence": 1.0 > }, > { > "key": "employer.address.city", > "confidence": 1.0 > }, > { > "key": "employer.address.line1", > "confidence": 1.0 > }, > { > "key": "employer.address.line2", > "confidence": 1.0 > }, > { > "key": "employer.address.postal_code", > "confidence": 1.0 > }, > { > "key": "employer.address.state_code", > "confidence": 1.0 > }, > { > "key": "employer.name", > "confidence": 1.0 > }, > { > "key": "employment_details.hire_date", > "confidence": 1.0 > }, > { > "key": "employment_details.hourly_rate.amount", > "confidence": 1.0 > }, > { > "key": "employee.marital_status", > "confidence": 1.0 > }, > { > "key": "net_pay.totals.ytd_pay.amount", > "confidence": 1.0 > }, > { > "key": "employment_details.pay_basis", > "confidence": 1.0 > }, > { > "key": "paystub_details.pay_date", > "confidence": 1.0 > }, > { > "key": "paystub_details.pay_frequency_captured", > "confidence": 1.0 > }, > { > "key": "paystub_details.pay_period_end_date", > "confidence": 1.0 > }, > { > "key": "paystub_details.pay_period_start_date", > "confidence": 1.0 > }, > { > "key": "paystub_details.paystub_provider", > "confidence": 1.0 > }, > { > "key": "employee.taxpayer_id.last_4_digits", > "confidence": 1.0 > } > ], > "employment_details": { > "hire_date": null, > "pay_basis": "HOURLY", > "hourly_rate": { > "amount": null, > "currency": null > }, > "annual_salary": { > "amount": null, > "currency": null > } > }, > "uploaded_image_bucket_uuid": null > }, > "ocr_authenticity": { > "book_uuid": "e048543d-043f-441a-b1cf-524328034ddf", > "doc_analysis": [ > { > "detect_status": "COMPLETED", > "form_analysis": [ > { > "signals": [ > { > "identifier": "earnings_edits", > "page_number": 1, > "display_name": "Earnings Edits", > "signal_count": 1, > "supporting_data": [ > { > "values": [ > { > "key": "field_name", > "value": "earnings:grossPay(Current)", > "data_type": "str" > }, > { > "key": "original_text", > "value": "427.05", > "data_type": "str" > }, > { > "key": "tampered_text", > "value": "100.000", > "data_type": "str" > } > ] > } > ] > } > ], > "form_type": "PAYSTUB", > "form_uuid": "83fc263e-4463-4ed1-aeeb-407ed3123178", > "form_authenticity": { > "score": 40, > "version": "1.0", > "reason_codes": [ > { > "code": "004-H", > "confidence": "HIGH", > "description": "original document recovered" > }, > { > "code": "330-H", > "confidence": "HIGH", > "description": "paystub earnings tampered" > } > ] > } > } > ], > "uploaded_doc_type": "PAYSTUB", > "uploaded_doc_uuid": "56fc50b0-d162-43d0-ab1a-809b85b3a3c1", > "is_image_based_pdf": false > } > ] > }, > "ocr_authenticity_score": 40 > }, > { > "ocr_data": {}, > "ocr_authenticity": {}, > "ocr_authenticity_score": null > } > ] > }, > "created_at": "2023-03-17T10:40:00.672Z", > "updated_at": "2023-03-17T10:45:20.035Z" > } > ``` The following fields contain OCR and authenticity information: * `ocr_documents` — Array. Contains one OCR and authenticity result for each document detected within the uploaded file. * `ocr_data` — Deprecated object. Use `ocr_documents[].ocr_data`. * `ocr_authenticity` — Deprecated object. Use `ocr_documents[].ocr_authenticity`. * `ocr_authenticity_score` — Deprecated integer. Use `ocr_documents[].ocr_authenticity_score`. > [!NOTE] > > Refer to Ocrolus' documentation for [data field descriptions](https://docs.ocrolus.com/docs/capture) and [how document authenticity is evaluated](https://docs.ocrolus.com/docs/authenticity-score). > > > [!NOTE] > > > > Argyle does not return HTTP or Ocrolus-specific status codes returned by the Ocrolus API. ## Authenticity scores Authenticity scores are [determined by Ocrolus](https://docs.ocrolus.com/docs/authenticity-score). | Score range | Authenticity level | Examples | | - | - | - | | 0-29 | Very low authenticity | Identity information (SSN, employee name, address) tampering | | 30-49 | Low authenticity | Created as a template, income tampering | | 50-79 | Medium authenticity | Editing software detected, dates tampering, fields misaligned | | 80+ | High authenticity | Document is an image (80 score) | > [!NOTE] > > Available for paystubs, W-2s, and the following 1099 forms: 1099-MISC, 1099-K, 1099-R, and SSA-1099. ## OCR webhooks Subscribe to the following webhooks to be notified of OCR updates: * [`user_uploads.ocr_completed`](/api-reference/user-uploads-webhooks/ocr-completed) * [`user_uploads.ocr_failed`](/api-reference/user-uploads-webhooks/ocr-failed) * [`user_uploads.ocr_authenticity`](/api-reference/user-uploads-webhooks/ocr-authenticity) ## OCR errors If an uploaded document cannot be processed by Ocrolus, an `error` object will be returned in `ocr_documents`. This `error` object will contain: * A `status` field listing the [Ocrolus document status](https://docs.ocrolus.com/docs/document-status). For errors, the value will either be `FAILED` or `REJECTED`. * A `rejection_reason` field listing the [Ocrolus rejection reason](https://docs.ocrolus.com/docs/rejection-reasons) for `REJECTED` documents. The two most common rejection errors are: * `DOCUMENT TYPE NOT SUPPORTED` — For example, a bank statement was submitted when a paystub was expected. * `DOCUMENT IS UNREADABLE` — The document was too blurry to read and could not be processed. ```json theme={} "metadata": { "ocr_documents": [ { "ocr_data": { "error": { "pk": 80352036, "md5": "e623b68dc110aad14158fdba31d40c6f", "name": "form/paystubs/4e6ad54c-4232-4459-9e20-96fa721b9a38", "uuid": "2cba5abd-3a2d-48a1-b786-0c6d4550d4ea", "pages": 1, "status": "REJECTED", "document_class": "COMPLETE", "image_group_pk": null, "rejection_reason": "DOCUMENT TYPE NOT SUPPORTED", "mixed_uploaded_doc_pk": null, "rejection_reason_description": null } }, "ocr_authenticity": {}, "ocr_authenticity_score": null } ] } ``` # Consumer Connect Source: https://docs.argyle.com/integrations/pos-los/consumer-connect Let borrowers complete payroll and banking connection steps within Consumer Connect. Encompass® Consumer Connect is a digital mortgage point-of-sale (POS) platform developed by ICE Mortgage Technology®. With Argyle embedded in Consumer Connect, borrowers can connect payroll and financial accounts through guided flows within their application. Consumer Connect imports the employment, income, and asset data borrowers share through those connections. Supported payroll documents and verification reports are routed to Encompass®. ## Employment & Income ### Overview Incorporating Argyle makes the borrower experience truly paperless: 1. Borrowers connect their payroll accounts through Argyle within Consumer Connect. 2. Payroll data shared by the borrower populates supported loan application fields. 3. Imported payroll documents and verification reports are made available in the [Encompass® integration](/integrations/pos-los/encompass/verifications) for the borrower's loan file. ![Connect borrowers through Argyle within the Consumer Connect mortgage platform to easily retrieve the borrower's payroll information.](https://mintcdn.com/argyle/YfkJ8p61ic0_0yX5/images/argyle-guides/integrations/consumer-connect/1-consumer-connect.png?fit=max\&auto=format\&n=YfkJ8p61ic0_0yX5\&q=85\&s=c58ce4a0677b3076d1fef5913e24ac16) ### Borrower experience #### Starting a new loan application 1. Borrowers apply through your Consumer Connect site. 2. Borrowers register for an account or log in to an existing one. > [!NOTE] > > Borrowers must be registered and logged in to their account to access third-party services such as Argyle. #### Importing employment and income 1. When borrowers arrive at the **Employment and Income** section of the application, they first need to provide their consent to having their employment and income data imported by a third-party provider. 2. After consent, borrowers must select `Import Employment/Income` ![In the Employment and Income section of the application, borrowers need to select Import Employment/Income in the upper right.](https://mintcdn.com/argyle/YfkJ8p61ic0_0yX5/images/argyle-guides/integrations/consumer-connect/6-consumer-connect.png?fit=max\&auto=format\&n=YfkJ8p61ic0_0yX5\&q=85\&s=535cc2b7ff7d330b5f8a20ecd3e71e35) 3. The borrower will then fill out preliminary information such as their name, social security number, and date of birth (this information is typically pre-filled). Once completed, the borrower must click `Next` to open the Argyle interface: ![The Argyle interface will help guide the borrower in connecting their payroll accounts.](https://mintcdn.com/argyle/YfkJ8p61ic0_0yX5/images/argyle-guides/integrations/consumer-connect/7-consumer-connect.png?fit=max\&auto=format\&n=YfkJ8p61ic0_0yX5\&q=85\&s=b143e469e6b19b19802a891ed3ed1f12) #### Connecting payroll via Argyle 1. Argyle's interface will guide the borrower through the process of logging in to their employers or payroll providers to establish a data connection. ![Borrower connect their employers and payroll providers via Argyle using a simple process that only requires their login credentials.](https://mintcdn.com/argyle/YfkJ8p61ic0_0yX5/images/argyle-guides/integrations/consumer-connect/8-consumer-connect.png?fit=max\&auto=format\&n=YfkJ8p61ic0_0yX5\&q=85\&s=244d576c87ae09cb249adcf8918dd243) 2. After the account connects, payroll data begins importing. If more employment history is required, the borrower is prompted to connect another account. Otherwise, the borrower can select `Done` and return to the application. ![After the borrower connects their accounts, the experience either requests more employment history or lets the borrower finish.](https://mintcdn.com/argyle/YfkJ8p61ic0_0yX5/images/argyle-guides/integrations/consumer-connect/9-consumer-connect.png?fit=max\&auto=format\&n=YfkJ8p61ic0_0yX5\&q=85\&s=736bebb9c1e3adbc37ecb9ac63942d0b) ### Payroll data populates the application After the borrower completes the connection process, supported employment and income data populates the application and maps to the loan file, including: * Borrower Employer Information (including start date and length of employment) * Borrower Gross Monthly Income ### Payroll documents and verification reports available in Encompass Imported payroll documents and verification reports are made available within the [Encompass® integration](/integrations/pos-los/encompass/verifications) for the borrower's loan file. ### Admin setup 1. Log in to the **[Consumer Connect Admin](http://admin.elliemae.com/encompassconsumerconnect)** portal via Encompass®. 2. Go to **Services Management** and select `Argyle` as the **Provider** next to **Employment and Income Verification Settings**. ![Select Argyle in Services Management for Employment and Income Verification.](https://mintcdn.com/argyle/YfkJ8p61ic0_0yX5/images/argyle-guides/integrations/consumer-connect/2-consumer-connect.png?fit=max\&auto=format\&n=YfkJ8p61ic0_0yX5\&q=85\&s=6526d5c3722de80b04ad7a0db5763827) 3. When prompted, enter your Argyle API key and secret, which can be found in the [Developers section](https://console.argyle.com/api-keys) of Argyle Console. ![Enter your API key and secret, which can be found or created in Argyle Console.](https://mintcdn.com/argyle/YfkJ8p61ic0_0yX5/images/argyle-guides/integrations/consumer-connect/3-consumer-connect.png?fit=max\&auto=format\&n=YfkJ8p61ic0_0yX5\&q=85\&s=de26e7ad5fd4dbd099b3887843ca0ec2) 4. Navigate to the **LOAN APP WORKFLOWS** section of the navigation menu, then select `Create Workflow` ![Select Create Workflow in the upper right after select LOAN APP WORKFLOWS.](https://mintcdn.com/argyle/YfkJ8p61ic0_0yX5/images/argyle-guides/integrations/consumer-connect/4-consumer-connect.png?fit=max\&auto=format\&n=YfkJ8p61ic0_0yX5\&q=85\&s=23f82d955f746ed6a6bcb8ac6d8345fe) 5. Within **Admin Configurations**, open the **Service Settings** toggle. 6. Scroll down to **VOE/VOI** and `enable the toggle` then click `Save` ![Enable the VOE/VOI toggle then save.](https://mintcdn.com/argyle/YfkJ8p61ic0_0yX5/images/argyle-guides/integrations/consumer-connect/5-consumer-connect.png?fit=max\&auto=format\&n=YfkJ8p61ic0_0yX5\&q=85\&s=758d3ebd6be3a1ccd26bbea479bf3bf3) *For further assistance, please reach out to [support@argyle.com](mailto:support@argyle.com) or your Customer Success Manager.* ### Testing profiles 1. Choose `Argyle Sandbox` when selecting a **Provider** during step 2 of [Admin setup](/integrations/pos-los/consumer-connect#admin-setup). ![Select Argyle Sandbox in Services Management for Employment and Income Verification.](https://mintcdn.com/argyle/YfkJ8p61ic0_0yX5/images/argyle-guides/integrations/consumer-connect/10-consumer-connect.png?fit=max\&auto=format\&n=YfkJ8p61ic0_0yX5\&q=85\&s=00d091cf7a9656ae5b57a0fcc7e725a8) 2. When testing [connecting payroll via Argyle](/integrations/pos-los/consumer-connect#connecting-payroll-via-argyle), use the following test credentials of Argyle's sample users: | | Bob | Sarah | Joe\* | | - | - | - | - | | Email | test1\@argyle.com | test2\@argyle.com | test3\@argyle.com | | Username | test\_1 | test\_2 | test\_3 | | Password | passgood | passgood | passgood | | Verification code | 8081 | 8082 | 8083 | | Phone number | (800) 900-0010 | (800) 900-0020 | (800) 900-0030 | | Driver's license # | D1230010 | D1230020 | D1230030 | 3. For specific scenario testing, the following sample users are also available: | | Homer Loanseeker | Suzi Builder | Andy Freddie | | - | - | - | - | | Email | homer\_loanseeker\@argyle.com | suzi\_builder\@argyle.com | andy\_freddie\@argyle.com | | Username | homer\_loanseeker | suzi\_builder | andy\_freddie | | Password | passgood | passgood | passgood | | Verification code | 9081 | 9084 | 9088 | | Phone number | (800) 900-0101 | (800) 900-0104 | (800) 900-0108 | | Driver's license # | D1230101 | D1230104 | D1230108 | | **Returns** | **1 active employment** | **2 active employments** | **1 active and 1 terminated employment** | ## Financial accounts ### Overview Argyle also provides a native bank connection experience within Consumer Connect: 1. Borrowers connect their financial accounts within the Argyle experience. 2. Asset data will automatically populate the borrower's Consumer Connect application. 3. After importing to Encompass®: * Argyle will automatically generate a verification of assets (VOA) or verification of assets and income (VOAI) report. * Asset data will automatically be added to the 1003 URLA and report identifiers required by GSEs will be added to the Encompass® loan file. * Closing verification of employment (VOE) reports can be ordered as needed within Encompass®. ### Borrower experience 1. Borrower selects `Import Assets` within the **Assets** section of their application. ![Import Assets is selected on the Assets tab of Consumer Connect.](https://mintcdn.com/argyle/YfkJ8p61ic0_0yX5/images/argyle-guides/integrations/consumer-connect/11-consumer-connect.png?fit=max\&auto=format\&n=YfkJ8p61ic0_0yX5\&q=85\&s=5ee70bf72c2fe7db55bd820158364ffa) 2. The borrower will then fill out preliminary information such as their name, social security number, and date of birth (this information is typically pre-filled). ![The borrower enters preliminary information within the application.](https://mintcdn.com/argyle/YfkJ8p61ic0_0yX5/images/argyle-guides/integrations/consumer-connect/12-consumer-connect.png?fit=max\&auto=format\&n=YfkJ8p61ic0_0yX5\&q=85\&s=3c2f79adfb3e995eaffb24d4e69ce090) 3. Once completed, the borrower must click `Next`. The borrower will then be guided through the process of logging in to their financial institutions to establish a data connection. ![Borrower connect their financial institutions using a simple process that only requires their login credentials.](https://mintcdn.com/argyle/YfkJ8p61ic0_0yX5/images/argyle-guides/integrations/consumer-connect/13-consumer-connect.png?fit=max\&auto=format\&n=YfkJ8p61ic0_0yX5\&q=85\&s=d097835cf0482fc2e542fdaa2daeee18) 4. For each financial institution, the borrower will select which associated accounts to connect. ![After providing their login credentials and establishing a connection to their financial institution, the borrower will select which financial accounts associated with that institution to connect.](https://mintcdn.com/argyle/YfkJ8p61ic0_0yX5/images/argyle-guides/integrations/consumer-connect/14-consumer-connect.png?fit=max\&auto=format\&n=YfkJ8p61ic0_0yX5\&q=85\&s=8f25a928e58610d077575437cfd545ba) ### Asset data populates the application After the borrower completes the connection process, supported asset data from the selected financial accounts begins importing into the Consumer Connect application. The borrower can add other assets manually or continue the application. ### Asset data and verification reports available in Encompass The borrower's asset data can be imported to Encompass®. Argyle will automatically generate a verification of assets (VOA) or verification of assets and income (VOAI) report and add it to the loan file, in addition to populating asset data in the 1003 URLA and report identifiers required by GSEs within the Encompass® loan file. > [!NOTE] > > Closing verification of employment (VOE) reports can also be ordered as needed within Encompass®, as long as a verification of assets and income (VOAI) report has previously been generated. ### Admin setup 1. Log in to the **[Consumer Connect Admin](http://admin.elliemae.com/encompassconsumerconnect)** portal via Encompass®. 2. Go to **Services Management** and select `Finicity` as the Provider next to **Asset Verification**. ![Select Finicity in Services Management for Asset Verification.](https://mintcdn.com/argyle/YfkJ8p61ic0_0yX5/images/argyle-guides/integrations/consumer-connect/2-consumer-connect.png?fit=max\&auto=format\&n=YfkJ8p61ic0_0yX5\&q=85\&s=6526d5c3722de80b04ad7a0db5763827) 3. When prompted, enter your **Application Key**, **Partner ID**, and **Partner Secret**. > [!NOTE] > > Reach out to your Argyle representative to obtain these integration credentials. ![Enter your API key and secret, which will be provided to you by Argyle.](https://mintcdn.com/argyle/YfkJ8p61ic0_0yX5/images/argyle-guides/integrations/consumer-connect/15-consumer-connect.png?fit=max\&auto=format\&n=YfkJ8p61ic0_0yX5\&q=85\&s=69d0efa81af6a7b2138b3e75b3d68fca) 4. Navigate to the **LOAN APP WORKFLOWS** section of the navigation menu, then select `Create Workflow` ![Select Create Workflow in the upper right after select LOAN APP WORKFLOWS.](https://mintcdn.com/argyle/YfkJ8p61ic0_0yX5/images/argyle-guides/integrations/consumer-connect/16-consumer-connect.png?fit=max\&auto=format\&n=YfkJ8p61ic0_0yX5\&q=85\&s=6453648bf0a90d67d81c124b24fa83b9) 5. Within **Admin Configurations**, open the **Service Settings** toggle. 6. Scroll down to **Asset Verification** and `enable the toggle` then click `Save` ![Enable the Asset Verification toggle then save.](https://mintcdn.com/argyle/YfkJ8p61ic0_0yX5/images/argyle-guides/integrations/consumer-connect/17-consumer-connect.png?fit=max\&auto=format\&n=YfkJ8p61ic0_0yX5\&q=85\&s=3a350e9603edb04fa76cf778e9b166e8) *For further assistance, please reach out to [support@argyle.com](mailto:support@argyle.com) or your Customer Success Manager.* ### Testing profiles 1. Use [sample banking credentials](https://developer.mastercard.com/open-banking-us/documentation/test-the-apis/#bank-account-profiles) to log into either the `FinBank Billable` or `FinBank Oauth Billable` financial institutions for testing. 2. For specific scenario testing, the following sample users are also available: | | Sue Wealthy | River Paycheck | Alex Student | | - | - | - | - | | Username | sue\_wealthy | river\_paycheck | alex\_student | | Password | profile\_700 | profile\_703 | profile\_704 | | Description | Sue is working as a Product Manager with a good steady income, a mortgage, and multiple investment accounts. She has a loan account and leases a car. Sue travels a few times a year. She has typical expenses like groceries, clothes, entertainment, gym membership, car expenses, and she has a pet. | River works in construction. He rents an apartment and has typical expenses like groceries, clothes, entertainment, household and car expenses. He has some savings but no investments, no loans and no credit cards. In some months, River's expenses exceed his income. | Alex is working full-time with a good salary but she is still paying off her student loan. She makes regular monthly repayments, but she still has over \$30,000 to pay off. Alex has typical expenses like groceries, clothes, entertainment, household, and car expenses. She has limited savings and she has started an investment account. | # Empower Source: https://docs.argyle.com/integrations/pos-los/empower Verify income and employment within the Empower® LOS platform. ## Overview Entirely within the Empower® Loan Origination Platform, loan teams can order income and employment verifications using payroll data borrowers share from connected accounts. * Generate **Verification of Income** and **Verification of Employment** reports. * Access and view **W-2s** and **paystubs** from connected payroll accounts. * **Re-verify employment** prior to final closing. ## How it works 1. Loan officers select Argyle as the **Exchange Verification** provider and choose a product: * Initial Verification of Income (VOI) and Verification of Employment (VOE) * Re-verification of Employment (VOE only) 2. After submitting a verification order, the borrower is invited to [connect their payroll accounts](/workflows/account-connections) through Link. 3. The following documents are made available in the Empower® **Document Repository**: * VOI and VOE report PDFs * The borrower's last two W-2s * The borrower's paystubs from the last 30 days ## Enabling the integration 1. Reach out to your Empower® account representative to enable Argyle's verification of income and employment integration. 2. Once you receive your Party ID from Empower®, go to the [Integrations section](https://console.argyle.com/integrations) of Argyle Console and **Enable** the integration. 3. Enter your Party ID and assign it to Sandbox (testing) or Production. Multiple Party ID's can be added and assigned independently. ![Enable Argyle's integration with Empower by entering your Party IDs within the Integrations section of Argyle Console.](https://mintcdn.com/argyle/X2Ud-Ls5bpXC3Xsk/images/argyle-guides/integrations/empower/13-empower.png?fit=max\&auto=format\&n=X2Ud-Ls5bpXC3Xsk\&q=85\&s=5e82e4666b9be71e0ba48099f6e5f50b) ## Ordering a verification 1. Select **Exchange Verifications** from within a loan file and **Begin a New Order (Service Request)**. 2. Choose `Argyle` as the verification **Provider**. 3. Select a verification **Product** — `VOE/VOI` or `Employment Re-verification`. 4. Choose `Conventional` as the **Program Code**. 5. In the **Additional Property Information** section, within the **Contact Type** dropdown select `Primary Borrower`. > [!NOTE] > > Argyle does not currently support multi-borrower orders — we recommend restricting verification orders to one borrower at a time through your Empower settings. 6. Input the **Full Name**, **E-Mail Address**, and **Day Phone** of the borrower (if not already auto-populated). 7. In the **Loan Information** section, within the **Contact Type** dropdown select either `Processor` or `Underwriter` depending on the loan officer's role. 8. Input the **Full Name**, **E-Mail Address**, and **Day Phone** of the loan officer (if not already auto-populated). 9. In the **Borrower Information** section, within the **Primary Borrower** dropdown select the `[Name]` of the primary borrower. 10. Click **Validate Submission Data** in the toolbar to ensure all required fields have been filled. 11. Click **Submit Request** in the toolbar. An **Order Status** of `Ordered submitted` followed by `Order acknowledged` will appear at the bottom of the page. 12. After an order is submitted, the borrower will be invited via text (SMS) and email to connect their payroll account(s) through Argyle. ![Argyle Link is where payroll accounts are connected through Argyle.](https://mintcdn.com/argyle/lpddaw6ggr_B1oHD/images/argyle-guides/overview/how-argyle-works/2-how-argyle-works.png?fit=max\&auto=format\&n=lpddaw6ggr_B1oHD\&q=85\&s=96be0a3aabb072d52174af0a459527e2) ## (Optional) Event notifications Ask your Empower® admin to set up event notifications, so when different events are received (such as a `150 — Product Delivered` event) loan officers are notified that Argyle verifications reports and the borrower's payroll documents are now available in the Empower® **Document Repository**. ## Retrieving reports and documents Select `Document Repository` in the sidebar to view VOI and VOE reports, W-2s, and paystubs retrieved from the borrower's payroll account(s) once an order has completed. ## Day 1 Certainty® and AIM Argyle's income and employment verification reports provide lenders an automated way to achieve Day 1 Certainty® through [Fannie Mae's Desktop Underwriter® (DU®) validation service](https://singlefamily.fanniemae.com/media/9011/display) and assessment of borrower income and employment through [Freddie Mac's asset and income modeler (AIM)](https://sf.freddiemac.com/tools-learning/loan-advisor/our-solutions/aim-asset-income-modeler). > [!NOTE] > > Reach out to your Customer Success Manager to enable Argyle's Day 1 Certainty® and AIM functionality. To add a Day 1 Certainty® or AIM eligibility check for a loan through Empower®: 1. Ensure your Empower integration is configured to use Argyle with Fannie Mae's DU validation service and Freddie Mac's asset and income modeler (AIM). * For Day 1 Certainty®, refer to [Empower's Argyle Configuration Guide](https://res.cloudinary.com/argyle-media/image/upload/v1712082209/docs-2024/Empower_Configuration_to_use_Argyle_with_DU_1.pdf) (PDF). * For AIM, make these additional adjustments: 1. Update your Verification Providers `Display Value` to `Argyle` instead of `Argyle (DU Only)` 2. Insert an entry into your LPA Verification Providers and use Argyle's LPA enumeration: `ARGL` 2. A `Reference #` is listed at the top of the verification report and can be submitted to Fannie Mae for Day 1 Certainty® and Freddie Mac for AIM eligibility determinations: ![The DU reference number will be listed at the top of the report if the user is D1C eligible.](https://mintcdn.com/argyle/YfkJ8p61ic0_0yX5/images/argyle-guides/integrations/d1c/2-D1C.png?fit=max\&auto=format\&n=YfkJ8p61ic0_0yX5\&q=85\&s=6afe80846c7711a64ef2d41799036262) 3. Open **Desktop Underwriter** from the sidebar, then click **Asset Verification IDs** in the toolbar. 4. Select a borrower from the **Borrower Name** dropdown, then click **Add**. 5. Select either `Argyle (DU Only)` (if only submitting for Day 1 Certainty®) or `Argyle` from the **Asset Verification Provider** dropdown. Then enter the `Reference #` from Argyle's report in the **Asset Verification ID** field. *For further assistance or specific feature requests, contact [support@argyle.com](mailto:support@argyle.com) or your Customer Success Manager.* # Encompass Setup Guide Source: 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. For broker ordering through a wholesale lender's portal, use the [TPO Connect setup guide](/integrations/pos-los/encompass/tpo-connect#lender-admin-setup). ## Manual Ordering ### Admin login 1. Log in to [Encompass Web®](https://encompass.ice.com/admin) with an **administrator account** and select **Admin** within the applications dropdown. ### Add the Argyle service 1. Select **Services Management** within the **SERVICES** dropdown. 2. Select **Add Service** and choose the **Verifications** category. 3. Search for **Argyle** and then select **Manual**. ![Add Argyle as a loan service provider within the Services Management tab.](https://mintcdn.com/argyle/X2Ud-Ls5bpXC3Xsk/images/argyle-guides/integrations/encompass-2/1-encompass.png?fit=max\&auto=format\&n=X2Ud-Ls5bpXC3Xsk\&q=85\&s=bb9164dabb0fc7f22514e38e1e90487d) ### Add authorized users 1. Choose a **Service Setup Name** and add **Authorized Users**. 2. Click **Save**. ![Add Argyle as the loan service provider. Make sure the active toggle is ON.](https://mintcdn.com/argyle/X2Ud-Ls5bpXC3Xsk/images/argyle-guides/integrations/encompass-2/2-encompass.png?fit=max\&auto=format\&n=X2Ud-Ls5bpXC3Xsk\&q=85\&s=d736c56879c0037d55ab30bfe6d89dfc) ### Add Argyle API keys 1. After Argyle is added to your configured services, select **Credentials**. 2. In the pop-up, enter your Argyle API key and secret, which can be found or created in the [Developers section](https://console.argyle.com/api-keys) of Argyle Console. Then click **Save**. 3. After saving and exiting, set the **Status toggle** to **ON**. ![Enter your Argyle API keys (found in Console) in the Company Credentials pop-up.](https://mintcdn.com/argyle/X2Ud-Ls5bpXC3Xsk/images/argyle-guides/integrations/encompass-2/3-encompass.png?fit=max\&auto=format\&n=X2Ud-Ls5bpXC3Xsk\&q=85\&s=3a7a6d24ce4b71717f962c072535ccab) ### Enable Encompass in Argyle Console > [!NOTE] > > Your Argyle Customer Success Manager may have already completed this step for you. 1. Enable the Encompass integration in the [Integrations section](https://console.argyle.com/integrations) of Argyle Console by clicking **Enable**. 2. (Optional) Selecting **Edit** after enabling the integration allows you to select an invitation [Flow](/console/flows/email-sms-templates#creating-emailsms-templates) (customized borrower experience) from a dropdown of your saved Flows. ![You must enable Encompass in the Integrations section of Argyle Console.](https://mintcdn.com/argyle/X2Ud-Ls5bpXC3Xsk/images/argyle-guides/integrations/encompass/13-encompass.png?fit=max\&auto=format\&n=X2Ud-Ls5bpXC3Xsk\&q=85\&s=1a714c90df2460481c5890d6a1b643b9) ### Document mapping (optional) > [!NOTE] > > If **Doc Mapping** is not set up, documents will be routed to a verifications eFolder by default. 1. Select **Doc Mapping** to customize which **eFolder** should automatically receive each verification report type and retrieved payroll document. ![You can choose which eFolder should automatically receive reports and payroll documents.](https://mintcdn.com/argyle/X2Ud-Ls5bpXC3Xsk/images/argyle-guides/integrations/encompass-2/4-encompass.png?fit=max\&auto=format\&n=X2Ud-Ls5bpXC3Xsk\&q=85\&s=63af336c32e2122f4a51dded56fd0415) ### Customize experience (optional) To assign different [Link Flows](https://console.argyle.com/flows) to separate campaigns, branches, or doing-business-as (DBA) units, edit your Encompass configuration within the [Integrations section](https://console.argyle.com/integrations) of Console and assign Flows to specific OrgIDs. * The OrgID associated with each loan file will determine which Link Flow is used. * This allows you to have different branding for different branches, for example. ![You can assign Flows to specific Encompass OrgIDs.](https://mintcdn.com/argyle/0Z2zBY-iD5Q5BvPN/images/argyle-guides/integrations/encompass/16-encompass.png?fit=max\&auto=format\&n=0Z2zBY-iD5Q5BvPN\&q=85\&s=ec41b7b59a66383581d3d32f99cee44c) Your Argyle customer success manager can also help provide the following asset verification customizations: * Your company name and logo shown to borrowers can be adjusted. * Which financial institutions are shown by default on the home screen. * After the borrower connects a financial institution, they will be shown a list of detected accounts (for example checking, savings, or 401k accounts). > [accordion] You can exclude any of the following account types from being selectable by borrowers: > > * 457 > * 529 > * 401a > * 401k > * 403b > * Brokerage Account > * CD > * Checking > * Credit Card > * Crypto Currency > * Education Savings > * Employee Stock Purchase Plan > * Health Savings Account > * Investment > * Investment Tax Deferred > * IRA > * Keogh > * Line of Credit > * Loan > * Money Market > * Mortgage > * Non Taxable Brokerage Account > * Pension > * Profit Sharing Plan > * Rollover > * Roth > * Roth 401k > * Savings > * SEP IRA > * Simple IRA > * Student Loan > * Thrift Savings Plan > * UGMA > * Unknown > * UTMA > * Variable Annuity ## Automated Ordering Automate Argyle verification orders in Encompass® based on workflow rules and loan readiness conditions. Initial orders on broker-originated loans are also supported; see [TPO Connect automated ordering](/integrations/pos-los/encompass/tpo-connect#automated-ordering) for wholesale behavior and notifications. ### Notifications Email notifications for automated orders are sent to the email address of the first loan officer on the Encompass loan file. ### Admin login 1. Log in to [Encompass Web®](https://encompass.ice.com/admin) with an **administrator account** and select **Admin** within the applications dropdown. 2. Select **Automated Ordering Templates** within the **SERVICES** dropdown. 3. Select **Add**, then select **Verifications** in the dropdown. ![Open Automated Ordering Templates and choose the Verifications category when creating a new automated ordering rule.](https://mintcdn.com/argyle/NLQXOFTOJpenWboM/images/argyle-guides/integrations/encompass-2/16-encompass.png?fit=max\&auto=format\&n=NLQXOFTOJpenWboM\&q=85\&s=6e6993b7496475c0a7da81e97d581753) ### Add the Argyle service order 1. Select **Add** in the **Service Orders** section. 2. Select **Argyle** as the **Provider** then click **Create**. ![Create the automated verification order and select Argyle as the provider.](https://mintcdn.com/argyle/NLQXOFTOJpenWboM/images/argyle-guides/integrations/encompass-2/17-encompass.png?fit=max\&auto=format\&n=NLQXOFTOJpenWboM\&q=85\&s=03d34a1597e2f4871229300829e740ca) ### Configure automated conditions 1. Make sure the **Active** toggle is set to **ON**. 2. Select **Individual Level** as the **Evaluation Level**. 3. Provide a **Service Order Name**. 4. The following Automated Readiness Conditions check for the presence of first name, last name, email, and employer in the loan application. 5. Under **Borrower Settings**, make sure **Condition Editor** is selected and add the following Automated Readiness Conditions: ```text theme={} ([4000] <> "" AND [4002] <> "" AND ([1240] <> "") AND [FE0102] <> "") ``` 6. Under **Co-Borrower Settings**, make sure **Condition Editor** is selected and add the following Automated Readiness Conditions: ```text theme={} ([4004] <> "" AND [4006] <> "" AND ([1268] <> "") AND [FE0202] <> "") ``` ![Configure the automated service order, including evaluation level, service order details, and borrower readiness conditions.](https://mintcdn.com/argyle/NLQXOFTOJpenWboM/images/argyle-guides/integrations/encompass-2/18-encompass.png?fit=max\&auto=format\&n=NLQXOFTOJpenWboM\&q=85\&s=8363fd82510893e04db6417db782ea31) ### Add automated options 1. In either **Borrower Settings** or **Co-Borrower Settings**, select **Add** next to **Automated Options**. 2. When the **Automated Service Order Template** window opens, provide a **Template Name**, choose how borrowers should be contacted, and your desired report type. Then click **Create Template** and exit. * Each **Automated Service Order Template** supports one verification order. To automate both Payroll and Banking verifications for example, create a separate template for each report type. * If both Payroll and Banking orders are triggered within a short window, Argyle sends one combined borrower invite email. ![Configure the Automated Service Order Template with a template name, borrower contact method, and included report type.](https://mintcdn.com/argyle/qQjmaEMYtN1w6HsI/images/argyle-guides/integrations/encompass-2/19-automated-service-order-template.png?fit=max\&auto=format\&n=qQjmaEMYtN1w6HsI\&q=85\&s=7f1a503901ee0d141124914089623764) 3. The template will appear in both **Borrower Settings** and **Co-Borrower Settings**. Enable the radio button next to the template you created for both borrower and co-borrower. 4. Click **Continue**. ![Add automated options for borrower and co-borrower settings, then continue to save the service order.](https://mintcdn.com/argyle/NLQXOFTOJpenWboM/images/argyle-guides/integrations/encompass-2/19-encompass.png?fit=max\&auto=format\&n=NLQXOFTOJpenWboM\&q=85\&s=cfb6e2a67542b9952a8b9af7971ba821) ### Save the service order 1. The order you created should now appear under **Service Orders**. 2. Make sure both **ACTIVE** toggles are set to **ON**, then click **Save**. ![Save the automated service order after confirming it appears under Service Orders and both active toggles are enabled.](https://mintcdn.com/argyle/NLQXOFTOJpenWboM/images/argyle-guides/integrations/encompass-2/20-encompass.png?fit=max\&auto=format\&n=NLQXOFTOJpenWboM\&q=85\&s=fe8555129e1f0c4054bd9e7c7cfc3b07) ### Create the workflow rule 1. Select **Workflow Rules** within the **WORKFLOW MANAGEMENT** dropdown. 2. Select **New Rule**. 3. Provide a rule **Name**. Then adjust **Priority** and **Rule Effective** requirements as needed. 4. Select a **Triggering Event** in the **TRIGGERING EVENT** tab and complete the required fields. ![Set the workflow rule name, priority, effective timing, and triggering event details.](https://mintcdn.com/argyle/NLQXOFTOJpenWboM/images/argyle-guides/integrations/encompass-2/21-encompass.png?fit=max\&auto=format\&n=NLQXOFTOJpenWboM\&q=85\&s=d5967eea89b4973f8a1c645544b0d6e0) 5. Select the **RESULT** tab, then choose **Order Service** as the resulting action. Then click **Add**. 6. Under **Select Service Rule**, choose the service rule you created. Then click **Save**. ![Select the service rule you created in the Result tab, then save the workflow rule.](https://mintcdn.com/argyle/NLQXOFTOJpenWboM/images/argyle-guides/integrations/encompass-2/22-encompass.png?fit=max\&auto=format\&n=NLQXOFTOJpenWboM\&q=85\&s=3cdb0f11a4af6b826940a79a4eccb71b) 7. Make sure the **ACTIVE** toggle is **ON** for the saved workflow rule. *For further assistance, please reach out to [support@argyle.com](mailto:support@argyle.com) or your Customer Success Manager.* # Encompass TPO Connect Source: https://docs.argyle.com/integrations/pos-los/encompass/tpo-connect Set up wholesale verification ordering and broker-branded borrower invites in Encompass TPO Connect. Wholesale lenders can make Argyle available to their brokers in Encompass® TPO Connect. Brokers can order payroll, asset, and document-based income verifications from the lender's portal, with broker-branded invites when borrower action is needed. Orders use the wholesale lender's Argyle account, credentials, product permissions, and billing. Brokers access the service through the lender's TPO Connect portal. ## Lender admin setup Before starting, contact your Argyle Customer Success Manager to confirm TPO Connect availability and product access. You will need a TPO Connect administrator account and the lender's Argyle API key ID and secret for the correct environment. ### Add Argyle for manual ordering 1. Sign in to **TPO Connect Administration** and confirm that the correct site is selected. 2. Open **Services Management**, then select **Add Service**. 3. Filter **Service Type** to **Verifications**, search for **Argyle**, and select **Manual**. 4. Enter a **Service Setup Name**. Under **Authorized Users**, choose **All Organizations** or the broker organizations and personas that should have access. Click **Save**. 5. Open the saved service. Under **Company Credentials**, select **Add**, enter the lender's Argyle API key ID and secret, and save. 6. Return to the service list and turn the **ACTIVE** toggle **ON** for the Manual ordering option. > [!NOTE] > > Saving the service does not activate it. The **ACTIVE** toggle must be on before authorized brokers can use it. Confirm that the [Encompass integration is enabled in Argyle Console](/integrations/pos-los/encompass/setup-guide#enable-encompass-in-argyle-console). Review [Doc Mapping](/integrations/pos-los/encompass/setup-guide#document-mapping-optional) to choose where reports and documents are delivered in the lender's eFolder. ### Add Argyle to the loan navigation (optional) If your portal does not expose **Service Orders** to brokers, add a direct Argyle link to the loan navigation. You can skip this step if brokers already access Argyle through **Service Orders**. 1. In **TPO Connect Administration**, open **Navigation Menu Settings** and select the **Wholesale** tab. 2. Under **Loan Level - Left Navigation**, select **New Page Link**. 3. Under **Display Type**, select the manual service-order option **Option 1**. This opens Argyle each time a broker selects the link, including after a previous order. 4. Under **Display Label**, select the Argyle service you configured in **Services Management** for the correct environment. 5. Under **Menu Name**, enter the label brokers should see, such as **Argyle**. 6. Click **Apply**. Confirm that an authorized broker can see the link and use it to open Argyle from a loan. ### Configure the borrower experience Broker details are populated from the TPO order context. You do not need to create an Argyle account or an individual flow for each broker. The default wholesale flow displays the broker's name and contact details. For custom messaging, create a [Mortgage Wholesale template](/console/flows/email-sms-templates#wholesale-mortgage-templates) and configure the flow in the Encompass integration settings in Console. If you assign flows by OrgID, use a wholesale flow for broker-originated loans. > [!NOTE] > > Use `[Broker_company]` in a custom wholesale template to display the broker's company name from Encompass's **TPO Company Name** field (`TPO.x14`). See [flow selection](/verifications/wholesale-mortgage#choose-the-invite-flow) for how retail and wholesale flows are resolved. ## Broker ordering 1. Sign in to your wholesale lender's TPO Connect portal and open the loan. 2. Confirm the borrower details in **Borrower Information**, including **Section 1A**, and the employment details required for the verification type. 3. Open Argyle using the [link in the loan navigation](#add-argyle-to-the-loan-navigation-optional) if your lender provides one. Otherwise, select **Service Orders**, then **Order Service**. Choose **Verifications**, select **Argyle**, and click **Next**. 4. In Argyle, select the borrowers and verification methods. Review the borrower contact details for payroll and banking orders, or select **Add Documents** for Doc VOI. 5. Use **Notifications** to add team members who should receive order updates, then submit the order. Once Argyle opens, follow the [3-in-1 Verification Suite workflow](/integrations/pos-los/encompass/verifications#ordering-verifications) to track orders, view results, and request manual re-verifications. Reports and documents are delivered to the lender's Encompass loan file according to its document-mapping settings. ## Borrower experience ![A broker-branded email invitation opens a landing page where the borrower can connect payroll and bank accounts.](https://mintcdn.com/argyle/GL0Jr7nNNug7xalW/images/verifications/wholesale-borrower-experience.png?fit=max\&auto=format\&n=GL0Jr7nNNug7xalW\&q=85\&s=4d5415a06886b50c73783d76c21547ad) For payroll and banking orders, borrowers receive an email, SMS, or both, identifying their broker. The email and landing page show the broker's available contact details. Borrowers use one landing page to complete the requested payroll and bank connections. The lender remains named in the email footer and consent and data-sharing screens. Argyle Link and the banking connection experience may also display lender branding. Broker branding is retained when a later order requires the borrower to reconnect. Doc VOI uses the documents submitted with the order and does not send the borrower an invitation. ## Notifications | Order | Default notification recipient | Additional recipients | | - | - | - | | Manual initial order or re-verification requiring borrower action | The person placing the order; the TPO user for a broker-placed order | Add broker or lender team members through **Notifications**. | | Initial automated service order | The first loan officer on the loan file | The manual team-member CC selection is not available. | | Instant manual re-verification | No notification email | No borrower action is required. | The wholesale lender is not automatically copied on a broker's manual order. Add the lender's recipients in **Notifications** when they need email updates. ## Automated ordering Automated Service Ordering (ASO) supports initial verification orders on broker-originated loans. Argyle uses Encompass field `2626` at the loan level to identify whether the loan is retail or wholesale. For wholesale loans, ASO uses the broker details associated with the loan. The lender’s configured workflow rules and loan readiness conditions determine when the order is placed. Use the lender's [Automated Ordering setup](/integrations/pos-los/encompass/setup-guide#automated-ordering) for templates and workflow rules. Enabling **Manual** ordering in TPO Connect does not configure ASO. Create separate templates for payroll and banking orders. When both are triggered within a short window, the borrower receives one combined invite. Automated re-verification is not supported; use the [manual closing verification workflow](/integrations/pos-los/encompass/verifications#order-closing-verifications). # 3-in-1 Verification Suite Source: https://docs.argyle.com/integrations/pos-los/encompass/verifications Verify income, employment, & assets within the Encompass® by ICE Mortgage Technology® platform. ## Overview Argyle's 3-in-1 Verification Suite provides a single workflow within Encompass® for multiple verification methods, reducing manual fallbacks and shortening loan timelines. * Order **Income & Employment** and **Asset** verifications independently for multiple borrowers. * Receive **Day 1 Certainty® and AIM** eligibility determinations. * Order closing **Employment** verifications using refreshed data. ![Review completed Income & Employment and Asset orders in the Argyle Encompass workflow.](https://mintcdn.com/argyle/NLQXOFTOJpenWboM/images/argyle-guides/integrations/encompass-2/42-encompass.png?fit=max\&auto=format\&n=NLQXOFTOJpenWboM\&q=85\&s=e2badd1bc44eb3cc4dd9fe671deb787e) > [!NOTE] > > Wholesale lenders and brokers can also use the suite in [Encompass TPO Connect](/integrations/pos-los/encompass/tpo-connect), with broker-branded invites for payroll and banking orders. ## Loan officer workflow ### Required loan file details 1. Select a loan in Encompass®. 2. Provide the following required details: | Encompass section | Verification requirements | | - | - | | `1003 URLA Part 1` | Borrower details: **Payroll:** `First Name`, `Last Name`, `Email`, and `Phone Number` **Banking:** `First Name`, `Last Name`, `SSN`, `Birth Date`, `Address`, `Email`, and `Phone Number` **Documents:** `First Name`, `Last Name`, and `SSN` | | `1003 URLA Part 2` | Employer details: **Payroll:** `Employer Name(s)` \*if known **Documents:** `Employer Name(s)`, `Start Date(s)`, `End Date(s)` | ### Select Argyle as the provider 1. Under **Services**: * \[Web] Select **All Services** and then **Order Service**. In the pop-up, click **Verifications** under Categories. * \[SmartClient] Select **Order Verifications**. 2. In the pop-up, select **Argyle** under **Providers**. Then click **Next/Submit**. ![Select Argyle as the verification provider in Encompass.](https://mintcdn.com/argyle/X2Ud-Ls5bpXC3Xsk/images/argyle-guides/integrations/encompass-2/6-encompass.png?fit=max\&auto=format\&n=X2Ud-Ls5bpXC3Xsk\&q=85\&s=ca800adffb64454f167cf1bd5e5d7897) ### Ordering verifications 1. Select the borrower(s) and verification methods you want to order. 2. Review borrower contact details for payroll and banking verifications. > [!NOTE] > > Including both `Email` and `SMS` generally provides the best response rate. 3. (Optional) Select **Notifications** in the upper-right of the Argyle window to choose which team members should receive updates on verification orders. > [!NOTE] > > You can add or remove team members from notifications at any stage of the ordering process. Suggested team members are populated from contacts attached to the loan file. Standalone email addresses can also be entered. ![Select payroll-based Income & Employment and Assets for the borrower in the same Argyle order.](https://mintcdn.com/argyle/NLQXOFTOJpenWboM/images/argyle-guides/integrations/encompass-2/23-encompass.png?fit=max\&auto=format\&n=NLQXOFTOJpenWboM\&q=85\&s=af7e86b357aaefbb1cfd86a12396be2c) 4. For payroll verifications, adjust employments via `Edit Employers`. > [!NOTE] > > Argyle automatically attempts to match employers from the Encompass® loan file. 5. For asset verifications, adjust the desired `Account History` length. 6. For document verifications, selecting `Add Documents` will provide a list of required documents based on the borrower's current and previous employments. Select `Open eFolder` to upload documents from the eFolder or local drive. ![Instructions on which documents should be uploaded will be shown, alongside a button to open eFolder to select documents.](https://mintcdn.com/argyle/NLQXOFTOJpenWboM/images/argyle-guides/integrations/encompass-2/43-encompass.png?fit=max\&auto=format\&n=NLQXOFTOJpenWboM\&q=85\&s=edbfd519e4ef3f4c3a81ad58ce32aa7e) ### Track order progress 1. Submitted verifications are shown on the **Orders** screen and proceed independently. ![Verification order statuses shown next to borrower names in Encompass.](https://mintcdn.com/argyle/NLQXOFTOJpenWboM/images/argyle-guides/integrations/encompass-2/41-encompass.png?fit=max\&auto=format\&n=NLQXOFTOJpenWboM\&q=85\&s=aa766571cf7fbbcd4473dadac854fecb) 2. The order status will be shown in the top left next to the borrower name. > [accordion] Order status details > > * **Pending**: Awaiting borrower action. > * **In Progress**: Connected data is syncing, a refreshed verification is being generated, or uploaded documents are being processed. > * **Action Required**: The borrower needs to take additional action before the order can be completed. Additional details and next steps will be displayed. > * **Cancelled**: The verification order was manually cancelled within Encompass®. Argyle may also cancel orders due to processing timeouts or unresolvable issues. > * **Completed**: The verification was successful. Reports and documents have been routed according to your [document-mapping configuration](/integrations/pos-los/encompass/setup-guide#document-mapping-optional). 3. For payroll and asset verifications, the borrower(s) will be sent an [email and/or text invitation](#borrower-experience) asking them to connect their respective payroll and financial institutions. > [!NOTE] > > To resend an invitation, select **Resend** or select **Copy Link** to generate a URL that can be shared with the borrower. 4. For document verifications, the borrower will not be contacted. Submitted documents will begin processing immediately, with a typical processing time of 10 minutes. ### View reports and documents 1. Once an order reaches **Completed** status: * The **Reports** section will contain verification reports. * The **Paystubs** and **Tax Documents** section will contain uploaded and retrieved payroll documents. > [!NOTE] > > Reports and documents can also be viewed in the [Connections](https://console.argyle.com/connections) section of Console. Each borrower has an [external identifier](/overview/data-structure/users#external-identifiers) that matches their Loan # in Encompass®. 2. Automatic delivery to eFolder. * Verification reports are automatically pushed to eFolder. * For VOIE orders, the last 30 days of paystubs and the two most recent W-2s are also automatically pushed. Additional retrieved payroll documents can be pushed to eFolder as needed. > [!NOTE] > > While payroll connections remain active, newly available data and documents continue to be delivered. New payroll documents appear in the Encompass® integration and can be previewed or pushed to eFolder as needed. ### Import assets Loan officers can import asset account details from completed Banking VOA and VOAI reports into Encompass®. 1. For a completed asset verification order, select **Import Assets**. 2. Choose which asset accounts to import. 3. Review whether each account will be added as **New** or used to **Update** an existing URLA entry. 4. Optionally adjust the **Destination** for each selected account: **Borrower**, **Co-borrower**, or **Both** when available. 5. Select **Review Updates** and confirm the import. > [!NOTE] > > Argyle only writes selected asset accounts after confirmation. Argyle attempts to update existing URLA assets in the loan file when a matching account is found to help avoid duplicate asset entries. ![Select asset accounts to add or update in the Argyle Encompass Import Assets modal.](https://mintcdn.com/argyle/Z_-M1EhO6KVrHUEF/images/argyle-guides/integrations/encompass-2/48-encompass.png?fit=max\&auto=format\&n=Z_-M1EhO6KVrHUEF\&q=85\&s=f2771c1c628348e117c3084a333878af) ### Order closing verifications 1. When **Instant Verification Available** is shown in green, an up-to-date report can be ordered by selecting **Refresh** that does not require additional borrower action. ![Instant Verification Available shown in green for ordering an updated closing verification.](https://mintcdn.com/argyle/NLQXOFTOJpenWboM/images/argyle-guides/integrations/encompass-2/40-encompass.png?fit=max\&auto=format\&n=NLQXOFTOJpenWboM\&q=85\&s=f2fb4bf139373b9015e1602d240c7a8a) 2. When **Re-engage if Needed** is shown in orange, there are two verification options after selecting **Refresh**: * **Request Updated Data** will resend a connection invitation to the borrower. * **Use Available Data** will generate a report immediately with the most available data, and does not require additional borrower action. ![Use Available Data option for ordering a refreshed verification without additional borrower action.](https://mintcdn.com/argyle/NLQXOFTOJpenWboM/images/argyle-guides/integrations/encompass-2/39-encompass.png?fit=max\&auto=format\&n=NLQXOFTOJpenWboM\&q=85\&s=d6ceafdfdcf0507832be5061fcb00db7) > [!NOTE] > > According to the GSE's, reports based on data last updated 35 days ago or less are sufficient for rep & warrant consideration. ### Banking reports account filtering Loan officers can review and update the financial accounts included in refreshed banking reports: 1. For completed asset verification orders, select **Refresh**. 2. In **Accounts Included**, include or exclude the financial accounts that should appear in the refreshed report. 3. Submit the refresh. > [!NOTE] > > The **Accounts Included** section appears when multiple financial accounts are available. At least one account must remain selected before the report can be refreshed. ![Manage included accounts when refreshing asset reports in the Argyle Encompass workflow.](https://mintcdn.com/argyle/CzUaxFP0taPhWDzy/images/argyle-guides/integrations/encompass-2/46-encompass.png?fit=max\&auto=format\&n=CzUaxFP0taPhWDzy\&q=85\&s=a0df93c913691c6cf68ddb4bdc2a8ec0) Financial accounts can also be edited by selecting **New Order** and then selecting **Edit Report** for previously completed asset verifications. ![Manage included accounts when editing asset reports in the Argyle Encompass workflow.](https://mintcdn.com/argyle/CzUaxFP0taPhWDzy/images/argyle-guides/integrations/encompass-2/47-encompass.png?fit=max\&auto=format\&n=CzUaxFP0taPhWDzy\&q=85\&s=80d8f861cd717a0b5f5786b8374d301d) ## Borrower experience > [!NOTE] > > This borrower flow applies to payroll and banking verifications. No borrower action is required for document verifications. 1. After order submission, each borrower receives a single Argyle invitation by email and/or text. ![Borrowers receive a single invitation and land on a page listing the requested verification methods.](https://mintcdn.com/argyle/NLQXOFTOJpenWboM/images/argyle-guides/integrations/encompass-2/45-encompass.png?fit=max\&auto=format\&n=NLQXOFTOJpenWboM\&q=85\&s=40b484cdb7f47ac675bd044fd2615629) 2. Selecting **Verify Now** opens a landing page that lists the requested verification methods. ![Borrower landing page listing the requested verification methods after selecting Verify Now.](https://mintcdn.com/argyle/NLQXOFTOJpenWboM/images/argyle-guides/integrations/encompass-2/34-encompass.png?fit=max\&auto=format\&n=NLQXOFTOJpenWboM\&q=85\&s=b7b7326bae18000359d01280bfe2feb1) 3. Selecting **Payroll Provider** takes the borrower to Argyle's payroll connection experience. ![Borrowers are taken to Argyle's payroll connection experience after selecting Payroll Provider.](https://mintcdn.com/argyle/NLQXOFTOJpenWboM/images/argyle-guides/integrations/encompass-2/38-encompass.png?fit=max\&auto=format\&n=NLQXOFTOJpenWboM\&q=85\&s=e66fd573710f6b4f93ca3849f5bc88e9) 4. Selecting **Bank Account** takes the borrower to Mastercard's financial account connection experience. ![Borrowers connect assets through Mastercard Data Connect.](https://mintcdn.com/argyle/NLQXOFTOJpenWboM/images/argyle-guides/integrations/encompass-2/36-encompass.png?fit=max\&auto=format\&n=NLQXOFTOJpenWboM\&q=85\&s=70fac5f5626366ae73963c0baf6da155) 5. Borrowers can complete payroll and asset connections in either order and return later if needed. * After each successful connection, the borrower returns to the same landing page until all requested verification methods are completed. * If a refreshed verification later requires borrower action, a new invitation is sent and the borrower returns to the same landing page to reconnect the method that needs updated data. ## Day 1 Certainty® and AIM Argyle's income & employment and asset verification reports provide lenders an automated way to achieve Day 1 Certainty® through [Fannie Mae's Desktop Underwriter® (DU®) validation service](https://singlefamily.fanniemae.com/applications-technology/desktop-underwriter-desktop-originator) and assessment of borrower income and assets through [Freddie Mac's asset and income modeler (AIM)](https://sf.freddiemac.com/tools-learning/technology-tools/our-solutions/aim-asset-income-modeler). > [!NOTE] > > Reach out to your Customer Success Manager to enable Argyle's Day 1 Certainty® and AIM functionality. The Encompass® integration automatically populates the report identifiers required by GSEs within the loan file. If multiple verification reports of the same type have been generated, the identifier from the most recent report is used. > [accordion] Payroll and Doc VOI reference fields > > These mappings are provided for troubleshooting or integrations that write to Encompass directly. When using the Argyle Encompass integration, you do not need to populate these fields manually. > > | Report | Encompass field | Value | > | - | - | - | > | Payroll | `GSEVENDOR.X60` | Payroll report reference number(s). When both borrower and co-borrower have payroll reports, the reference numbers are comma-separated in borrower, co-borrower order. | > | Doc VOI — borrower | `GSEVENDOR.X43` | Full AIM Check reference number prefixed with `FM:`. | > | Doc VOI — co-borrower | `GSEVENDOR.X44` | Full AIM Check reference number prefixed with `FM:`. | > > Doc VOI report IDs are not written to `GSEVENDOR.X60`. If the loan has both payroll and Doc VOI reports, the payroll reference numbers populate `GSEVENDOR.X60` and the AIM Check references populate the applicable Freddie Mac fields. **Resolve employer name mismatches** 1. Select **Import Employment** for a **Completed** order. 2. Resolve any conflicts between the employer name in the loan file and the employer name Argyle used during verification processing. > [!NOTE] > > Resolving employer name mismatches helps maximize Day 1 Certainty® and AIM rep & warrant relief. ## Receipts 1. Select **Receipt** for an individual borrower to generate a receipt and push it to eFolder. 2. Receipts are available for each individual borrower after orders are **Completed** and indicate the fees associated with the verification order. > [!NOTE] > > To enable **Receipt** functionality, reach out to your Argyle Customer Success Manager. ## Testing ### Payroll test profiles * Select `Argyle Sandbox` for Sandbox testing or `Argyle` for Production testing. * Enter your testing email or phone number and order a payroll report. * After receiving the invitation, use Argyle's [sample user credentials](/overview/sandbox-testing#connect-sample-users) to connect to: * **Sandbox**: any employer or payroll provider * **Production**: `Platformtronic` or `Employertronic` For specific scenario testing, the following sample users are also available: | | Homer Loanseeker | Suzi Builder | Andy Freddie | | - | - | - | - | | Email | homer\_loanseeker\@argyle.com | suzi\_builder\@argyle.com | andy\_freddie\@argyle.com | | Username | homer\_loanseeker | suzi\_builder | andy\_freddie | | Password | passgood | passgood | passgood | | Verification code | 9081 | 9084 | 9088 | | Phone number | (800) 900-0101 | (800) 900-0104 | (800) 900-0108 | | Driver's license # | D1230101 | D1230104 | D1230108 | | **Returns** | **1 active employment** | **2 active employments** | **1 active and 1 terminated employment** | ### Banking test profiles > [!NOTE] > > When you're ready to begin testing, contact your Argyle Customer Success Manager to enable banking permissions. > [!WARNING] > > The Sandbox testing environment for banking supports a maximum of 500 users. To stay within this limit, implement user-management workflows and remove inactive users when they are no longer needed. The following sample test profiles can be connected to: * **Sandbox**: connect to `FinBank Profiles A` or `FinBank Profiles B` * **Production**: connect to `FinBank Billable` or `FinBank Oauth Billable` | Username | Password | Account types | Supported products | | - | - | - | - | | profile\_02 | profile\_02 | Savings, IRA, 401k, Credit Card | `voa`, `voi`, `voai` | | profile\_03 | profile\_03 | Checking, Personal Investment, 401K, Roth, Savings (Joint Account owners) | `voa`, `voi`, `voai` | | profile\_04 | profile\_04 | Checking, 403B, 529, Rollover, Mortgage | `voa`, `voi`, `voai` | | profile\_05 | profile\_05 | Checking, Investment, Stocks, UGMA, UTMA (Joint Account owners) | `voa`, `voi`, `voai` | | profile\_06 | profile\_06 | Checking, Retirement, KEOGH, 457, Credit Card | `voa`, `voi`, `voai` | | profile\_07 | profile\_07 | Checking, Stocks, CD, Investment Tax-Deferred, Employee Stock | `voa`, `voi`, `voai` | | profile\_08 | profile\_08 | Checking, Primary Savings, Money Market, 401A, Line of credit | `voa`, `voi`, `voai` | | profile\_09 | profile\_09 | Checking, Savings, Checking failed report. Errors include `102`, `103`, `185`. | `voa`, `voi`, `voai` *(failed report)* | For specific scenario testing, the following sample users are also available: | | Sue Wealthy | River Paycheck | Alex Student | | - | - | - | - | | Username | sue\_wealthy | river\_paycheck | alex\_student | | Password | profile\_700 | profile\_703 | profile\_704 | | Description | Sue is working as a Product Manager with a good steady income, a mortgage, and multiple investment accounts. She has a loan account and leases a car. Sue travels a few times a year. She has typical expenses like groceries, clothes, entertainment, gym membership, car expenses, and she has a pet. | River works in construction. He rents an apartment and has typical expenses like groceries, clothes, entertainment, household and car expenses. He has some savings but no investments, no loans and no credit cards. In some months, River's expenses exceed his income. | Alex is working full-time with a good salary but she is still paying off her student loan. She makes regular monthly repayments, but she still has over \$30,000 to pay off. Alex has typical expenses like groceries, clothes, entertainment, household, and car expenses. She has limited savings and she has started an investment account. | ### Doc VOI test documents * Use the sample documents below for **Doc VOI** verifications. * For all scenarios below, enter `Warehouse Services Inc` in **1003 URLA Part 2** as the current employer with a start date of `02/01/2023`, and leave the end date blank. > [!NOTE] > > Do not adjust file names. > [tab] Sandbox > > > [accordion] GSE-eligible monthly income > > > > Upload the following documents: > > > > * [Warehouse\_Services\_Inc\_paystub.pdf](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/Warehouse_Services_Inc_paystub.pdf) > > * [Warehouse\_Services\_Inc\_paystub\_2025.pdf](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/Warehouse_Services_Inc_paystub_2025.pdf) > > * [Warehouse\_Services\_Inc\_paystub\_2024.pdf](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/Warehouse_Services_Inc_paystub_2024.pdf) > > > [accordion] Not GSE-eligible monthly income > > > > Upload the following documents: > > > > * [Warehouse\_Services\_Inc\_ineligible.pdf](https://res.cloudinary.com/argyle-media/image/upload/docs-2025/Warehouse_Services_Inc_paystub_ineligible.pdf) > > * [Warehouse\_Services\_Inc\_paystub\_2025.pdf](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/Warehouse_Services_Inc_paystub_2025.pdf) > > * [Warehouse\_Services\_Inc\_paystub\_2024.pdf](https://res.cloudinary.com/argyle-media/image/upload/docs-2025/Warehouse_Services_Inc_paystub_2024.pdf) > > > [accordion] Requires more data > > > > Upload only the following document: > > > > * [Warehouse\_Services\_Inc\_paystub.pdf](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/Warehouse_Services_Inc_paystub.pdf) > [tab] Production > > > [!NOTE] > > > > Production testing can be done with real documents. If needed, use the sample files below. > > > [accordion] GSE-eligible monthly income > > > > Upload the following documents: > > > > * [sandbox\_Warehouse\_Services\_Inc\_paystub.pdf](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/sandbox_Warehouse_Services_Inc_paystub.pdf) > > * [sandbox\_Warehouse\_Services\_Inc\_paystub\_2025.pdf](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/sandbox_Warehouse_Services_Inc_paystub_2025.pdf) > > * [sandbox\_Warehouse\_Services\_Inc\_paystub\_2024.pdf](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/sandbox_Warehouse_Services_Inc_paystub_2024.pdf) > > > [accordion] Not GSE-eligible monthly income > > > > Upload the following documents: > > > > * [sandbox\_Warehouse\_Services\_Inc\_paystub\_ineligible.pdf](https://res.cloudinary.com/argyle-media/image/upload/docs-2025/sandbox_Warehouse_Services_Inc_paystub_ineligible.pdf) > > * [sandbox\_Warehouse\_Services\_Inc\_paystub\_2025.pdf](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/sandbox_Warehouse_Services_Inc_paystub_2025.pdf) > > * [sandbox\_Warehouse\_Services\_Inc\_paystub\_2024.pdf](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/sandbox_Warehouse_Services_Inc_paystub_2024.pdf) > > > [accordion] Requires more data > > > > Upload only the following document: > > > > * [sandbox\_Warehouse\_Services\_Inc\_paystub.pdf](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/sandbox_Warehouse_Services_Inc_paystub.pdf) *For further assistance, please reach out to [support@argyle.com](mailto:support@argyle.com) or your Customer Success Manager.* # Loan Origination Systems Source: https://docs.argyle.com/integrations/pos-los/loan-origination-systems Route verification orders, reports, source documents, and status updates through a loan origination system. A loan origination system (LOS) integration lets loan teams order and monitor verifications from the loan file while borrowers complete the required payroll or banking connections. ![Loan origination systems integrate with Argyle.](https://mintcdn.com/argyle/0Z2zBY-iD5Q5BvPN/images/argyle-guides/integrations/loan-origination-systems/1-los.png?fit=max\&auto=format\&n=0Z2zBY-iD5Q5BvPN\&q=85\&s=4c65fc0c7530cb241aec2abbf0e01abb) ## Verification workflow 1. The loan officer orders the required verification products for the borrower. 2. Payroll and banking orders send or launch the appropriate user session. 3. The borrower connects the requested accounts at their direction, or the loan team uploads documents for Doc VOI. 4. The integration tracks each verification independently. 5. Completed reports and supported source documents are routed to the loan file. Use the [Verifications Guides](/verifications/overview) for the API lifecycle. ## Product status Each requested product can complete, require action, or fail independently. Do not combine payroll, banking, and Doc VOI into one status when the LOS supports product-level status. Use the verification [`status`](/api-reference/verifications/retrieve-a-verification#response-status) object to determine the next action: * Continue waiting while processing is active. * Return the borrower to the existing active verification when connection steps are incomplete. * Surface verification errors and their current remediation. * Retrieve the report when the verification is complete. ## Reports and documents When a verification reaches `completed` or `completed_with_errors`: * Retrieve the report PDF from `report.file_url`. * Retrieve report JSON from `report.json_url` when available. * Retrieve supported payroll documents through the Payroll Documents API. * Retrieve uploaded source files through the User Uploads API. Route files to the LOS document categories required by the integration rather than relying on report names alone. ## Re-verification Use [Re-verification](/verifications/re-verification) for updated payroll, banking, or Doc VOI results. An active connection can support a refreshed verification without borrower action. When updated authentication is required, create the appropriate new session and return the borrower to the existing account. ## Notifications Use the LOS event model for loan-team notifications and Argyle webhooks for backend lifecycle state. Keep these responsibilities separate: * LOS events notify operators inside the loan system. * The `verifications.updated` webhook updates the verification record and report readiness. * Account and resource webhooks support direct-data workflows. ## Supported integrations * [Encompass 3-in-1 Verification Suite](/integrations/pos-los/encompass/verifications) * [Empower](/integrations/pos-los/empower) * [nCino](/integrations/pos-los/ncino) For another LOS, confirm ordering, status mapping, report routing, and document mapping requirements before implementation. # nCino Source: https://docs.argyle.com/integrations/pos-los/ncino Securely retrieve income, assets, and employment history with direct borrower connections in nCino. \ nCino streamlines the mortgage process by providing a centralized platform for loan origination, processing, and underwriting, as well as collaboration, tracking, and real-time information exchange tools for loan originators, processors, underwriters, and borrowers. ## Admin setup 1. Reach out to an Argyle representative to begin the setup process. 2. Argyle will provide the following nCino integration credentials: * `Argyle API Key` and `Argyle API Secret` — Required for payroll. * `Argyle Partner Client ID` * `Argyle Flow ID` — Determines the borrower's payroll connection experience. * `Argyle Experience ID` — Configures the borrower's banking connection flow. 3. Contact your nCino representative to complete the set-up process. More information can be found by visiting nCino's [implementation portal](https://www.ncino.com/implementation). ## Employment & Income ### Overview Integrating Argyle direct payroll with nCino creates a seamless and automated workflow: 1. Borrowers are able to connect their payroll accounts through Argyle within nCino. 2. Argyle delivers paystubs, W2s, and an income & employment verification report PDF to nCino. 3. All payroll documents and verification reports are viewable in nCino and \[optional] Encompass. ### Borrower experience 1. After the Argyle integration is enabled, borrowers will be able to connect their payroll accounts within nCino by selecting their source(s) of income. ![Connect borrowers through Argyle within the nCino mortgage platform to easily retrieve the borrower's payroll information.](https://mintcdn.com/argyle/0Z2zBY-iD5Q5BvPN/images/argyle-guides/integrations/ncino/1-ncino.png?fit=max\&auto=format\&n=0Z2zBY-iD5Q5BvPN\&q=85\&s=7d5afcb17cdf8b456304f764291bb998) 2. Borrowers enter their login credentials for the employer or payroll system they selected. These are the same login credentials they would use to manually retrieve copies of their paystubs and tax documents. ![Login screen in Link.](https://mintcdn.com/argyle/0Z2zBY-iD5Q5BvPN/images/argyle-guides/integrations/ncino/2-ncino.png?fit=max\&auto=format\&n=0Z2zBY-iD5Q5BvPN\&q=85\&s=47444b2309f161e79094bdfad4ccbe75) ### Verification reports and payroll documents After each payroll account is connected, Argyle will deliver the following PDF documents to nCino: * All paystubs from the past 30 days * The two most recent Form W-2 tax documents available * A Verification of Income and Employment (VOIE) report ([sample report](https://res.cloudinary.com/argyle-media/image/upload/v1749501632/docs-2025/voie_example_argyle.pdf)) The payroll documents and VOIE report can be accessed within the **Documents** section of your **Loans** dashboard: ![Documents can be found in the documents folder of the Loans tab.](https://mintcdn.com/argyle/0Z2zBY-iD5Q5BvPN/images/argyle-guides/integrations/ncino/3-ncino.png?fit=max\&auto=format\&n=0Z2zBY-iD5Q5BvPN\&q=85\&s=cd5a03de1840f2afa720112a46a0c3ed) ### Testing profiles 1. Use Argyle's [sample user credentials](/overview/sandbox-testing#connect-sample-users) to log in to: * Any employer or payroll provider (if testing in Argyle's Sandbox testing environment) * `Platformtronic` or `Employertronic` as the employer (if testing in Argyle's Production environment) 2. For specific scenario testing, the following sample users are also available: | | Homer Loanseeker | Suzi Builder | Andy Freddie | | - | - | - | - | | Email | homer\_loanseeker\@argyle.com | suzi\_builder\@argyle.com | andy\_freddie\@argyle.com | | Username | homer\_loanseeker | suzi\_builder | andy\_freddie | | Password | passgood | passgood | passgood | | Verification code | 9081 | 9084 | 9088 | | Phone number | (800) 900-0101 | (800) 900-0104 | (800) 900-0108 | | Driver's license # | D1230101 | D1230104 | D1230108 | | **Returns** | **1 active employment** | **2 active employments** | **1 active and 1 terminated employment** | ### Importing to Encompass® If you use [Encompass®](/integrations/pos-los/encompass/verifications) as your LOS alongside nCino as your POS, the PDF documents and verification reports requested in nCino can be made viewable within Argyle's Encompass® integration. > [!NOTE] > > Reach out to your Argyle customer success manager to enable nCino and Encompass compatibility. ## Financial accounts ### Overview 1. Argyle's nCino banking integration allows borrowers to connect their financial accounts during the application process. 2. Asset verification reports are made available within nCino, with the option to import the reports into Encompass® and automatically populate asset data in the 1003 URLA and report identifiers required by GSEs within the Encompass® loan file. ![Connect financial accounts within the assets and liabilities section of the nCino application.](https://mintcdn.com/argyle/0Z2zBY-iD5Q5BvPN/images/argyle-guides/integrations/ncino-banking/1-ncino-banking.png?fit=max\&auto=format\&n=0Z2zBY-iD5Q5BvPN\&q=85\&s=990384ad99330df670f309b7329528c6) ### Borrower experience 1. In the **Assets & liabilities** section, the borrower can search for and connect their financial accounts using their login credentials. ![Connect financial accounts through Argyle's integration within nCino.](https://mintcdn.com/argyle/0Z2zBY-iD5Q5BvPN/images/argyle-guides/integrations/ncino-banking/2-ncino-banking.png?fit=max\&auto=format\&n=0Z2zBY-iD5Q5BvPN\&q=85\&s=c84cd9bc6183a131b48081be5dfdd747) 2. When the borrower has finished connecting their financial institutions, they can save and exit to the remainder of their nCino application. ![Borrowers can save and exit after they have finished connecting their financial institutions.](https://mintcdn.com/argyle/0Z2zBY-iD5Q5BvPN/images/argyle-guides/integrations/ncino-banking/3-ncino-banking.png?fit=max\&auto=format\&n=0Z2zBY-iD5Q5BvPN\&q=85\&s=a341a242a07777b5f84f120457e77a27) ### Asset reports After the borrower connects their financial accounts, Argyle will deliver a Verification of Assets (VOA) report ([sample report](https://res.cloudinary.com/argyle-media/image/upload/v1747769368/docs-2025/VOA_Example_Report.pdf)) or Verification of Assets & Income (VOAI) report ([sample report](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/VOAI_Banking_Report.pdf)) to nCino. The report type can be configured during [admin setup](/integrations/pos-los/ncino#admin-setup). The report can be accessed within the **Services** section of your **Loans** dashboard by selecting **View Reports**. ![You can view asset reports within nCino in the Services section.](https://mintcdn.com/argyle/0Z2zBY-iD5Q5BvPN/images/argyle-guides/integrations/ncino-banking/4-ncino-banking.png?fit=max\&auto=format\&n=0Z2zBY-iD5Q5BvPN\&q=85\&s=7739dd92d6b8d972a7f2e43646241364) ### Testing profiles 1. Use [sample banking credentials](https://developer.mastercard.com/open-banking-us/documentation/test-the-apis/#bank-account-profiles) to log into either the `FinBank Billable` or `FinBank Oauth Billable` financial institutions for testing. 2. For specific scenario testing, the following sample users are also available: | | Sue Wealthy | River Paycheck | Alex Student | | - | - | - | - | | Username | sue\_wealthy | river\_paycheck | alex\_student | | Password | profile\_700 | profile\_703 | profile\_704 | | Description | Sue is working as a Product Manager with a good steady income, a mortgage, and multiple investment accounts. She has a loan account and leases a car. Sue travels a few times a year. She has typical expenses like groceries, clothes, entertainment, gym membership, car expenses, and she has a pet. | River works in construction. He rents an apartment and has typical expenses like groceries, clothes, entertainment, household and car expenses. He has some savings but no investments, no loans and no credit cards. In some months, River's expenses exceed his income. | Alex is working full-time with a good salary but she is still paying off her student loan. She makes regular monthly repayments, but she still has over \$30,000 to pay off. Alex has typical expenses like groceries, clothes, entertainment, household, and car expenses. She has limited savings and she has started an investment account. | ### Importing to Encompass® If you use [Encompass®](/integrations/pos-los/encompass/verifications) as your LOS alongside nCino as your POS: * Asset reports in nCino can be imported to the Encompass® eFolder. * Asset data will automatically populate the 1003 URLA section of the Encompass® loan file. * Argyle will automatically populate the Finicity GSE field within the Encompass® loan file. > [!NOTE] > > The GSE field will automatically be updated after a refreshed report. ![Asset data can be imported to Encompass to auto-populate the 1003 URLA.](https://mintcdn.com/argyle/0Z2zBY-iD5Q5BvPN/images/argyle-guides/integrations/ncino-banking/5-ncino-banking.png?fit=max\&auto=format\&n=0Z2zBY-iD5Q5BvPN\&q=85\&s=d327dcc3fd3a774082c14c0694a97e4e) # Point of Sale Systems Source: https://docs.argyle.com/integrations/pos-los/point-of-sale-systems Add payroll, banking, and document verification steps to a mortgage point-of-sale experience. A point-of-sale (POS) integration lets borrowers complete required verification steps without leaving the loan application flow. ![Point of sale systems integrate with Argyle.](https://mintcdn.com/argyle/0Z2zBY-iD5Q5BvPN/images/argyle-guides/integrations/point-of-sale-systems/1-point-of-sale-systems.gif?s=8377d9c1de519915bdd99766c32078d6) ## Choose an integration model ### Verifications Use the [Verifications API](/verifications/overview) when the POS creates and tracks standardized payroll, banking, or Doc VOI orders. 1. Create or reuse the borrower as an Argyle user. 2. Order the required verification products. 3. Create a session for payroll or banking user action. 4. Launch the connection flow from the POS. 5. Wait for the `verifications.updated` webhook and retrieve the completed reports. This model gives each requested product its own verification status and report result. ### Direct Data APIs Use the [Data APIs](/data-apis/overview) when the POS already has a custom workflow that consumes connected-account data directly. 1. Create the user and a user token. 2. Embed Link in the application. 3. Track each connected account independently. 4. Wait for the required account and resource events. 5. Retrieve the data sets used by the application. ## Launch the user experience ### Payroll * Embed the [Web SDK](/link/initialization/web) or a supported [Mobile SDK](/link/initialization/mobile-sdks). * Use a verification session `link` as `connectUrl`, or initialize a direct-data flow with `userToken`. * Use [Link callbacks](/link/reference/callbacks) to update the immediate POS experience. ### Banking * Create a verification session and pass its `link` to the banking SDK as `connectURL`. * Use banking SDK callbacks for immediate frontend handling. * Use the `verifications.updated` webhook for backend status. ### Doc VOI * Collect documents in the POS and upload them through the User Uploads API, or direct the borrower to the configured document-upload experience. * Track document processing through the verification lifecycle. ## Return to the application Set a session `redirect_url` or handle the relevant SDK callback after the borrower finishes the current step. Treat the backend verification or account webhook as the source of truth for processing status. ## Reports and data * Verification implementations retrieve completed reports from the verification resource. * Direct-data implementations retrieve users, accounts, identities, paystubs, payroll documents, and other required data sets from the API. * Source files and report URLs require Argyle authentication headers. ## Supported integrations For supported prebuilt POS integrations, see: * [Encompass Consumer Connect](/integrations/pos-los/consumer-connect) * [nCino](/integrations/pos-los/ncino) For another platform, use this page as the implementation model and confirm platform-specific requirements with your Argyle Customer Success Manager. # Accessibility Source: https://docs.argyle.com/link/accessibility Accessibility support in Argyle Link and integration guidelines. Argyle believes digital experiences should work for everyone. * Applicants use [**Argyle Link**](https://www.argyle.com/platform-overview/link) to connect their payroll or employment accounts and, at their direction, share their income and employment data straight from the source. * Link is designed and tested to meet modern accessibility standards, including for people who use assistive technology. ## Why accessibility matters * **Accessibility supports inclusion** — An estimated 1.3 billion people, or about one in six people worldwide, experience a significant disability, including visual, auditory, motor, cognitive, or vestibular disabilities ([World Health Organization](https://www.who.int/news-room/fact-sheets/detail/disability-and-health)). * **Accessibility supports compliance and procurement** — Accessibility requirements apply across many markets and public-sector procurement programs, including [Section 508](https://www.section508.gov/) for U.S. federal agencies and [ADA Title II](https://www.ada.gov/law-and-regs/regulations/title-ii-2010-regulations/) for state and local government services. * **Accessibility improves the experience for everyone** — Clear structure, keyboard support, readable contrast, and predictable interactions benefit people with and without disabilities. ## Standards we follow Argyle Link targets [Web Content Accessibility Guidelines (WCAG) 2.2](https://www.w3.org/TR/WCAG22/), Level AA, and is aligned with Section 508. Argyle documents its accessibility work through independent third-party audits and an Accessibility Conformance Report (ACR) prepared using the Voluntary Product Accessibility Template (VPAT), available upon request. Argyle's accessibility work includes: * **Keyboard operation** — Every step can be completed with a keyboard, with a visible focus indicator. * **Color contrast** — Text has a contrast ratio of at least 4.5:1; large text and UI components have a contrast ratio of at least 3:1. * **Text alternatives** — Informational images and icons include appropriate text alternatives. * **Semantic structure** — Headings, landmarks, and lists support reliable navigation. * **Form labels and errors** — Inputs have programmatically associated labels, and error messages are clear and accessible. * **Accessible names** — Interactive controls have names that convey their purpose. * **Dynamic content** — Status, loading, and error messages are announced to assistive technologies. * **Zoom and reflow** — Content supports zoom and reflow up to 400% without loss of content or function. ### WCAG 2.2 criteria We test against the WCAG 2.2 criteria that are especially relevant to a login-and-submit flow: * **Focus Not Obscured (2.4.11)** — Focused elements remain visible rather than being entirely hidden behind sticky headers, sheets, or other content. * **Target Size (2.5.8)** — Touch targets are large enough to activate reliably on mobile devices. * **Accessible Authentication (3.3.8)** — Sign-in and verification-code steps do not rely on a cognitive test that a person must memorize or transcribe without assistance. * **Redundant Entry (3.3.7)** — People are not asked to re-enter information they already provided in the same flow. ## What Link provides automatically When you embed Link, accessibility support includes: * **Keyboard navigation** — People can navigate every step in a logical order with visible focus states. * **Screen reader support** — Link is tested with common assistive technologies, including NVDA, JAWS, and VoiceOver. * **Semantic markup and ARIA** — Structure, roles, and states are conveyed programmatically. * **Accessible modals and dialogs** — Focus moves into the dialog, background content becomes inert, and the dialog can be dismissed using its controls, the Escape key, or by selecting outside it when that behavior is supported. * **Accessible forms** — Search, login, verification-code, and income-confirmation steps include labeled inputs and inline errors. * **Contrast and typography** — Link is designed to meet Level AA contrast requirements and support OS-level text sizing and reduced-motion preferences. ## Your integration responsibilities Because Link runs within your application, end-to-end accessibility is a shared responsibility. Argyle maintains Link's accessibility support, and your integration should preserve it. * **Provide an accessible entry point** — The button or link that launches Link needs an accessible name, keyboard focus, and sufficient contrast. * **Avoid accessibility overrides** — Do not use CSS or scripts that remove focus indicators, alter ARIA attributes, or trap focus around the embedded experience. * **Embed Link correctly** — If you render Link in an iframe, give the iframe a concise, descriptive `title`, ensure it can receive focus, and do not block keyboard interaction. * **Test the complete flow** — Before going live, test your integrated experience with a keyboard and screen reader. ## Branding and configuration Argyle Link's core interface is not customizable. Argyle designs and maintains its layout, components, and accessibility. The only client-configurable branding option is a brand color, which applies to the landing page and invitation email, not Link itself. When selecting a brand color, choose one that maintains sufficient contrast — at least 4.5:1 for text and 3:1 for large text and UI components — and do not rely on color alone to convey meaning. Because this color does not affect Link itself, it does not affect Link's WCAG 2.2 AA conformance. You can validate color choices with a contrast-checking tool such as the [Contrast plugin for Figma](https://www.figma.com/community/plugin/748533339900865323/contrast). ## Testing and conformance * **Independent third-party audit** — A third party audits Link against WCAG 2.2, Level AA, and Section 508. Results are delivered as an Accessibility Conformance Report (ACR) using the Voluntary Product Accessibility Template (VPAT). * **Manual and automated testing** — Certified testers perform manual and assistive-technology testing alongside automated testing in continuous integration (CI), including axe-core and regression checks. * **Ongoing validation** — Argyle retests Link on a regular cadence as the experience evolves. ## Contact us Argyle ships frequent Link updates, and accessibility is an ongoing commitment. To request the current ACR/VPAT, report an accessibility barrier, or suggest an improvement, contact [compliance@argyle.com](mailto:compliance@argyle.com). Your feedback helps us improve the experience for everyone. # Hosted Link Source: https://docs.argyle.com/link/initialization/hosted-link Launch an Argyle verification session URL directly. Hosted Link launches a verification session URL directly in a browser or secure mobile browser context. Use Hosted Link when you want to minimize frontend development, when your security model prefers a redirect-based flow, or when your mobile application should open Link in a secure browser context instead of embedding a native SDK. ## Tradeoffs | Hosted Link gives you | Hosted Link does not give you | | - | - | | A direct session URL to open from your application | Link callbacks | | A browser-native or secure-browser launch model | Frontend control over the Link instance | | Lower frontend implementation effort | Embedded SDK controls such as programmatic open and close behavior | Track verification completion and lifecycle status changes with [`verifications.updated`](/api-reference/verifications-webhooks/updated) webhooks. Treat redirects back to your application as a user navigation event, not as proof that the verification is complete. ## Create a session URL Create a verification session via [`POST /v2/sessions`](/api-reference/verifications/create-a-session). The response includes a `link` URL. Example request for a desktop browser session: ```json theme={} { "verification": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b", "configuration": { "redirect_url": "https://your-application.com/return?state=STATE_VALUE", "flow_id": "12ABCD3E", "items": ["item_000000001", "item_000000002"], "language": "EN", "mobile_app": false } } ``` > [!NOTE] > > For payroll Hosted Link sessions opened from a secure browser context in a mobile app, set `configuration.mobile_app` to `true` when creating the session. Example response: ```json theme={} { "verification": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b", "configuration": { "experience": null, "single_use_url": false, "redirect_url": "https://your-application.com/return?state=STATE_VALUE", "flow_id": "12ABCD3E", "items": ["item_000000001", "item_000000002"], "language": "EN", "mobile_app": false }, "link": "https://connect.argyle.com/?...", "data_source": "payroll" } ``` > [!NOTE] > > Hosted Link uses verification session URLs. These session links expire after one hour, and a new session link can be created at any time by creating another session for the active verification. > [!WARNING] > > The returned `link` URL is signed by Argyle to prevent tampering. Do not modify the returned URL. If you need different session settings, create a new session. ## Launch Hosted Link On web, open the session `link` in the same tab, a popup window, or a separate tab. ```js theme={} window.location.assign('SESSION_LINK') ``` On mobile, open the session `link` in a secure browser context, such as `ASWebAuthenticationSession` on iOS or Android Custom Tabs on Android. Avoid loading Hosted Link inside an iframe. If you need iframe isolation or Link callbacks, use the [Web SDK with `connectUrl`](/link/initialization/web#initialize-with-connecturl). ## Return users to your application Set `configuration.redirect_url` when creating the session so the user can return to your application after leaving Hosted Link. For desktop browser flows, use a regular `https://` URL. For mobile app flows, use a return target that can open your app directly: * A custom scheme, such as `your-custom-scheme://return-to-app` * A [Universal Link](https://developer.apple.com/documentation/xcode/supporting-universal-links-in-your-app) on iOS or an [App Link](https://developer.android.com/studio/write/app-link-indexing) on Android When Argyle redirects the user back, it appends two values to the redirect URL: * `user_submission_complete` * `user_attempted_employer_selection` These values can help you update the user's return-page experience. They mirror the [`onClose`](/link/reference/callbacks#onclose) fields available in embedded Link, but webhooks remain the source of truth for verification completion. A plain redirect URL is valid. For example: ```text theme={} https://example.com/argyle-return ``` After Hosted Link redirects the user, the returned URL would include the additional parameters: ```text theme={} https://example.com/argyle-return?user_submission_complete=true&user_attempted_employer_selection=true ``` You can also include a `state` or `nonce` value when you need to match the returning browser session to an internal user, session, or verification. A state or nonce is a unique value generated by your application, added to the redirect URL, and checked when the user returns. For example: ```text theme={} https://example.com/argyle-return?state=abc123 ``` Argyle preserves the value and appends its return parameters: ```text theme={} https://example.com/argyle-return?state=abc123&user_submission_complete=true&user_attempted_employer_selection=true ``` # Mobile SDKs Source: https://docs.argyle.com/link/initialization/mobile-sdks Embed Argyle Link with the iOS, Android, React Native, or Flutter SDKs. Use a mobile SDK when Link should run inside your native or cross-platform mobile application. Argyle supports iOS, Android, React Native, and Flutter. > [!NOTE] > > If you are not using a mobile SDK, prefer either a client-hosted Web SDK implementation in a secure webview, or [Hosted Link](/link/initialization/hosted-link) in a secure browser context such as `ASWebAuthenticationSession` or Android Custom Tabs. > [!NOTE] > > User tokens and session links both expire after one hour. Create a fresh user token before initializing Link with `userToken`, or create a new session link for an active verification before initializing Link with `connectUrl`. ## iOS Argyle's [iOS Link SDK](https://github.com/argyle-systems/argyle-link-ios) provides a way to integrate Link into your iOS app. First-time installation instructions are below. To update versions, visit our [iOS Link upgrade guide](/link/upgrade#ios). ### Requirements - iOS SDK iOS 14.0+, Xcode 14.0+, Swift 5.5+ ### Installing the iOS SDK > [tab] CocoaPods > > **If using [CocoaPods](https://cocoapods.org/):** > > 1. In the `Podfile` of your Xcode project, add `pod 'Argyle', ''` > 2. Run `pod install` to install the Argyle pod > 3. Run `pod update` to ensure the most recent Argyle pod is installed > [tab] Swift Package Manager > > **If using [Swift Package Manager](https://www.swift.org/package-manager/):** > > 1. Within your Xcode project, select **File > Swift Packages > Add Package Dependency** > 2. Find `argyle-link-ios` by searching with URL of the [iOS SDK GitHub repo](https://github.com/argyle-systems/argyle-link-ios) > > See [adding Swift package dependencies in Xcode](https://developer.apple.com/documentation/xcode/adding-package-dependencies-to-your-app#Add-a-package-dependency) for more information. ### Directly opening email clients To enhance the multi-factor authentication (MFA) experience of users, the iOS Link SDK supports directly opening the user's email client. To enable this feature, add the following property to your `Info.plist` file: ```text theme={} LSApplicationQueriesSchemes googlegmail ymail ms-outlook ``` ### Initialize Link > [tab] userToken > > Create a user token: > > * **New users**: create the user via [`POST /v2/users`](/api-reference/users/create-a-user) and use the returned `user_token`. > * **Returning users**: create a new token via [`POST /v2/user-tokens`](/api-reference/user-tokens/create-a-user-token) and use the returned `user_token`. > > Initialize Link using the configuration below, replacing the user token. > > ```swift theme={} > var config = LinkConfig( > userToken: "USER_TOKEN", > sandbox: true // Set to false for production environment. > ) > // (Optional) Add a Link flow customization created in Console: > // config.flowId = "" > // (Optional) Limit Link search to specific Items: > // config.items = ["item_000000001", "item_000000002"] > // (Optional) Connect directly to an existing account: > // config.accountId = "" > // (Optional) Set a language. Options: EN, ES, RU, ZH > // config.language = .EN > // (Optional) A few recommended callbacks: > config.onAccountConnected = { data in > print("Result: onAccountConnected \(data)") > } > config.onAccountError = { data in > print("Result: onAccountError \(data)") > } > config.onTokenExpired = { handler in > print("onTokenExpired") > // Generate a new user token. > // handler(newToken) > } > > ArgyleLink.start(from: viewController, config: config) > // ArgyleLink.close() // Manually close Link (typically the user closes Link). > ``` > [tab] connectUrl > > 1. [Create a session](/api-reference/verifications/create-a-session) as part of a payroll verification workflow. > 2. Copy the response `link`. > 3. Pass that value as `connectUrl` in your Link initialization. > > ```swift theme={} > var config = LinkConfig( > connectUrl: "SESSION_LINK" > ) > // (Optional) A few recommended callbacks: > config.onAccountConnected = { data in > print("Result: onAccountConnected \(data)") > } > config.onAccountError = { data in > print("Result: onAccountError \(data)") > } > > ArgyleLink.start(from: viewController, config: config) > // ArgyleLink.close() // Manually close Link (typically the user closes Link). > ``` ## Android Argyle's [Android Link SDK](https://github.com/argyle-systems/argyle-link-android) provides a way to integrate Link into your Android app. First-time installation instructions are below. To update versions, visit our [Android Link upgrade guide](/link/upgrade#android). ### Requirements - Android SDK * Android 8.0 (minSdk/API level 26) and above * compileSdk 34 and above ### Installing the Android SDK 1. Add the line below within the dependencies of your `build.gradle` [configuration file](https://developer.android.com/studio/build#top-level). 2. [Sync your Android project](https://developer.android.com/studio/build#sync-files) to import the build configuration changes. ```text theme={} dependencies { implementation 'com.argyle:argyle-link-android:5.x.x' } ``` > [accordion] If you are using tools like ProGuard to obfuscate your code... > > Make sure to exclude the Link SDK package `com.argyle.*`. For example, add the following line to the `proguard-rules.pro` file of your ProGuard configuration: > > ```text theme={} > -keep class com.argyle. { *; } > ``` ### Initialize Link > [tab] userToken > > Create a user token: > > * **New users**: create the user via [`POST /v2/users`](/api-reference/users/create-a-user) and use the returned `user_token`. > * **Returning users**: create a new token via [`POST /v2/user-tokens`](/api-reference/user-tokens/create-a-user-token) and use the returned `user_token`. > > Initialize Link using the configuration below, replacing the user token. > > ```kotlin theme={} > val config = LinkConfig( > userToken = "USER_TOKEN", > sandbox = true // Set to false for production environment. > ) > // (Optional) Add a Link flow customization created in Console: > // config.flowId = "" > // (Optional) Limit Link search to specific Items: > // config.items = listOf("item_000000001", "item_000000002") > // (Optional) Connect directly to an existing account: > // config.accountId = "" > // (Optional) Set a language. Options: EN, ES, RU, ZH > // config.language = Language.EN > // (Optional) A few recommended callbacks: > config.onAccountConnected = { data -> > Log.d("Result", "onAccountConnected $data") > } > config.onAccountError = { data -> > Log.d("Result", "onAccountError $data") > } > config.onTokenExpired = { handler -> > // Generate a new user token. > // handler(newToken) > } > > ArgyleLink.start(context, config) > // ArgyleLink.close() // Manually close Link (typically the user closes Link). > ``` > [tab] connectUrl > > 1. [Create a session](/api-reference/verifications/create-a-session) as part of a payroll verification workflow. > 2. Copy the response `link`. > 3. Pass that value as `connectUrl` in your Link initialization. > > ```kotlin theme={} > val config = LinkConfig( > connectUrl = "SESSION_LINK" > ) > // (Optional) A few recommended callbacks: > config.onAccountConnected = { data -> > Log.d("Result", "onAccountConnected $data") > } > config.onAccountError = { data -> > Log.d("Result", "onAccountError $data") > } > > ArgyleLink.start(context, config) > // ArgyleLink.close() // Manually close Link (typically the user closes Link). > ``` ## React Native Argyle's [React Native Link SDK](https://github.com/argyle-systems/argyle-link-react-native) provides a way to integrate Link into your React Native application. First-time installation instructions are below. To update versions, visit our [React Native Link upgrade guide](/link/upgrade#react-native). ### Requirements - React Native SDK * React Native version 0.73.0 or higher * *iOS-specific*: iOS 14.0+ * *Android-specific*: * Android 8.0 (minSdk/API level 26) and above * compileSdk 34 and above > [tab] ProGuard-like tools > > > [accordion] If you are using tools like ProGuard to obfuscate your code... > > > > Make sure to exclude the Link SDK package `com.argyle.*`. For example, add the following line to the bottom of your ProGuard configuration: > > > > ```text theme={} > > -keep class com.argyle. { *; } > > ``` > [tab] okhttp3 runtime issues > > The Link SDK package currently has a dependency of `okhttp3:4.9.2`. If your dependencies use an older version (e.g. `okhttp3.3.xx`) they may need updating to a version that uses `okhttp3.4.x.x`. > > Alternatively, you can attempt to force the Link SDK dependency as follows: > > ```text theme={} > configurations.all { > resolutionStrategy.force 'com.squareup.okhttp3:okhttp:4.9.x' > resolutionStrategy.force 'com.squareup.okhttp3:okhttp-urlconnection:4.9.x' > } > ``` ### Installing the React Native SDK 1. Navigate to the directory for your React Native project. 2. Install the packages from your terminal: > [tab] NPM > > ```text theme={} > npm install @argyleio/argyle-plugin-react-native --save > ``` > [tab] Yarn > > ```text theme={} > yarn add @argyleio/argyle-plugin-react-native > ``` After installation: 1. Run `cd ios` to navigate to the `ios` folder. 2. Run `pod install` to install the Argyle pod. 3. Run `pod update` to ensure the most recent Argyle pod is installed. ### Initialize Link > [tab] userToken > > Create a user token: > > * **New users**: create the user via [`POST /v2/users`](/api-reference/users/create-a-user) and use the returned `user_token`. > * **Returning users**: create a new token via [`POST /v2/user-tokens`](/api-reference/user-tokens/create-a-user-token) and use the returned `user_token`. > > Initialize Link using the configuration below, replacing the user token. > > ```js theme={} > import { ArgyleLink } from '@argyleio/argyle-plugin-react-native'; > > // ... > > const config = { > userToken: 'USER_TOKEN', > sandbox: true, // Set to false for production environment. > // (Optional) Add a Link flow customization created in Console: > // flowId: '', > // (Optional) Limit Link search to specific Items: > // items: ['item_000000001', 'item_000000002'], > // (Optional) Connect directly to an existing account: > // accountId: '', > // (Optional) Set a language. Options: EN, ES, RU, ZH > // language: Language.EN, > // (Optional) Callback examples: > onAccountConnected: (payload) => console.log('onAccountConnected', payload), > onAccountError: (payload) => console.log('onAccountError', payload), > onTokenExpired: (updateToken) => { > console.log('onTokenExpired'); > // Generate a new user token. > // updateToken(newToken) > }, > }; > > ArgyleLink.start(config); > // ArgyleLink.close() // Manually close Link (typically the user closes Link). > ``` > [tab] connectUrl > > 1. [Create a session](/api-reference/verifications/create-a-session) as part of a payroll verification workflow. > 2. Copy the response `link`. > 3. Pass that value as `connectUrl` in your Link initialization. > > ```js theme={} > import { ArgyleLink } from '@argyleio/argyle-plugin-react-native'; > > // ... > > const config = { > connectUrl: 'SESSION_LINK', > // (Optional) Callback examples: > onAccountConnected: (payload) => console.log('onAccountConnected', payload), > onAccountError: (payload) => console.log('onAccountError', payload), > }; > > ArgyleLink.start(config); > // ArgyleLink.close() // Manually close Link (typically the user closes Link). > ``` ## Flutter Argyle's [Flutter SDK](https://github.com/argyle-systems/argyle-link-flutter) provides a way to integrate Link into your mobile applications. First-time installation instructions are below. To update versions, visit our [Flutter upgrade guide](/link/upgrade#flutter). ### Requirements - Flutter SDK > [tab] Android > > * Android 8.0 (minSdk/API level 26) and above > * compileSdk 34 and above > > Set the `minSdkVersion` in your `android/app/build.gradle` file to: > > ```text theme={} > android { > defaultConfig { > minSdkVersion 26 // or greater > } > } > ``` > [tab] iOS > > * iOS 14.0+, Xcode 14.0+, Swift 5.5+ ### Installing the Flutter SDK Add `argyle_link_flutter` as a [dependency](https://docs.flutter.dev/development/packages-and-plugins/using-packages) in your `pubspec.yaml` file. > [accordion] Example installation: > > Using Flutter, run the command: > > ```text theme={} > $ flutter pub add argyle_link_flutter > ``` > > This will add a line to your `pubspec.yaml` file with the latest SDK version: > > ```text theme={} > dependencies: > argyle_link_flutter: ^1.x.x > ``` > > You can now import the package into your Dart code using: > > ```text theme={} > import 'package:argyle_link_flutter/argyle_link_flutter.dart'; > ``` ### Initialize Link > [tab] userToken > > Create a user token: > > * **New users**: create the user via [`POST /v2/users`](/api-reference/users/create-a-user) and use the returned `user_token`. > * **Returning users**: create a new token via [`POST /v2/user-tokens`](/api-reference/user-tokens/create-a-user-token) and use the returned `user_token`. > > Initialize Link using the configuration below, replacing the user token. > > ```dart theme={} > import 'package:argyle_link_flutter/link_config.dart'; > // (Required if using callbacks) Callback argument type definitions: > import 'package:argyle_link_flutter/account_data.dart'; > import 'package:argyle_link_flutter/argyle_link.dart'; > import 'package:argyle_link_flutter/form_data.dart'; > > // ... > > final config = LinkConfig( > userToken: 'USER_TOKEN', > sandbox: true, // Set to false for production environment. > // (Optional) Add a Link flow customization created in Console: > // flowId: '', > // (Optional) Limit Link search to specific Items: > // items: ['item_000000001', 'item_000000002'], > // (Optional) Connect directly to an existing account: > // accountId: '', > // (Optional) Set a language. Options: en, es, ru, zh > // language: Language.en, > // (Optional) Callback examples: > onAccountConnected: (payload) => debugPrint('onAccountConnected'), > onAccountError: (payload) => debugPrint('onAccountError'), > onTokenExpired: (updateToken) { > debugPrint('onTokenExpired'); > // Generate a new user token. > // updateToken(newToken); > }, > ); > > ArgyleLink.start(config); > // ArgyleLink.close() // Manually close Link (typically the user closes Link). > ``` > [tab] connectUrl > > 1. [Create a session](/api-reference/verifications/create-a-session) as part of a payroll verification workflow. > 2. Copy the response `link`. > 3. Pass that value as `connectUrl` in your Link initialization. > > ```dart theme={} > import 'package:argyle_link_flutter/link_config.dart'; > // (Required if using callbacks) Callback argument type definitions: > import 'package:argyle_link_flutter/account_data.dart'; > import 'package:argyle_link_flutter/argyle_link.dart'; > import 'package:argyle_link_flutter/form_data.dart'; > > // ... > > final config = LinkConfig( > connectUrl: 'SESSION_LINK', > // (Optional) Callback examples: > onAccountConnected: (payload) => debugPrint('onAccountConnected'), > onAccountError: (payload) => debugPrint('onAccountError'), > ); > > ArgyleLink.start(config); > // ArgyleLink.close() // Manually close Link (typically the user closes Link). > ``` # Overview Source: https://docs.argyle.com/link/initialization/overview Choose how to initialize Argyle Link. Argyle Link can be embedded in your application or launched as a hosted session URL. Choose the frontend integration based on where Link will run, then choose the authentication path based on the backend workflow your implementation uses. ## Choose how to integrate > [card] [Web SDK](/link/initialization/web) > > Embed Link in a browser with the Web SDK. > [card] [Mobile SDKs](/link/initialization/mobile-sdks) > > Embed Link with the iOS, Android, React Native, or Flutter SDKs. > [card] [Hosted Link](/link/initialization/hosted-link) > > Launch a session URL directly in a browser or secure mobile browser context. ## Choose an authentication path The backend workflow determines which value your frontend uses to start Link. | Backend workflow | Frontend value | Use with | | - | - | - | | Direct embedded Link | `userToken` and `sandbox` | [Web SDK](/link/initialization/web) or [Mobile SDKs](/link/initialization/mobile-sdks) | | Payroll verification session | Session `link` used as `connectUrl` | [Web SDK](/link/initialization/web) or [Mobile SDKs](/link/initialization/mobile-sdks) | | Payroll verification session | Session `link` launched directly | [Hosted Link](/link/initialization/hosted-link) | For direct embedded Link implementations, create a new user or refresh an existing user's token on your server, then initialize embedded Link with the returned `user_token`. For payroll verification implementations, create a session via [`POST /v2/sessions`](/api-reference/verifications/create-a-session). The response includes a `link` URL. Pass that URL as `connectUrl` in an embedded Link SDK initialization, or launch it directly as Hosted Link. > [!NOTE] > > Banking connections do not use Argyle Link. Create a banking verification session and pass its returned `link` to the [banking SDK](/verifications/verification-types/banking) as `connectURL`. > [!NOTE] > > User tokens and session links both expire after one hour. Create a fresh user token before initializing Link with `userToken`, or create a new session link for an active payroll verification before initializing Link with `connectUrl` or launching Hosted Link. ## Required initialization parameters Use either the `connectUrl` path or the `userToken` path. Do not pass both in the same Link initialization. | Parameter | Type | Required when | Description | | - | - | - | - | | `connectUrl` | string | Initializing embedded Link from a payroll verification session | The session `link` URL returned when [creating a payroll session](/api-reference/verifications/create-a-session). Link's environment is encoded in the URL and does not need to be set with `sandbox`. | | `userToken` | string | Initializing embedded Link through the user token flow | Token used to identify and authenticate users. See [User Tokens](/link/user-tokens). | | `sandbox` | boolean | Initializing embedded Link through the user token flow | Determines Link's environment: `true` for Sandbox, `false` for Production. | ## Optional initialization parameters > [!NOTE] > > `flowId`, `items`, and `language` can also be provided in the [verification session request](/verifications/quickstart#create-a-session). > [!NOTE] > > Flow IDs are not environment-specific: the same Flow ID applies consistent behavior across both Sandbox and Production.
Parameter Type Description
`flowId` string ID used to [customize](/console/flows/embedded-experiences) the Link flow. Saved Flow IDs can be found in the [Flows](https://console.argyle.com/flows) section of Console.
`items` array of strings Limits Link to the provided Items. Providing one Item skips Link search and opens that Item's login screen. Providing multiple Items shows only those Items.
`accountId` string Used for [direct logins](/workflows/account-connections#direct-login) to an account that the user has previously connected or attempted to connect.
`` string [Callbacks](/link/reference/callbacks) are activated by specific events in embedded Link, such as account connection, errors, closure, and token expiration. Hosted Link does not support callbacks.
`language` string Sets the display language in Link. > [!NOTE] > > **Possible values**:\\ > > `EN` (English), `ES` (Spanish), `RU` (Russian), `ZH` (Chinese), `HT` (Haitian Creole, Web only)\\ > > *\*Flutter uses lowercase `en`, `es`, `ru`, `zh`*
  • `EN` and `ES` are available across all platforms and employers
  • `RU` and `ZH` currently limited to [gig platforms](/overview/data-structure/items#types-of-items)
  • `HT` is available on Web only, across all payroll and gig platforms.
  • Can be used in combination with other optional initialization parameters including `flowId`
  • Certain platform-generated messages, such as multi-factor authentication prompts, will be shown as-received and depend on the user's language preferences selected within their platform's settings.
  • In Console, you can test Spanish in Sandbox mode by changing the **Language** dropdown when previewing an **Embedded Experiences** Link Flow.
## Next steps * Use [Web SDK](/link/initialization/web) for browser-based embedded Link. * Use [Mobile SDKs](/link/initialization/mobile-sdks) for native or cross-platform mobile SDK setup. * Use [Hosted Link](/link/initialization/hosted-link) when you want to launch a session URL directly. # Web SDK Source: https://docs.argyle.com/link/initialization/web Embed Argyle Link in a browser with the Web SDK. Use the Web SDK when Link should run inside your browser application. The Web SDK supports callbacks and frontend control over when Link opens and closes. > [!NOTE] > > If you need iframe isolation, use the Web SDK with `connectUrl` instead of loading Hosted Link inside an iframe. Hosted Link is intended to be launched directly. > [!NOTE] > > User tokens and session links both expire after one hour. Create a fresh user token before initializing Link with `userToken`, or create a new session link for an active verification before initializing Link with `connectUrl`. ## Before you start 1. When using a webview component, make sure `localStorage` is enabled, `domStorageEnabled` is set to `true`, and `incognito` is set to `false`. 2. If your security policy limits outgoing traffic, allow Link API calls by whitelisting outgoing traffic from Link with these content sources at minimum: ```html theme={} ``` ## Initialize with userToken Use this path for direct embedded Link implementations that use user tokens. Create a user token on your server: * **New users**: create the user via [`POST /v2/users`](/api-reference/users/create-a-user) and use the returned `user_token`. * **Returning users**: create a new token via [`POST /v2/user-tokens`](/api-reference/user-tokens/create-a-user-token) and use the returned `user_token`. Initialize Link with the Web SDK: ```html theme={} ``` ## Initialize with connectUrl Use this path when your backend creates a payroll verification session. 1. Create a session via [`POST /v2/sessions`](/api-reference/verifications/create-a-session). 2. Copy the response `link`. 3. Pass that value as `connectUrl` in your Web SDK initialization. For banking verification sessions, pass the returned session `link` to the banking SDK as `connectURL`. The session URL already determines whether Link runs in Sandbox or Production. Do not pass `sandbox` with `connectUrl`. ```html theme={} ``` ## Track Link activity Embedded Web Link supports [callbacks](/link/reference/callbacks), including `onAccountConnected`, `onAccountError`, `onClose`, and `onTokenExpired`. For verification workflows, also subscribe to [`verifications.updated`](/api-reference/verifications-webhooks/updated) webhooks so your backend can track the verification lifecycle. # Overview Source: https://docs.argyle.com/link/overview Link is where payroll connections are made. Users connect payroll accounts, upload documents, and manage existing payroll connections in Link. ## Choose how to launch Link For API implementations, first choose the workflow, then how users will open Link. ### Choose the workflow * **Verifications:** Create a [session](/verifications/quickstart#create-a-session) and use the returned `link` to launch Link. * **Data APIs:** Create a [user token](/link/user-tokens) for the user and use it to initialize embedded Link. ### Choose how users open Link * **Embedded Link:** Use the [Web SDK](/link/initialization/web) or a supported [Mobile SDK](/link/initialization/mobile-sdks). Initialize Link with `connectUrl` for a verification session or `userToken` for a Data API workflow. * **Hosted Link:** Open the verification session's `link` directly in a browser. See [Hosted Link](/link/initialization/hosted-link). * **Email or text invitation:** Send a [verification invite through the API](/verifications/quickstart#invites) by creating a session with `type` set to `invite`. In Console, you can also [send invitations manually](/console/flows/email-sms-templates) or [create Shareable URLs](/console/flows/shareable-urls). ![Link is where payroll accounts are connected through Argyle.](https://mintcdn.com/argyle/zs6lb-w1jQV9DVbr/images/overview/how-argyle-works/2-how-argyle-works.png?fit=max\&auto=format\&n=zs6lb-w1jQV9DVbr\&q=85\&s=c9423cb37168de456ad6b65dce23efa6) ## Standard connection process Without any [customizations](/console/flows/embedded-experiences), the standard payroll connection process in Link is as follows: > [tab] Step 1 > > The user searches from a general list of potential income sources. This includes employers, government entities, and payroll services. > > ![Search screen in Link.](https://mintcdn.com/argyle/0Z2zBY-iD5Q5BvPN/images/argyle-guides/link/analytics/2-search-screen.png?fit=max\&auto=format\&n=0Z2zBY-iD5Q5BvPN\&q=85\&s=1e4bb8b3317fc3a242c8faaf630ed961) > [tab] Step 2 > > If the user cannot find their source of income from this general list, they will be prompted to search from a list of only payroll providers that service multiple employers. > > ![Can't find income source screen in Link.](https://mintcdn.com/argyle/lpddaw6ggr_B1oHD/images/argyle-guides/workflows/account-connections/2-account-connections.png?fit=max\&auto=format\&n=lpddaw6ggr_B1oHD\&q=85\&s=62cb71373764ff4af23f940c714740b1) > > > [!NOTE] > > > > These payroll providers are searchable in step 1, but we have found narrowing the search focus to payroll providers improves the connection success rate for users. > [tab] Step 3 > > If the user successfully finds their source of income, they are taken to its respective login screen. From the login screen, the user can enter their login credentials to connect their account. > > ![Login screen in Link.](https://mintcdn.com/argyle/0Z2zBY-iD5Q5BvPN/images/argyle-guides/link/analytics/3-login-screen.png?fit=max\&auto=format\&n=0Z2zBY-iD5Q5BvPN\&q=85\&s=22a866e61fab748d61da3553ab4a8dea) > > * If the user cannot remember their login credentials, the login screen provides a link to the platform's username/password reset process. > > * Each login screen is tailored to match the input fields used by the underlying payroll system. For example, some systems require a username and password, others an email and password, while others may use SSO methods to login. You can preview the login screen for any employer or payroll system in the [Flows](https://console.argyle.com/flows) section of Console. > > > [!NOTE] > > > > For phone number logins, Link will automatically adjust the country code and input format based on the user's device settings: > > > > Link automatically formats phone inputs. > > ![Link automatically formats phone inputs.](https://mintcdn.com/argyle/lpddaw6ggr_B1oHD/images/argyle-guides/link/overview/1-link-overview.png?fit=max\&auto=format\&n=lpddaw6ggr_B1oHD\&q=85\&s=3a071ae4c4181a148e55a61db8ebca46) > [tab] Step 4 > > If the user cannot ultimately find their source of income, they are asked to submit a response form and list their employers or payroll providers. > > ![Response form screen in Link.](https://mintcdn.com/argyle/lpddaw6ggr_B1oHD/images/argyle-guides/workflows/account-connections/4-account-connections.png?fit=max\&auto=format\&n=lpddaw6ggr_B1oHD\&q=85\&s=3f9271523e114f21e6af3f1f65bb67bd) ## Link screens Our [UI Toolkit](https://www.figma.com/design/i5gVMi4YmZD2YblzvhvZRl/Argyle-Link-%E2%80%93-UI-toolkit?node-id=2605-12927\&t=6zIDYkV6qrHD9h4P-0) in Figma provides screen mockups of the user experience in Link for common flows: > [tab] Solutions Flows > > * Verification of income and employment > * Paycheck-linked lending > * Earned wage access > [tab] Advanced Flows > > * Direct login > * Account re-authentication > * Fallback flows > * Revoking account access > * Connecting multiple accounts > [tab] Document Upload Flows > > * Document upload from the intro screen > * Document upload as a fallback flow > * Go directly to document uploading, bypassing Link search > [!NOTE] > > You can also preview and test different flows in the [Flows section of Console](https://console.argyle.com/flows). ## Additional resources * Visit our [Workflows Guides](/workflows/account-connections) to learn how to adjust Link's payroll account connection process and enable document upload. * Branding and customizing Link is discussed in our [Flows Guides](/console/flows/embedded-experiences). * (Embedded Link) Create automations using [Link Callbacks](/link/reference/callbacks). * (Embedded Link) Capture how users interact with Link using our [Tracking Guide](/link/reference/tracking). # Callbacks Source: https://docs.argyle.com/link/reference/callbacks Respond to immediate user actions and state changes in embedded Link. Use callbacks to respond to user actions and state changes in embedded Link. For example, the `onAccountConnected` callback lets your application respond when a user successfully connects an account. > [!NOTE] > > Callbacks are not designed to be a primary source of analytics information. For detailed metrics on step-by-step conversion success rates, visit the **Conversion** area of [Console's Dashboard](https://console.argyle.com/dashboard) or contact your customer success manager. ## Callback formats Although optional, adding callbacks is simple. Just add a few lines of code to your Link initialization. Below are example Link initializations that include every callback: > [tab] Web > > ```html theme={} > > > > > > > > > > > > > > ``` > [tab] iOS > > ```swift theme={} > var config = LinkConfig( > userToken: "USER_TOKEN", > sandbox: true // Set to false for production environment. > ) > // (Optional) Callback examples: > config.onAccountConnected = { data in > print("Result: onAccountConnected \(data)") > } > config.onAccountCreated = { data in > print("Result: onAccountCreated \(data)") > } > config.onAccountError = { data in > print("Result: onAccountError \(data)") > } > config.onAccountRemoved = { data in > print("Result: onAccountRemoved \(data)") > } > config.onCantFindItemClicked = { data in > print("Result: onCantFindItemClicked \(data)") > } > config.onClose = { > print("Result: onClose") > } > config.onDocumentsSubmitted = { data in > print("Result: onDocumentsSubmitted \(data)") > } > config.onFormSubmitted = { data in > print("Result: onFormSubmitted \(data)") > } > config.onUIEvent = { data in > print("Result: onUIEvent \(data)") > } > config.onError = { data in > print("Result: onError \(data)") > } > config.onTokenExpired = { handler in > print("onTokenExpired") > // Generate a new user token. > // handler(newToken) > } > > ArgyleLink.start(from: viewController, config: config) > // ArgyleLink.close() // Manually close Link (typically the user closes Link). > ``` > [tab] Android > > ```kotlin theme={} > val config = LinkConfig( > userToken = "USER_TOKEN", > sandbox = true // Set to false for production environment. > ) > // (Optional) Callback examples: > config.onAccountConnected = { data -> > Log.d("Result", "onAccountConnected $data") > } > config.onAccountCreated = { data -> > Log.d("Result", "onAccountCreated $data") > } > config.onAccountError = { data -> > Log.d("Result", "onAccountError $data") > } > config.onAccountRemoved = { data -> > Log.d("Result", "onAccountRemoved $data") > } > config.onCantFindItemClicked = { data -> > Log.d("Result", "onCantFindItemClicked $data") > } > config.onClose = { > Log.d("Result", "onClose") > } > config.onDocumentsSubmitted = { data -> > Log.d("Result", "onDocumentsSubmitted $data") > } > config.onFormSubmitted = { data -> > Log.d("Result", "onFormSubmitted $data") > } > config.onUIEvent = { data -> > Log.d("Result", "onUIEvent $data") > } > config.onError = { data -> > Log.d("Result", "onError $data") > } > config.onTokenExpired = { handler -> > // Generate a new user token. > // handler(newToken) > } > > ArgyleLink.start(context, config) > // ArgyleLink.close() // Manually close Link (typically the user closes Link). > ``` > [tab] React Native > > ```js theme={} > import { ArgyleLink } from '@argyleio/argyle-plugin-react-native'; > > // ... > > const config = { > userToken: 'USER_TOKEN', > sandbox: true, // Set to false for production environment. > // (Optional) Callback examples: > onAccountConnected: (payload) => console.log('onAccountConnected', payload), > onAccountCreated: (payload) => console.log('onAccountCreated', payload), > onAccountError: (payload) => console.log('onAccountError', payload), > onAccountRemoved: (payload) => console.log('onAccountRemoved', payload), > onCantFindItemClicked: (payload) => console.log('onCantFindItemClicked', payload), > onClose: () => console.log('onClose'), > onDocumentsSubmitted: (payload) => console.log('onDocumentsSubmitted', payload), > onFormSubmitted: (payload) => console.log('onFormSubmitted', payload), > onUIEvent: (payload) => console.log('onUIEvent', payload), > onError: (payload) => console.log('onError', payload), > onTokenExpired: (updateToken) => { > console.log('onTokenExpired'); > // Generate a new user token. > // updateToken("") > }, > }; > > ArgyleLink.start(config); > // ArgyleLink.close() // Manually close Link (typically the user closes Link). > ``` > [tab] Flutter > > ```dart theme={} > import 'package:argyle_link_flutter/link_config.dart'; > // (Required if using callbacks) Callback argument type definitions > import 'package:argyle_link_flutter/account_data.dart'; > import 'package:argyle_link_flutter/argyle_link.dart'; > import 'package:argyle_link_flutter/form_data.dart'; > > // ... > > final config = LinkConfig( > userToken: 'USER_TOKEN', > sandbox: true, // Set to false for production environment. > // (Optional) Callback examples: > onAccountConnected: (payload) => debugPrint('onAccountConnected'), > onAccountCreated: (payload) => debugPrint('onAccountCreated'), > onAccountError: (payload) => debugPrint('onAccountError'), > onAccountRemoved: (payload) => debugPrint('onAccountRemoved'), > onCantFindItemClicked: (payload) => debugPrint('onCantFindItemClicked'), > onClose: () => debugPrint('onClose'), > onDocumentsSubmitted: (payload) => debugPrint('onDocumentsSubmitted'), > onFormSubmitted: (payload) => debugPrint('onFormSubmitted'), > onUIEvent: (payload) => debugPrint('onUIEvent'), > onError: (payload) => debugPrint('onError'), > onTokenExpired: (updateToken) => { > debugPrint('onTokenExpired') > // Generate a new user token. > // updateToken(newToken) > }, > ); > > ArgyleLink.start(config); > // ArgyleLink.close() // Manually close Link (typically the user closes Link). > ``` ## Account callbacks ### `onAccountConnected` Invoked when an account is successfully authenticated (including MFA) to an Item. Also invoked when a user reconnects a previously disconnected account. **Returns**: ```json theme={} AccountData ( "accountId": String, "userId": String, "itemId": String ) ``` ### `onAccountCreated` Invoked when a user clicks **Connect** in Link, which creates an account for the user. > [!NOTE] > > This callback is invoked *before* account authentication (successful or unsuccessful) to an Item. **Returns**: ```json theme={} AccountData ( "accountId": String, "userId": String, "itemId": String ) ``` ### `onAccountError` Invoked if an account fails to authenticate to an Item. **Returns**: ```json theme={} AccountData ( "accountId": String, "userId": String, "itemId": String ) ``` ### `onAccountRemoved` Invoked when a user revokes access to a connected account. **Returns**: ```json theme={} AccountData ( "accountId": String, "userId": String, "itemId": String ) ``` ## User flow callbacks ### `onCantFindItemClicked` Invoked when the user selects **"If no results"** in Link, which is shown *only if* you selected the **Callback** [fallback experience](/console/flows/shareable-urls#argyle-link) when customizing any type of [Link Flow](https://console.argyle.com/flows) in Console. This callback closes Link and **returns the user's search query**. > [!NOTE] > > The `onCantFindItemClicked` callback will always precede the `onClose` callback. ### `onClose` Invoked when the user closes Link. **Returns**: ```json theme={} UserData ( "userSubmissionComplete": Boolean, "userAttemptedEmployerSelection": Boolean ) ``` * `userSubmissionComplete` — Will be `true` if at least one account is connected. Will remain `false` if no accounts are connected (including when only documents are uploaded or only a form is submitted). * `userAttemptedEmployerSelection` — Will be `true` only if the user actively searched for an employer within Link. > [!NOTE] > > When [integrations](/integrations/pos-los/ncino) are enabled that require a specific length of employment history, `userSubmissionComplete` will be `true` only when connected accounts meet history length requirements. ### `onDocumentsSubmitted` Invoked when the user selects **Submit** after initially uploading documents through Link's [document upload](/workflows/document-processing) workflow, and every subsequent document upload thereafter. **Returns**: ```json theme={} FormData ( "accountId": String, // (deprecated) "userId": String ) ``` ### `onFormSubmitted` Invoked when a response form is submitted through Link's **"If no results"** experience (configurable via [Flows](https://console.argyle.com/flows) in Console). **Returns**: ```json theme={} FormData ( "accountId": String, "userId": String ) ``` ### `onSelfCertificationSubmitted` Invoked once when a user successfully submits a self-certification in Link for a [government verification](/verticals/government-benefits). > [!NOTE] > > This callback is available only in **Web Link**. **Returns**: ```json theme={} FormData ( "userId": String, "hasComment": Boolean ) ``` * `userId` — ID of the user. * `hasComment` — Will be `true` only if the user entered text in **Additional comments**. ### `onUIEvent` Invoked when specific UI events occur in Link. > [!NOTE] > > This callback and its event-specific return values are detailed in-depth in our [Tracking guide](/link/reference/tracking). ## Operational callbacks ### `onError` Invoked when Link encounters an internal problem that breaks the flow for the user. **Returns**: ```json theme={} LinkError ( "userId": String, "errorType": String (enum), "errorMessage": String, "errorDetails": String ) ``` * `userId` — ID of the user. * `errorType` — Which [Link error](/link/reference/error-codes) occurred. * `errorMessage` — The error message shown to the user. * `errorDetails` - The "error details" of the Link error. ### `onTokenExpired` Invoked when a [user token](/link/user-tokens) expires (iOS, Android, React Native, Flutter) or 5 minutes before a user token expires (Web). > [!NOTE] > > After a user token expires, any additional actions taken by the user during the same Link session will result in an `invalid_user_token` error. This callback provides another function as a parameter, which can be used to update the user token for the user's current Link session. This prevents having to close and re-initialize Link for the user. To use this function: 1. Create a new user token 2. Call the function with the user token as the argument # Error Codes Source: https://docs.argyle.com/link/reference/error-codes Handle errors returned by the Link SDK and embedded connection experience. Link errors: common causes and troubleshooting. ## Overview When a user encounters an error in Link, they are shown an error screen that displays suggestions for resolving the particular issue. *For easier troubleshooting, we recommend you include the* `onError` *[callback](/link/reference/callbacks#onerror) in your Link initialization.* The `onError` callback returns: ```json theme={} LinkError ( "userId": String, // ID of the user "errorType": String (enum), // Error name "errorMessage": String, // User message "errorDetails": String // Error details ) ``` ## Link errors ### `callback_undefined` > [tab] User message > > This page does not exist. Reach out to \[Company name] for help. > [tab] Error details > > Reason: callback undefined (`onCantFindItemClicked`) > [tab] Common causes > > The **Callback** experience type was selected for **"If no results"** when customizing a [Link Flow](https://console.argyle.com/flows), but the `onCantFindItemClicked` callback was not included in the Link initialization. > [tab] Troubleshooting > > Include the `onCantFindItemClicked` callback in your Link initialization. ![callback\_undefined Link error](https://mintcdn.com/argyle/0Z2zBY-iD5Q5BvPN/images/argyle-guides/link/error-codes/1-callback-undefined.png?fit=max\&auto=format\&n=0Z2zBY-iD5Q5BvPN\&q=85\&s=8190946f48b2528a1bd366b8521a119e) ### `duplicate_account` > [tab] User message > > This User ID is already associated with a connected account. Please try a different User ID to connect another account. > [tab] Error details > > none > [tab] Common causes > > The user attempted to connect an already-connected account. > [tab] Troubleshooting > > Advise the user to double-check which log in credentials they currently or originally used for the intended employer. ![duplicate\_account Link error](https://mintcdn.com/argyle/0Z2zBY-iD5Q5BvPN/images/argyle-guides/link/error-codes/13-duplicate-account.png?fit=max\&auto=format\&n=0Z2zBY-iD5Q5BvPN\&q=85\&s=bde21c89bda94211004d811e37940da6) ### `embedded_employer_inaccessible` > [tab] User message > > We couldn’t reach \[Company name] from your current setup. Try connecting the same way you normally sign in to \[Company name]. These are the most common things to check: > > * Connect to your company VPN or network > * Use an approved work device > [tab] Error details > > none > [tab] Common causes > > Link could not load the employer's embedded login page. The employer may require access through a company VPN or network, or from an approved work device. > [tab] Troubleshooting > > Advise the user to connect to their company VPN or network, use an approved work device, and try again. ![embedded\_employer\_inaccessible Link error](https://mintcdn.com/argyle/hRBomb_ZRxtZeKm2/images/argyle-guides/link/error-codes/14-embedded-employer-inaccessible.png?fit=max\&auto=format\&n=hRBomb_ZRxtZeKm2\&q=85\&s=4ef94f3c6aef12648317d30c79caa01a) ### `expired_user_token` > [tab] User message > > The service is experiencing connection problems. Please try again later. > [tab] Error details > > User ID: `` (see [user ID](/api-reference/users)) > > Reason: expired `userToken` > [tab] Common causes > > Link was initialized with an expired user token, or the user token expired during the Link session. > [tab] Troubleshooting > > Create a new user token, and either: > > 1. Re-initialize Link with the new user token. > 2. Pass the new user token to the `onTokenExpired` [callback](/link/reference/callbacks#ontokenexpired) to continue the existing Link session. ![expired\_user\_token Link error](https://mintcdn.com/argyle/0Z2zBY-iD5Q5BvPN/images/argyle-guides/link/error-codes/4-expired-user-token.png?fit=max\&auto=format\&n=0Z2zBY-iD5Q5BvPN\&q=85\&s=063a02ef72fe1816e66c966de4bd1c20) ### `generic` > [tab] User message > > The service is experiencing connection problems. Please try again later. > [tab] Error details > > none > [tab] Common causes > > An unexpected error occurred. We are looking into it. > [tab] Troubleshooting > > Contact our support team for more details. ![generic Link error](https://mintcdn.com/argyle/0Z2zBY-iD5Q5BvPN/images/argyle-guides/link/error-codes/5-generic.png?fit=max\&auto=format\&n=0Z2zBY-iD5Q5BvPN\&q=85\&s=dae9f9d04b669553c5d3a7d09d78712f) ### `invalid_account_id` > [tab] User message > > The page does not exist. Reach out the \[Company] for help. > [tab] Error details > > Reason: invalid accountId > [tab] Common causes > > An invalid `accountId` was used for [direct login to an existing account](/workflows/account-connections#existing-connections) when initializing Link. > [tab] Troubleshooting > > Use the [accounts API endpoint](/api-reference/accounts#list) with the user's `id` as a query parameter to see a list of valid `accountId`'s for the user. ![invalid\_account\_id Link error](https://mintcdn.com/argyle/0Z2zBY-iD5Q5BvPN/images/argyle-guides/link/error-codes/7-invalid-account-id.png?fit=max\&auto=format\&n=0Z2zBY-iD5Q5BvPN\&q=85\&s=0fa500248769b6d9b4e56ce730533fc0) ### `invalid_items` > [tab] User message > > This page does not exist. Reach out to \[Company name] for help. > [tab] Error details > > Reason: invalid custom items > [tab] Common causes > > * [Direct login](/workflows/account-connections#direct-login) was used for an Item that does not exist. > * Link search was constrained to Items that do not exist. > * Link was initialized with the optional `items` [initialization parameter](/link/initialization/overview#optional-initialization-parameters) but an empty array was present. > [tab] Troubleshooting > > Use the Items endpoint and Console's [Coverage](https://console.argyle.com/coverage) page to check Item availability. ![invalid\_items Link error](https://mintcdn.com/argyle/lpddaw6ggr_B1oHD/images/argyle-guides/link/error-codes/9-invalid-items.png?fit=max\&auto=format\&n=lpddaw6ggr_B1oHD\&q=85\&s=2725968c93db08f171343bfd009a1d2e) ### `invalid_user_token` > [tab] User message > > The service is experiencing connection problems. Please try again later. > [tab] Error details > > Reason: invalid userToken > [tab] Common causes > > The [user token](/link/user-tokens) provided in the Link initialization was not valid. > [tab] Troubleshooting > > Check the user token was provided correctly in the Link initialization. See our [user tokens guide](/link/user-tokens) for more information. ![invalid\_user\_token Link error](https://mintcdn.com/argyle/0Z2zBY-iD5Q5BvPN/images/argyle-guides/link/error-codes/11-invalid-user-token.png?fit=max\&auto=format\&n=0Z2zBY-iD5Q5BvPN\&q=85\&s=a9215360f8038f8161491ea1477b90c7) # Tracking Source: https://docs.argyle.com/link/reference/tracking Track user interaction events from embedded Link. Capture how users interact with Link. ## Overview You can track user behavior in Link by including the `onUIEvent` callback in your Link initialization. The `onUIEvent` callback is triggered for specific UI events in Link, and although optional, including this callback can help with troubleshooting as well as optimizing conversion rates. > [!NOTE] > > Callbacks are not designed to be a primary source of analytics information. For detailed metrics on step-by-step conversion success rates, visit the **Conversion** area of [Console's Dashboard](https://console.argyle.com/dashboard) or contact your customer success manager. ## Callback format Add the line below to your Link initialization: > [tab] Web > > ```js theme={} > onUIEvent: (payload) => console.log('onUIEvent', payload), > ``` > [tab] iOS > > ```swift theme={} > config.onUIEvent = { data in > print("Result: onUIEvent \(data)") > } > ``` > [tab] Android > > ```kotlin theme={} > config.onUIEvent = { data -> > Log.d("Result", "onUIEvent $data") > } > ``` > [tab] React Native > > ```js theme={} > onUIEvent: (payload) => console.log('onUIEvent', payload); > ``` > [tab] Flutter > > ```dart theme={} > onUIEvent: (payload) => debugPrint('onUIEvent'); > ``` ## Callback payload The `onUIEvent` callback returns: 1. The `name` of the [UI-related Event](/link/reference/tracking#events) that triggered the callback. 2. A `properties` object, which can include: * `deepLink` (always) — Whether the user was [directly connected](/workflows/account-connections#direct-login) to the Item. * `userId` (always) — ID of the user. * `accountId` (conditional) — ID of the user's account. * `itemId` (conditional) — ID of the relevant Item. * Event-specific properties (conditional) — See [Events](/link/reference/tracking#events) below. #### Example: ```json theme={} UIEvent ( "name": "mfa - opened", "properties": { "deepLink": false, "userId": "019ac324-91b5-2e5b-dc96-c931e25da1e2", "itemId": "item_123456789", "type": "Login", "mfaType": "sms_code" } ) ``` ## Events ### Intro screen ![Intro screen in Link.](https://mintcdn.com/argyle/0Z2zBY-iD5Q5BvPN/images/argyle-guides/link/analytics/1-intro-screen.png?fit=max\&auto=format\&n=0Z2zBY-iD5Q5BvPN\&q=85\&s=3a25a8612a9820c7261eb238d32def0b) | Event Name | Event Description | Event Specific Properties | | - | - | - | | `intro - opened` | The user opened the intro screen. | none | ### Search screen ![Search screen in Link.](https://mintcdn.com/argyle/0Z2zBY-iD5Q5BvPN/images/argyle-guides/link/analytics/2-search-screen.png?fit=max\&auto=format\&n=0Z2zBY-iD5Q5BvPN\&q=85\&s=1e4bb8b3317fc3a242c8faaf630ed961) | Event Name | Event Description | Event Specific Properties | | - | - | - | | `search - opened` | The user opened the search screen. | none | | `search - term updated` | The user entered a search term. | `term`, `tab` | | `search - link item selected` | The user selected an Item from the search screen. | `term`, `tab` | **Property definitions:** * `term` — The text entered in the search field. * `tab` — The tab that was open when the user entered a search term or selected an Item. Ignored for empty (or deleted) search terms. Possible values: `Popular`, `Payroll providers`, `Employers` ### User profile screen ![Your connections screen in Link.](https://mintcdn.com/argyle/zs6lb-w1jQV9DVbr/images/workflows/reconnecting-accounts/8-reconnecting-accounts.png?fit=max\&auto=format\&n=zs6lb-w1jQV9DVbr\&q=85\&s=64ab75eeece21ea24fee266a9227f692) | Event Name | Event Description | Event Specific Properties | | - | - | - | | `user profile - opened` | The user opened the user profile (Your connections) screen. | none | ### Login screen ![Login screen in Link.](https://mintcdn.com/argyle/0Z2zBY-iD5Q5BvPN/images/argyle-guides/link/analytics/3-login-screen.png?fit=max\&auto=format\&n=0Z2zBY-iD5Q5BvPN\&q=85\&s=22a866e61fab748d61da3553ab4a8dea) | Event Name | Event Description | Event Specific Properties | | - | - | - | | `login - opened` | The user opened the login screen or was returned to the login screen after a connection error. | `errorCode`, `errorMessage` | | `login - form submitted` | The user submitted login credentials. | none | | `login - login help clicked` | The user selected "Login help". | none | **Property definitions:** * `errorCode` — The [account connection error](/api-reference/account-connection-errors) relevant to the login screen that occurred. Possible values: `auth_required`, `connection_unavailable`, `expired_credentials`, `invalid_auth`, `invalid_credentials`, `mfa_cancelled_by_the_user` * `errorMessage` — The account connection error message shown to the user. ### MFA screen ![MFA screen in Link.](https://mintcdn.com/argyle/0Z2zBY-iD5Q5BvPN/images/argyle-guides/link/analytics/4-MFA-screen.png?fit=max\&auto=format\&n=0Z2zBY-iD5Q5BvPN\&q=85\&s=34f6d7702abfa4171f5112bbf8415ee3) | Event Name | Event Description | Event Specific Properties | | - | - | - | | `mfa - opened` | The user was routed through a [multi-factor authentication (MFA) process](/workflows/account-connections#completing-mfa). | `type`, `mfaType` | **Property definitions:** * `type` — Whether MFA occurred during login. Possible value: `Login` * `mfaType` — The type of MFA. Possible values: `sms_code`, `email_code`, `secret_question`, `email_link_confirmation`, `otp_code`, `email_message_confirmation` ### Success screen ![Success screen in Link.](https://mintcdn.com/argyle/0Z2zBY-iD5Q5BvPN/images/argyle-guides/link/analytics/5-success-screen.png?fit=max\&auto=format\&n=0Z2zBY-iD5Q5BvPN\&q=85\&s=dbd9a02a9e8c25e814639a4f09edabb4) | Event Name | Event Description | Event Specific Properties | | - | - | - | | `success - opened` | The user entered the success screen after a successful account connection. | none | ### Account status screen ![Account status screen in Link.](https://mintcdn.com/argyle/0Z2zBY-iD5Q5BvPN/images/argyle-guides/link/analytics/6-account-status.png?fit=max\&auto=format\&n=0Z2zBY-iD5Q5BvPN\&q=85\&s=c3da39cd32ad8027bad82a7bffee5c11) | Event Name | Event Description | Event Specific Properties | | - | - | - | | `account status - opened` | The user opened the account status screen. | none | | `account status - disconnected` | The user revoked access to an account. | none | ### Account error screen ![Account error screen in Link.](https://mintcdn.com/argyle/0Z2zBY-iD5Q5BvPN/images/argyle-guides/link/analytics/10-account-error.png?fit=max\&auto=format\&n=0Z2zBY-iD5Q5BvPN\&q=85\&s=8ec21debe76d11df07bca65b956d2786) | Event Name | Event Description | Event Specific Properties | | - | - | - | | `account error - opened` | The user encountered an error while connecting an account. | `connectionStatus`, `connectionErrorCode` | **Property definitions:** * `connectionStatus` — The `connection.status` of the [Account](/api-reference/accounts#object). * `connectionErrorCode` — The [account connection error](/api-reference/account-connection-errors) that occurred. > [!NOTE] > > `connectionErrorCode` is only returned when `connectionStatus` = `error` ### Link error screen ![Link error screen in Link.](https://mintcdn.com/argyle/0Z2zBY-iD5Q5BvPN/images/argyle-guides/link/analytics/11-link-error.png?fit=max\&auto=format\&n=0Z2zBY-iD5Q5BvPN\&q=85\&s=06f6f6ccfef1e9dbf144a86910ab23d5) | Event Name | Event Description | Event Specific Properties | | - | - | - | | `error - opened` | The user encountered an error while opening Link. | `errorType` | **Property definitions:** * `errorType` — The [Link error](/link/reference/error-codes) that occurred. ### Link closed Occurs when the user closes Link from any screen. | Event Name | Event Description | Event Specific Properties | | - | - | - | | `link closed` | The user closed Link. | `closeMethod ` | **Property definitions:** * `closeMethod` — How Link was closed. **Possible values:** > [!NOTE] > > * `footer_button` — Link was closed by the user selecting the `Done` (re-nameable) button on a final screen. > * `x` — Link was closed by the user selecting `[X]` in the upper-left of the screen. > * `null` — Link was closed programmatically via an [Argyle SDK](/link/initialization), or when the [onCantFindItemClicked](/link/reference/callbacks#oncantfinditemclicked) callback is used, or any other event that causes Link to close. # Upgrade Source: https://docs.argyle.com/link/upgrade Keep Link SDK installations current across web and mobile applications. Argyle periodically releases updates to its SDKs. These updates can include new functionalities, bug fixes, and security updates. For each new Link release, we recommend upgrading your SDK installation as soon as possible. * To stay notified about new Link releases, subscribe to our [Changelog](https://changelog.argyle.com/). All Link SDK versions are also made available or will soon be made available on our public [Github repository](https://github.com/argyle-systems). * For first time integrations, visit our [Initialization](/link/initialization) page. ## Web Link for Web updates automatically with each release. You do not need to take any steps to upgrade your Web integration. > [!NOTE] > > (Exception) If you are migrating from Link 4 to Link 5, note that the script plugin changed and is now: > > ``` > > ``` ## iOS **Requirements** — iOS 14.0+, Xcode 14.0+, Swift 5.5+ * To verify your current iOS SDK version, check the `Podfile.lock` file of your Xcode project. * Before upgrading, review our [iOS SDK release notes](https://github.com/argyle-systems/argyle-link-ios/releases) on Github for changes and information on each release. * To avoid issues and crashes, upgrade your SDK to the latest version before you compile your app. Previously installed using: > [tab] CocoaPods > > 1. Run `pod outdated` to see if a newer version of the iOS SDK is available, or refer to our [iOS SDK release notes](https://github.com/argyle-systems/argyle-link-ios/releases) on Github. > 2. If a newer version is available, update your `Podfile` to the new version. See [specifying pod versions](https://guides.cocoapods.org/using/the-podfile.html#specifying-pod-versions) for more information. > 3. Run `pod update` to install the new version. > 4. Make any necessary changes relevant to the new version, as specified in the iOS SDK release notes. > 5. Clean and rebuild your project by selecting **Product > Clean** and then **Product > Build**. > [tab] Swift Package Manager > > 1. Right-click on the `ArgyleLink` package under Package Dependencies in Xcode's Project Navigator and select Update Package. > 2. Make any necessary changes relevant to the new version, as specified in the [iOS SDK release notes](https://github.com/argyle-systems/argyle-link-ios/releases) on Github. > 3. Clean and rebuild your project by selecting **Product > Clean** and then **Product > Build**. > [tab] Manual Download > > 1. Download and replace the old SDK version with the newest version. > 2. Make any necessary changes relevant to the new version, as specified in the [iOS SDK release notes](https://github.com/argyle-systems/argyle-link-ios/releases) on Github. > 3. Clean and rebuild your project by selecting **Product > Clean** and then **Product > Build**. ## Android **Requirements** — Android 8.0 (minSdk/API level 26) and above, compileSdk 34 and above * Before upgrading, review our [Android SDK release notes](https://github.com/argyle-systems/argyle-link-android/releases) on Github for changes and information on each release. 1. Update the version number within the dependencies of your `build.gradle` [configuration file](https://developer.android.com/studio/build#top-level): ``` dependencies { implementation 'com.argyle:argyle-link-android:5.x.x' } ``` 2. [Sync your Android project](https://developer.android.com/studio/build#sync-files) to import the build configuration changes and update to the latest Android SDK version. ## React Native **React Native Requirements** — React Native version 0.73.0 or higher **iOS Requirements** — iOS 14.0+, Xcode 14.0+, Swift 5.5+ **Android Requirements** — Android 8.0 (minSdk/API level 26) and above, compileSdk 34 and above * Before upgrading, review our [React Native SDK release notes](https://github.com/argyle-systems/argyle-link-react-native/releases) on Github for changes and information on each release. Previously installed using: > [tab] NPM > > 1. Update `package.json` with the newer React Native SDK version. > 2. Run `npm install` to update the SDK with the new version. > 3. Run `cd ios` to navigate to the `ios` folder. > 4. Run `pod update` to update the SDK with the new version. > 5. Make any necessary changes relevant to the new version, as specified in the React Native SDK release notes. > [tab] Yarn > > 1. Update `package.json` with the newer React Native SDK version. > 2. Run `yarn upgrade @argyleio/argyle-plugin-react-native` to update the SDK with the new version. > 3. Run `cd ios` to navigate to the `ios` folder. > 4. Run `pod update` to update the SDK with the new version. > 5. Make any necessary changes relevant to the new version, as specified in the React Native SDK release notes. ## Flutter **iOS Requirements** — iOS 14.0+, Xcode 14.0+, Swift 5.5+ **Android Requirements** — Android 8.0 (minSdk/API level 26) and above, compileSdk 34 and above * Before upgrading, review our [Flutter SDK release notes](https://github.com/argyle-systems/argyle-link-flutter/releases) on Github for changes and information on each release. Update the version number within the dependencies of your `pubspec.yaml` file: ``` dependencies: argyle_link_flutter: ^1.x.x ``` # User Tokens Source: https://docs.argyle.com/link/user-tokens Initialize embedded Link for a specific existing user without exposing API credentials. > [!NOTE] > > User tokens are required for [embedded Link initializations](/link/initialization) that use the `userToken` parameter. > > For [payroll verification workflows](/verifications/overview) that create a session, use the returned session `link` as the `connectUrl` parameter for embedded Link, or launch it directly as [Hosted Link](/link/initialization/hosted-link). ## Benefits of user tokens * Return an existing user to embedded Link without exposing API credentials. * Send the user directly to an existing account for [reconnection](/workflows/reconnecting-accounts) or connection management. * Reuse the same Argyle user record instead of creating another user for a returning person. ![User tokens support embedded Link reconnect and returning-user flows.](https://mintcdn.com/argyle/9PhdnG31IuqV0CSB/images/link/user-tokens/1-users-tokens.png?fit=max\&auto=format\&n=9PhdnG31IuqV0CSB\&q=85\&s=4747781e10cc66e98f8e81c947eac427) ## Creating a user token To prevent your API key and secret from being exposed on the front-end, request user tokens on your server side. > [!NOTE] > > As a best practice, we recommend creating a new user token every time Link is initialized with a `userToken`. Please note the length of user tokens and their [decoded values](/link/user-tokens#decoded-tokens) are subject to change. ### New users 1. Create a new user by sending a **POST** request to the API's [`/users`](/api-reference/users) endpoint. 2. The response payload will include an `id` and `user_token`. 3. Store the `id` for creating user tokens when the same user returns. 4. Initialize Link by passing the `user_token` as the value for the `userToken` parameter. ### Returning users 1. Send a **POST** request to the API's [`/user-tokens`](/api-reference/user-tokens) endpoint and include the `id` of the user in the request body as a JSON object in the format `{"user": ""}`. 2. A `user_token` will be included in the response payload. 3. Initialize Link by passing the `user_token` as the value for the `userToken` parameter. ## Example Link initializations ```html Web theme={} ``` ```swift iOS theme={} var config = LinkConfig( userToken: "USER_TOKEN", sandbox: true // Set to false for production environment. ) ArgyleLink.start(from: viewController, config: config) ``` ```kotlin Android theme={} val config = LinkConfig( userToken = "USER_TOKEN", sandbox = true // Set to false for production environment. ) ArgyleLink.start(context, config) ``` ```js React Native theme={} import { ArgyleLink } from '@argyleio/argyle-plugin-react-native'; // ... const config = { userToken: 'USER_TOKEN', sandbox: true // Set to false for production environment. }; ArgyleLink.start(config); ``` ```dart Flutter theme={} import 'package:argyle_link_flutter/link_config.dart'; // ... final config = LinkConfig ( userToken: 'USER_TOKEN', sandbox: true // Set to false for production environment. ); ArgyleLink.start(config); ``` ## Returning to connected accounts When just a `userToken` is included in your Link initialization, a returning user that has already connected a payroll account will initially arrive at Link's home screen. From there, the user can search for and connect additional accounts, or access their already-connected accounts by selecting "Your connections." Including both the required `userToken` and optional `accountId` [Link initialization parameters](/link/initialization/overview#optional-initialization-parameters) opens the existing payroll account that matches `accountId`. This skips the **Your connections** selection step for actions such as: * [Reconnecting](/workflows/reconnecting-accounts) a disconnected account * [Revoking](/workflows/reconnecting-accounts#revoking-access) account access ![Combine userToken and accountId in your Link initialization to directly connect a user to an existing payroll account connected through Argyle.](https://mintcdn.com/argyle/9PhdnG31IuqV0CSB/images/link/user-tokens/2-users-tokens.png?fit=max\&auto=format\&n=9PhdnG31IuqV0CSB\&q=85\&s=df25fb016d5eaf8fc06e7c914c324992) ## Decoded tokens Argyle utilizes [JWT tokens](https://jwt.io/) for user tokens. > [!NOTE] > > For troubleshooting, JWT tokens can be decoded. However, we do not recommend monitoring individual token fields such as expiry date, and instead recommend creating a new user token every time Link is initialized with a `userToken` as a best practice. Decoded JWT token payload ```json theme={} { "client_id": "0d9b5bf3-97fa-4757-a136-b2a03d171414", "exp": 1652481485, "iat": 1649889485, "iss": "argyle-core-auth-prod", "jti": "00097a26-2f2a-4aa0-8eca-95ebe56d57a8", "sub": "017f8978-bbfd-ff64-18ce-d59f99bf51c2", "user_id": "017f8978-bbfd-ff64-18ce-d59f99bf51c2" } ``` # Data Delivery Source: https://docs.argyle.com/overview/data-delivery Know when payroll data is ready. Payroll data arrives and updates in stages after a user connects an account. Choose readiness events based on the records your workflow requires. > [!NOTE] > > This page applies to payroll Data API workflows. Banking and other report-based implementations should use [verification status](/verifications/verification-statuses) instead of account synchronization events to determine report readiness. ## Delivery order Initial delivery begins after the user successfully authenticates the payroll account. * Person, employment, and other information that changes less frequently is generally available first. * Paystubs, shifts, gigs, and other time-based records are delivered from the most recent records backward. ![Information that changes less frequently is delivered before historical event data.](https://mintcdn.com/argyle/9PhdnG31IuqV0CSB/images/overview/data-delivery/1-data-delivery.png?fit=max\&auto=format\&n=9PhdnG31IuqV0CSB\&q=85\&s=e9ad3274b795c1d3233d7161a0583251) Accounts with many records, such as gig accounts, can take longer to finish syncing. Delivery speed also depends on what the connected payroll system makes available. ## Resource availability Resource webhooks indicate when individual records become available: * A resource `.added` event is sent when the first available record or field is delivered. * Resource `.updated` events can continue while additional fields or records are delivered. * Partial-synchronization events indicate that a configured amount of historical data is available. Do not treat the first `.added` event as confirmation that every field or historical record is available. ## Readiness webhooks | Webhook | Meaning | | - | - | | [`accounts.added`](/api-reference/accounts-webhooks/added) | The user submitted credentials and the account was created. It does not mean data delivery is complete. | | [`accounts.connected`](/api-reference/accounts-webhooks/connected) | Account authentication completed successfully. | | [`paystubs.partially_synced`](/api-reference/paystubs-webhooks/partially-synced) | Paystubs are available through the configured history window for one account. | | [`paystubs.fully_synced`](/api-reference/paystubs-webhooks/fully-synced) | All available paystubs have been retrieved for one newly connected account. | | [`users.fully_synced`](/api-reference/users-webhooks/fully-synced) | Initial delivery completed for every newly connected payroll account attached to the user. | The `users.fully_synced` webhook is not sent when an existing account reconnects. Use account and resource webhooks for reconnection and ongoing-update workflows. ## Multiple accounts Track each account separately while initial data is arriving. One account can complete, fail, or require action before another account attached to the same user. Use the `users.fully_synced` webhook only when the workflow must wait for all newly connected payroll accounts. ## Retrieving paystubs Set `config.days_synced` when subscribing to the `paystubs.partially_synced` webhook to specify the number of days of paystub history you need. The default is 30 days, counted backward from `account.created_at`. You can create separate subscriptions for different history windows. The history window uses `paystub_date` (the payment date). When [listing paystubs](/api-reference/paystubs/list-all-paystubs), the `from_start_date` and `to_start_date` filters also use `paystub_date`, not the start or end date of the pay period. 1. Track the IDs of successfully connected payroll accounts using the `accounts.connected` webhook or the [Accounts API](/api-reference/accounts/list-all-accounts). 2. Wait for partial or full synchronization, with a timeout appropriate for your application. 3. If the `paystubs.partially_synced` webhook arrives, retrieve paystubs using the account ID and the `available_from` / `available_to` dates in the webhook. Track the account and `days_synced` value so duplicate deliveries or different subscriptions do not count as additional accounts. 4. If the `paystubs.fully_synced` webhook arrives first, retrieve the available paystubs for that account. If the `users.fully_synced` webhook arrives first, retrieve the available records for the user's newly connected payroll accounts. 5. Check whether the returned records meet your requirements. If the timeout expires before the required data is available, offer another method, such as [Document Uploads](/workflows/document-processing). When your workflow requires data from multiple accounts, track which accounts have returned the required window or completed retrieval. Do not use the number of webhook deliveries as the number of ready accounts. > [!NOTE] > > Do not wait only for the `paystubs.partially_synced` webhook. It is not sent when no paystubs are available for the requested window, including when the most recent paystub's payment date is older than that window. If all paystubs are retrieved in one pull, the `paystubs.fully_synced` webhook is sent instead. A completed sync does not guarantee a particular number of paystubs or that every requested field is populated. Retrieve identities separately when your application needs employment information even if no paystubs are available. ## Example A user connects two payroll accounts. Your application subscribes to the `accounts.connected`, `paystubs.partially_synced`, `paystubs.fully_synced`, and `users.fully_synced` webhooks. * The first account sends the `paystubs.partially_synced` webhook for the requested window. Retrieve that account's available paystubs. * The second account completes in one pull and sends the `paystubs.fully_synced` webhook without a partial-sync webhook. Retrieve its available paystubs and check that they meet your requirements. * The `users.fully_synced` webhook indicates that initial delivery has finished for both newly connected accounts. Later or duplicate events should update existing records rather than create duplicates. Continue with [Ongoing Refresh](/overview/ongoing-refresh) when your application needs new records after the initial delivery. # Data Security Source: https://docs.argyle.com/overview/data-security Protect user data and control access throughout your implementation. ## User-directed access Users direct Argyle through Link to connect selected accounts and share their data with your organization. At the user's instruction, the platform uses the credentials they provide to create the connection and deliver available information to the requested recipient. Your application can access that data through Console or the API according to its Argyle permissions. > [!NOTE] > > See our [Consumer Privacy Notice](https://www.argyle.com/legal/consumers/privacy-notice) and [Consumer Terms](https://www.argyle.com/legal/consumers/consumer-terms) for access, processing, sharing, retention, and deletion terms. ## Connections and deletion Users can remove connections through Link or Argyle Passport. They can also request help removing a connection by emailing [privacy@argyle.com](mailto:privacy@argyle.com). When a connection is removed, data from that account is no longer available to your organization through Console or the API. Argyle's systems are designed to delete the associated employment data subject to the exceptions described in the Consumer Privacy Notice. Your application should also delete data it no longer needs according to your own retention requirements and applicable agreements. ## Security measures Argyle applies physical, organizational, and technical safeguards designed to protect personal information from unauthorized access, disclosure, alteration, or destruction. * Review Argyle's current [Security Measures](https://www.argyle.com/legal/security-measures). * Visit the [Trust Center](https://trustcenter.argyle.com/) for security and compliance resources. ## Implementation best practices 1. Grant team members only the [Console permissions](/console/management/members) required for their role. 2. Create separate API keys for separate backend systems and environments. 3. Store API secrets outside client-side code and source control. See [API key security](/api-guide/overview#security). 4. Remove unused API keys and team access promptly. 5. Keep Link SDK installations current by following the [Upgrade Guide](/link/upgrade). 6. Subscribe to the [Changelog](https://changelog.argyle.com/) for API, SDK, and security-related product updates. # Accounts Source: https://docs.argyle.com/overview/data-structure/accounts Accounts are payroll connections made through Link. ## Definition An account represents a user's connection to an income source. It can contain records from more than one [employment](/overview/data-structure/employments). Users create accounts by finding an employer or payroll provider in Link and submitting the login credentials they use for that source. ![An account represents a payroll income source connected by a user.](https://mintcdn.com/argyle/lpddaw6ggr_B1oHD/images/argyle-guides/overview/accounts/accounts.png?fit=max\&auto=format\&n=lpddaw6ggr_B1oHD\&q=85\&s=f80164990575c08b917657803876362a) > [!NOTE] > > The Accounts API applies to payroll connections and related Link activity. Financial accounts used for banking verifications are separate [Bank Account](/api-reference/bank-accounts) resources. ## Standard payroll connection 1. The user searches for the employer or payroll provider that sends their income. 2. The user enters their credentials in the source-specific login screen. 3. An account record is created for the connection attempt. 4. When authentication succeeds, payroll data begins arriving in stages. See [Link Overview](/link/overview#standard-connection-process) for the complete user experience. ## Account records Account objects are created when a user: * Successfully connects an employer, payroll provider, gig platform, government source, or other supported Item. * Attempts a connection that does not complete successfully. * Uploads a document through Link. * Submits a response form after they cannot find their income source. Store each account ID independently. A user can have multiple accounts with different statuses, synchronization progress, and available data. ### Connected accounts A payroll account is connected after the user submits their credentials through Link and authentication succeeds. Data from that account is then delivered in stages. Follow [Data Delivery and Readiness](/overview/data-delivery) before deciding which account or resource event makes your workflow ready. ### Attempted connections An account can also represent an unsuccessful connection attempt. Use the account status and error information to determine whether the user can retry, needs to reconnect, or must choose another income source. * See [Account Connection Errors](/api-reference/account-connection-errors). * See [Reconnecting Accounts](/workflows/reconnecting-accounts). ## Track accounts Subscribe to account webhooks: | Webhook | Use | | - | - | | [`accounts.added`](/api-reference/accounts-webhooks/added) | A user submitted credentials and an account was created. | | [`accounts.connected`](/api-reference/accounts-webhooks/connected) | The account connection completed successfully. | | [`accounts.updated`](/api-reference/accounts-webhooks/updated) | Account fields or status changed. | | [`accounts.failed`](/api-reference/accounts-webhooks/failed) | The connection attempt failed. | | [`accounts.removed`](/api-reference/accounts-webhooks/removed) | The account was removed. | Do not treat one account's status as the status for every account attached to the user. ## View and manage accounts ### Console Open a user in [Connections](https://console.argyle.com/connections) to review their accounts, statuses, errors, and most recent synchronization information. ### API Use the [Accounts API](/api-reference/accounts) to retrieve an account, list accounts, disable ongoing updates, or delete an account. ### Delete an account > [!WARNING] > > Deleting an account permanently removes the connection and its associated resources. Use [`DELETE /v2/accounts/{id}`](/api-reference/accounts/delete-an-account) only when the connection should be removed. # Data Sets Source: https://docs.argyle.com/overview/data-structure/data-sets Payroll data and documents from connected accounts. "Data sets" are categories of payroll information made available when a user connects an employer or payroll-provider account. Your application can retrieve the structured records through the API and download source files when the connected account provides them. > [!NOTE] > > This data-set model applies to payroll accounts. Banking implementations should use [Banking Verifications](/verifications/verification-types/banking) and completed banking reports. [Bank Accounts](/api-reference/bank-accounts) and [Financial Institutions](/api-reference/financial-institutions) are supporting banking resources, not payroll data sets. ![Payroll data is organized into data sets such as paystubs and payroll documents.](https://mintcdn.com/argyle/lpddaw6ggr_B1oHD/images/argyle-guides/overview/data-sets/1-data-sets.png?fit=max\&auto=format\&n=lpddaw6ggr_B1oHD\&q=85\&s=b7681c956cb38c01dada2de9037f30c9) ## Categories | Category | Description | Example fields | | - | - | - | | [Identities](/api-reference/identities) | Person and employment identity information. | Name, birth date, employer, employment status, job title, hire date. | | [Paystubs](/api-reference/paystubs) | Earnings for a pay period. | Gross pay, deductions, taxes, net pay, hours, salary, pay frequency. | | [Payroll Documents](/api-reference/payroll-documents) | Metadata and source files from the connected payroll account. | Document type, file URL, description, W-2 and 1099 OCR fields. | | [Deposit Destinations](/api-reference/deposit-destinations) | Where and how pay is allocated. | Destination type, allocation type, currency. | | [Shifts](/api-reference/shifts) | Work shifts and task periods. | Start time, end time, breaks. | | [Gigs](/api-reference/gigs) | Gig-work events and earnings. | Tasks, income, fees, tips. | | [Vehicles](/api-reference/vehicles) | Work vehicle information. | Make, model, VIN, type, year. | | [Ratings](/api-reference/ratings) | Gig-platform ratings and achievements. | Average rating, acceptance rate, on-time rate. | Follow each category link for its complete fields and endpoint examples. ## Matching employments Use the `employment` field to match identities, paystubs, and payroll documents for the same employment. Employer names can differ between these records, and one account can contain records from more than one job. See [Employments](/overview/data-structure/employments) for matching records, filtering requests, and handling unmatched paystubs. ## Field availability Field support varies by Item and by the information present in the user's account. * In Console, select an Item in [Coverage](https://console.argyle.com/coverage) and review its field availability. * In the API, [retrieve the Item](/api-reference/items/retrieve-an-item) and inspect `field_coverage`. A supported field can still be empty when the connected account contains no value for that user. For example, an Item may support profile images even when a specific user has not added one. ## Delivery timing Resource objects arrive and update in stages. Use the corresponding resource webhooks and follow [Data Delivery and Readiness](/overview/data-delivery) before treating a data set as complete for your workflow. # Employments Source: https://docs.argyle.com/overview/data-structure/employments Match payroll records to the same employment. ## Definition An employment represents a job associated with a connected payroll account. One account can contain data from more than one employment. A [user](/overview/data-structure/users) represents the person sharing information. An [account](/overview/data-structure/accounts) represents their connection to an income source. Employments identify the jobs associated with that connection. For example, a user may have worked for two employers that use the same payroll provider. After an account is connected, paystubs may be available from both employers, even when the identity information only describes one job. ## Matching records The `employment` field is available on [Identities](/api-reference/identities), [Paystubs](/api-reference/paystubs), and [Payroll Documents](/api-reference/payroll-documents). Records with the same employment ID belong to the same employment. Employer names can differ between records for the same job. Use the employment ID to match them: | Record | Employer | `employment` | | - | - | - | | Identity | Bob's Donuts | `0183d52a-d3b2-331d-c753-3662a20e352b` | | Paystub | Bob's Donuts Associates, LLC | `0183d52a-d3b2-331d-c753-3662a20e352b` | | Paystub | Suzy's Cupcakes | `null` | In this example, the identity's employment status applies to Bob's Donuts. It should not be applied to the unmatched Suzy's Cupcakes paystub. > [!NOTE] > > Paystubs and payroll documents can have a `null` employment when they cannot be matched to an employment. These records can still contain useful information. A shared `null` value does not mean that records belong to the same employment. Employment IDs are also used when an account contains only one employment. They are not supported as filters for other data sets, such as Gigs or Shifts. ## Retrieve all records, then match Use this approach when you need all available records, including paystubs that are not matched to an employment. 1. Retrieve identities, paystubs, and payroll documents using the `user` or `account` filter. Follow pagination to retrieve all available records. 2. Store the `employment` value with each record. 3. Match records with the same non-null employment ID. Keep unmatched records available for separate review or processing. You do not need to call the Employments endpoint for this approach. ## Retrieve records for an employment Use this approach when you only need records associated with a specific employment. 1. [List employments](/api-reference/employments/list-all-employments) for the user or account. 2. Use the returned employment `id` as the `employment` filter when listing identities, paystubs, or payroll documents. ```text theme={} GET /v2/employments?account=0187c66e-e7e5-811c-b006-2232f00f426a GET /v2/identities?employment=0183d52a-d3b2-331d-c753-3662a20e352b GET /v2/paystubs?employment=0183d52a-d3b2-331d-c753-3662a20e352b GET /v2/payroll-documents?employment=0183d52a-d3b2-331d-c753-3662a20e352b ``` > [!NOTE] > > Filtering by employment excludes unmatched records. If your application needs the applicant's full available income history, retrieve all records and match them afterward. Both approaches use the same [data delivery webhooks](/overview/data-delivery). An account connection alone does not mean its identities, paystubs, or payroll documents are ready. See the [Employments API Reference](/api-reference/employments) for the complete object and its fields. ## Testing A payroll account may contain paystubs from multiple jobs. Use the custom test user below to test this mixed-employment scenario in Sandbox and retrieve the paystubs for the job associated with the connected account. 1. Open a Flow in Console with Sandbox mode enabled, or initialize embedded Link with `sandbox: true`. See [Sandbox Testing](/overview/sandbox-testing#connect-sample-users). 2. In Link, select an Item that supports mixed employments testing, such as **ADP**. 3. Enter username `test_1` and the password below. If prompted for a verification code, enter `8081`. ```text Password theme={} eyJzdGF0aWNfZGF0YV9zZXRfaWQiOiAiNGY4NjY3YjEtMGYyNS00Mzg2LTkzYTUtYWIyOGY3MTM5OGE1IiwgImluaXRpYWxfc2Nhbl9kZWxheV9pbl9zZWNvbmRzIjogMCwgInNraXBfZnVsbHlfc3luY2VkIjogZmFsc2V9 ``` After [data delivery](/overview/data-delivery) completes, use your Sandbox API credentials to: 1. Retrieve the account's [identity information](/api-reference/identities) to identify the job and read its `employment` ID. 2. Use that ID as the `employment` filter when [listing paystubs](/api-reference/paystubs/list-all-paystubs). The returned paystubs will have the same employment ID as the identity. ```text theme={} GET https://api-sandbox.argyle.com/v2/identities?account=ACCOUNT_ID GET https://api-sandbox.argyle.com/v2/paystubs?employment=EMPLOYMENT_ID ``` Paystubs from other jobs will have `employment: null` and are excluded by this filter. To retrieve all of the account's paystubs, including those from other jobs, query by account instead: ```text theme={} GET https://api-sandbox.argyle.com/v2/paystubs?account=ACCOUNT_ID ``` Follow pagination and confirm that your application: * Matches paystubs with the same non-null employment ID as the identity. * Retains paystubs with `employment: null` without applying the identity's employment status to them. * Excludes unmatched paystubs only when you intentionally use the `employment` filter. # Items Source: https://docs.argyle.com/overview/data-structure/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. ![What Items are in Argyle terminology.](https://mintcdn.com/argyle/lpddaw6ggr_B1oHD/images/argyle-guides/overview/items/items.png?fit=max\&auto=format\&n=lpddaw6ggr_B1oHD\&q=85\&s=4ced88fb714750b86bea130fec24d99a) A full list of supported Items can be viewed in the [Coverage](https://console.argyle.com/coverage) section of Console. You can also subscribe to our [Changelog](https://changelog.argyle.com/) 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. | Type | Description | | - | - | | Employers | Individual employers that have an in-house payroll system or internal log-in process to a third party system. | | Gig platforms | Gig economy platforms, which typically have an in-house payment system. | | Payroll providers | Payroll providers are third party systems that provide payroll services to multiple employers. | | Government benefits | Government platforms, typically related to social security or veteran income. | ### Note: there are two types of payroll providers shown in Link: > [accordion] Note: there are two types of payroll providers shown in Link: > > 1. Payroll providers that the user connects to directly by entering login credentials specific to the payroll provider. > 2. Payroll providers that act as a **Grouping**. When this type of payroll provider is selected, the user is shown a list of employers that use this payroll provider. The user chooses the appropriate employer and proceeds to a login screen that is specific to the employer—payroll-provider combination. ## 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](/overview/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](https://console.argyle.com/coverage) section of Console and checking the **status** column, or [retrieve the Item](/api-reference/items#retrieve) via the API and check the [`status`](/api-reference/items#object-status) property. Subscribing to the [`items.updated`](/api-reference/items-webhooks/updated) webhook [via Console](/console/management/webhooks#subscribing-to-webhooks) or [via the API](/api-guide/webhooks#subscribing-to-webhooks) will also notify you when an Item's health status changes. ### 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](https://console.argyle.com/coverage) section of Console, and expand the relevant data category within the **Field availability** area. * API — [retrieve the Item](/api-reference/items#retrieve) and check the [`field_coverage`](/api-reference/items#object-features-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](/api-reference/identities#object) data set. 1. [Retrieve the Item](/api-reference/items#retrieve) via the API using its ID. 2. Search the response, in this case by `job_title`, and check if the desired field is `supported`. ```json theme={} "field_coverage": { "identities": { "job_title": { "supported": true } } } ``` ### 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`](/api-reference/items#object-features-data_retrieval-refresh_frequency) field when [retrieving an Item](/api-reference/items#retrieve) by its ID via the API. See our [Ongoing Refresh Guide](/overview/ongoing-refresh) 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. > [!NOTE] > > 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](https://console.argyle.com/coverage) section of Console, or via the API using the [Items endpoint](/api-reference/items#object-mapping_status). You can choose which Items to show in Link search based on their mapping status when customizing a Flow [in Console](https://console.argyle.com/flows) 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](https://console.argyle.com/coverage) section of Console. A **known limitations** area will be present only when the Item has data limitations. * API — [retrieve the Item](/api-reference/items#retrieve) and check the [`known_limitations`](/api-reference/items#object-known_limitations) property. ## Creating Item filters Using the API's [`/item-filters`](/api-reference/item-filters#create) endpoint, you can create custom filters to search for Items that support specific requirements: 1. Create an [Item filter](/api-reference/item-filters). 2. Add `supported` filters for your desired fields. 3. When [listing Items](/api-reference/items#list), use the Item filter ID as a query parameter. # Reports Source: https://docs.argyle.com/overview/data-structure/reports Verification results available as PDF and JSON. Reports package the income, employment, or asset information users share through a report-based verification workflow. > [!NOTE] > > Use [Verifications](/verifications/overview) for new report implementations. If your application needs individual payroll records or its own income calculations, see [Verifications vs. Data APIs](/overview/verifications-vs-data-apis). ![Payroll data can be packaged into income and employment verification reports.](https://mintcdn.com/argyle/lpddaw6ggr_B1oHD/images/argyle-guides/overview/reports/3-reports.png?fit=max\&auto=format\&n=lpddaw6ggr_B1oHD\&q=85\&s=d8e3b4b0194a7e6cc9dab4419ecd4485) The diagram above illustrates payroll reports. Verifications also supports banking, Doc VOI, and government report types. ## Report types | Data source | Report types | | - | - | | Payroll | `voie` — income and employment `voe` — employment | | Banking | `voa` — assets `voi` — income `voai` — assets and income `voe-transactions` — employment based on transaction data | | Documents | `doc-voi-mortgage` — mortgage income from uploaded documents | | Government | `voie-government` — government income | Review [Reports and Source Documents](/verifications/reports-and-source-documents) for example PDFs and JSON. ## Generate reports through Verifications The [Verifications API](/verifications/overview) supports all current report types and is recommended for new report-based implementations. 1. Create or reuse a user. 2. Order a verification with the required `report.type`. 3. Complete the required account-connection or document steps. 4. Listen for the `verifications.updated` webhook. 5. Retrieve the report when the verification reaches `completed` or `completed_with_errors`. See the [Verifications Quickstart](/verifications/quickstart). ## Generate payroll reports in Console Console-only implementations can generate supported payroll reports without using the API: 1. Open the user in the [Connections](https://console.argyle.com/connections) section after their payroll data is available. 2. Select **Generate report** in the Reports area. ![Generate a payroll report from a user's page in Console.](https://mintcdn.com/argyle/lpddaw6ggr_B1oHD/images/argyle-guides/overview/reports/1-reports.png?fit=max\&auto=format\&n=lpddaw6ggr_B1oHD\&q=85\&s=746555e65f9f4099fdf594154c709b75) 3. Select the payroll report type and generate the report. ![Select a payroll report type in Console.](https://mintcdn.com/argyle/lpddaw6ggr_B1oHD/images/argyle-guides/overview/reports/2-reports.png?fit=max\&auto=format\&n=lpddaw6ggr_B1oHD\&q=85\&s=d34aa1c9917451462bb1600912714f82) Banking and Doc VOI reports cannot currently be generated in Console. Use the Verifications API or a supported integration to order them. Completed reports can be viewed and downloaded in Console when available. ## Classic Reports API The classic [`/v2/reports/{type}`](/api-reference/reports) workflow supports only a subset of payroll report types and remains available for existing integrations. Use the [`reports.ready`](/api-reference/reports-webhooks/ready) webhook to determine when sufficient payroll data is available before generating a classic report. Use the [`reports.generated`](/api-reference/reports-webhooks/generated) webhook to track asynchronous report generation. > [!NOTE] > > The classic Reports API remains available for existing payroll integrations. For new report-based implementations, start with Verifications. ## Retrieve report files Verification resources provide `report.file_url` and `report.json_url` when the report is ready. Classic report objects provide the corresponding report URLs for their supported types. Requests to report file URLs require [Argyle authentication headers](/api-guide/overview#authentication). ## GSE validation Payroll and Doc VOI reports can support Day 1 Certainty® and AIM workflows when the required product and configuration are enabled. See [Day 1 Certainty® and AIM](/integrations/d1c-aim/verifications). # Users Source: https://docs.argyle.com/overview/data-structure/users One person across every Argyle workflow. ## Definition A user is Argyle's record for the person sharing accounts, data, or documents with your organization. Keep the same user ID across payroll, banking, document, and verification workflows. ![A user can connect multiple payroll accounts, share payroll data sets, and receive verification reports.](https://mintcdn.com/argyle/lpddaw6ggr_B1oHD/images/argyle-guides/overview/users/users.png?fit=max\&auto=format\&n=lpddaw6ggr_B1oHD\&q=85\&s=0bd624920a137c63dddfdd3b9c5f88b3) > [!NOTE] > > The diagram above illustrates the payroll data structure. Banking verifications use the same user, but financial-account connections are not represented by the Accounts API or payroll data sets. The same user can: * Complete one or more verification orders. * Connect multiple payroll accounts through Link. * Connect a financial account for a banking verification. * Have documents uploaded through the API or upload them through Link. * Return later to reconnect an account or complete a new verification. Store the Argyle user `id` with your internal person or application record. ## Create a user Use [`POST /v2/users`](/api-reference/users/create-a-user) to create a user from your backend. The required person details depend on the workflow. For example, banking and Doc VOI require additional identity fields that a payroll verification may not require. Follow the relevant [Verifications](/verifications/overview) or [Data APIs](/data-apis/overview) guide before choosing the request fields. ## Returning users Reuse the existing user ID when the same person returns. * For a new verification, create another verification for the existing user. * For an active verification with an expired session link, create another session for the existing verification. * For a direct-data workflow, create a new user token before launching Link again. * For an account that requires reauthentication, follow [Reconnecting Accounts](/workflows/reconnecting-accounts). > [!NOTE] > > Creating another user for the same person separates their accounts, documents, and verifications across multiple user records. ## External identifiers Use `external_id` to associate the Argyle user with your own identifier, such as an application or member ID. ```json theme={} { "first_name": "Jane", "last_name": "Doe", "external_id": "application-319" } ``` External IDs are metadata for your mapping. They do not replace the Argyle user ID and should not be used as the only deduplication mechanism. ![An external ID associates an Argyle user with an identifier from your system.](https://mintcdn.com/argyle/lpddaw6ggr_B1oHD/images/argyle-guides/overview/users/2-users.png?fit=max\&auto=format\&n=lpddaw6ggr_B1oHD\&q=85\&s=b54562bf37927b04af1ded32491e95b2) ## View and manage users ### Console Use the [Connections](https://console.argyle.com/connections) area to search for users, review associated accounts and data, and manage available actions. ### API Use the [Users API](/api-reference/users) to create, retrieve, update, list, or delete users. ### Delete a user > [!WARNING] > > Deleting a user is permanent and removes the resources associated with that user. Confirm your retention and deletion requirements before calling [`DELETE /v2/users/{id}`](/api-reference/users/delete-a-user). # How Argyle Works Source: https://docs.argyle.com/overview/how-argyle-works Argyle helps consumers share income and employment data straight from the source. Consumers direct Argyle to share income and employment information from their payroll accounts, financial accounts, or documents. Your organization can request a completed verification report or retrieve payroll records directly. ## Choose how to build > [card] [Verifications](/verifications/overview) > > Request income, employment, or asset information through one workflow and receive a completed report. > [card] [Data APIs](/data-apis/overview) > > Let users connect payroll accounts, then retrieve the payroll records your application needs. See [Verifications vs. Data APIs](/overview/verifications-vs-data-apis) to compare outputs and choose the path your application needs. ## How information is shared * **Payroll:** Users connect their employer or payroll-provider accounts through [Link](/link/overview). * **Banking:** Users connect financial accounts during the verification process. * **Documents:** Documents can be uploaded directly through the API or collected from users in Link. A [user](/overview/data-structure/users) represents the person sharing information across these paths. [Console](/console/overview) is where you configure, test, and manage Argyle. The [API Reference](/api-reference/overview) contains endpoint definitions, schemas, webhooks, and errors. ## Verifications Use Verifications when you want one order lifecycle and a completed report for payroll, banking, or Doc VOI. A typical implementation creates a user, orders a verification, starts an embedded or invite session when user action is required, listens for lifecycle updates, and retrieves the completed report. ![Payroll data is made available through Argyle Console, the Argyle API, or Argyle PDF reports.](https://mintcdn.com/argyle/zs6lb-w1jQV9DVbr/images/overview/how-argyle-works/1-how-argyle-works.png?fit=max\&auto=format\&n=zs6lb-w1jQV9DVbr\&q=85\&s=61e72702d5a33d4337d84e9ac3b21a0d) [Start with Verifications](/verifications/overview). ## Payroll Data APIs Use the Data APIs when your application needs the underlying payroll records for a custom or existing workflow. Banking implementations use Verifications instead. Users connect their payroll accounts through Link. Your application tracks account and synchronization events, then retrieves the required identities, paystubs, payroll documents, gigs, shifts, vehicles, ratings, and other available resources. ![Link is where users connect their accounts through Argyle.](https://mintcdn.com/argyle/zs6lb-w1jQV9DVbr/images/overview/how-argyle-works/2-how-argyle-works.png?fit=max\&auto=format\&n=zs6lb-w1jQV9DVbr\&q=85\&s=c9423cb37168de456ad6b65dce23efa6) [Explore the Data APIs](/data-apis/overview). ## Verticals Verticals bring together the products, data, and workflows required for a specific industry or program. A vertical can use Verifications, Data APIs, or both. [Explore Verticals](/verticals). ## Document uploads Documents can be uploaded directly through the API or collected from users in Link. Supported documents include W-2s, 1099s, paystubs, proof of identity, proof of address, and other files. Doc VOI is a mortgage verification that uses uploaded paystubs and year-end income documents to produce an income report when a direct payroll connection is not used. Other document uploads can support standalone OCR, authenticity, or document-processing workflows. ![Link supports directly uploading documents such as paystubs, W-2s, and 1099s as well as proof of identity, proof of address, and a miscellaneous category of documents.](https://mintcdn.com/argyle/zs6lb-w1jQV9DVbr/images/overview/how-argyle-works/5-how-argyle-works.png?fit=max\&auto=format\&n=zs6lb-w1jQV9DVbr\&q=85\&s=0adeffff94b9f94a99c58aa50540413b) * For Doc VOI, visit the [Doc VOI guide](/verifications/verification-types/document-voi). * For standalone uploads, OCR, and authenticity, visit [Document Uploads](/workflows/document-processing). ## Start in Console After you are provided with a Console account you can test in Sandbox, preview Link, create API keys, configure webhooks, and invite team members. When you are ready to build, continue with the [Verifications](/verifications/overview) or [Data APIs](/data-apis/overview) path. # Ongoing Refresh Source: https://docs.argyle.com/overview/ongoing-refresh Receive new payroll data from active connections. After the initial delivery, an active payroll connection can continue providing new records, such as paystubs and payroll documents, at the user's direction. > [!NOTE] > > This page applies to payroll Data API workflows. For an updated banking report, use [Re-verification](/verifications/re-verification). ## Connection state Ongoing refresh continues for as long as the connected payroll system allows the connection to remain active. Some payroll systems require the user to reauthenticate periodically. Existing data remains available after a disconnection, but new records stop arriving until the user completes the required [reconnection](/workflows/reconnecting-accounts). ## Item support Support and known constraints can vary by Item. * In Console, select the Item in [Coverage](https://console.argyle.com/coverage). * In the API, [retrieve the Item](/api-reference/items/retrieve-an-item) and inspect `known_limitations`. ![Check ongoing refresh support in Console or the Items API.](https://mintcdn.com/argyle/zs6lb-w1jQV9DVbr/images/overview/ongoing-refresh/1-refresh.png?fit=max\&auto=format\&n=zs6lb-w1jQV9DVbr\&q=85\&s=98396ad5770be43b8637ad239a63d56e) ## Refresh frequency The refresh schedule depends on the Item and how its payroll system publishes new information. Use the Item's `features.data_retrieval.refresh_frequency` value for the current documented interval instead of assuming one schedule for every connected account. ## Monitor new data Subscribe to the resource events your application uses: * `.added` for newly available records. * `.updated` when an existing record changes. * `.removed` when the resource supports removal events. Subscribe to the [`accounts.updated`](/api-reference/accounts-webhooks/updated) webhook to track account-status and synchronization changes. If the account enters an error state, inspect the current error code and follow [Reconnecting Accounts](/workflows/reconnecting-accounts). ## Simulate a refresh Sandbox can simulate new data appearing after the initial connection. See [Simulate a data refresh](/overview/sandbox-testing#simulate-a-data-refresh). # Sandbox Testing Source: https://docs.argyle.com/overview/sandbox-testing Explore the Sandbox environment. This page covers the shared Sandbox tools for payroll connections and Data API workflows: sample users, custom test users, data retrieval, simulated updates, and connection errors. For report-based payroll, banking, and Doc VOI scenarios, continue to [Verification Testing](/verifications/testing). ## Connect sample users To begin testing with sample data, connect sample users using the login credentials below through either: * [Flows](https://console.argyle.com/flows) in Console (*make sure Console's Sandbox mode toggle is enabled*) after selecting a demo or custom [Flow](/console/flows/embedded-experiences). * Embedded Link, with the `sandbox` parameter set to `true` in your [Link initialization](/link/initialization). | | Bob | Sarah | Joe\* | | - | - | - | - | | Email | test1\@argyle.com | test2\@argyle.com | test3\@argyle.com | | Username | test\_1 | test\_2 | test\_3 | | Password | passgood | passgood | passgood | | Verification code | 8081 | 8082 | 8083 | | Phone number | (800) 900-0010 | (800) 900-0020 | (800) 900-0030 | | Driver's license # | D1230010 | D1230020 | D1230030 | \* *Joe returns multiple [employments](/api-reference/employments) when connected to specific Items.* > [!NOTE] > > Sample users are deleted after 60 days. ## Create custom users Create custom Sandbox test users in Console by describing the income or employment scenario you want to test. 1. Enable **Sandbox mode** in Console and open [Flows](https://console.argyle.com/flows). 2. Open the preview for a demo or custom [embedded experience](/console/flows/embedded-experiences). 3. Under **Create custom user**, describe your scenario in plain language, or select an example to get started. For example: "One employee earning \$120,000 a year, paid monthly since January 2025." 4. Select **Create**. When the user is ready, use the displayed username and test password to connect in Sandbox, following the guidance on which employer or payroll provider to select. Custom users are saved to your organization. Select a user from **Saved custom users** to reuse its credentials and scenario during testing, including with teammates. ![Create a custom Sandbox user, copy its test credentials, and select a saved user in Console.](https://mintcdn.com/argyle/CUh-KyZ2-XHHjW97/images/overview/sandbox-testing/custom-sandbox-users.svg?fit=max\&auto=format\&n=CUh-KyZ2-XHHjW97\&q=85\&s=b958de74384095583b095eeee4c70475) > [!NOTE] > > Each organization can create up to 50 custom test users per month. If a request isn't supported, follow the guidance in the message to adjust your description and try again. ## Retrieve sample data #### Console With the Sandbox mode toggle in Console enabled, navigate to the [Connections](https://console.argyle.com/connections) section of Console and select an individual sample user to view sample data. #### API Authorize requests using your Sandbox API key and secret, which can be found or created in the [Developers](https://console.argyle.com/api-keys) section of Console, and make requests using the Sandbox environment's `https://api-sandbox.argyle.com/v2` base URL. ## Simulate a data refresh To simulate new data being added after an account's data is refreshed: 1. Send a POST request with an empty body to `https://api-sandbox.argyle.com/v2/accounts/{acc-id}/periodic-scan` 2. Replace the `{acc-id}` path variable with the [account ID](/api-reference/accounts) of an already-connected sample user. If successful, the request returns an empty object and 1-5 new paystubs and gig events are added to the sample account. > [!NOTE] > > Simulated data refreshes are often used for webhook testing. ## Update sample data The same endpoint used for simulating data refreshes in Sandbox can also be used to update a user's [identity information](/api-reference/identities): 1. Send a POST request to `https://api-sandbox.argyle.com/v2/accounts/{acc-id}/periodic-scan` 2. Replace the `{acc-id}` path variable with the [account ID](/api-reference/accounts) of an already-connected sample user. 3. In the request body, include a JSON object with the updated identity values you want to be overwritten in the format shown in the example below: * Most identities fields can be overwritten with the exception of `id`, `account`, `picture_url`, `employer`, `created_at`, `updated_at`, and `metadata`. * Only possible values for **(enum)** identity fields are accepted. ```json theme={} { "data": { "identities": { "address": { "city": "Sydney", "line1": "P Sherman", "line2": "42", "state": "Wallaby Way", "country": "Australia", "postal_code": "0872" }, "first_name": "Finding", "last_name": "Nemo", "full_name": "Finding Nemo", "birth_date": "2003-05-30", "email": "dory@email.com", "phone_number": "+12127777777", "employment_status": "terminated", "employment_type": "part-time", "job_title": "Explorer", "ssn": "553-983-2311", "marital_status": "Single", "gender": "Female", "original_hire_date": "2020-01-03", "hire_date": "2021-04-13", "termination_date": "2023-09-22", "termination_reason": "Forgetfulness", "base_pay": { "amount": "92050", "period": "annual", "currency": "USD" }, "pay_cycle": "monthly", "platform_ids": { "employee_id": "OB238HDW5", "position_id": "6ELL4O7PM", "platform_user_id": "JLH7B9V6O6YGN9O7" } } } } ``` > [!NOTE] > > Updating identities information is often used to test or explore how your system reacts to identity-related events such as a user's [`employment_status`](/api-reference/identities#object-employment_status) updating from `active` to `terminated`. When a user's identities data changes, the `identities.updated` [webhook](/api-reference/identities-webhooks/updated) is sent. ## Simulate errors in Console 1. Navigate to [Flows](https://console.argyle.com/flows) when Console is in Sandbox mode. 2. Select a demo Flow, and the option to "Simulate an error" will appear next to the sample user's test email. 3. Choose an error, and "Click to copy" the special test password. Use this password when connecting a payroll account for the sample user to simulate the error. ## Simulate errors via the API 1. Send a POST request to `https://api-sandbox.argyle.com/v2/test-password/encode`, and include a JSON object in the request body specific to the error type: > [tab] Account connection errors > > * [Account connection errors](/api-reference/account-connection-errors) occur immediately after submitting sample user login credentials. > * The `invalid_mfa` error can be tested by entering an incorrect code, and `mfa_timeout` will occur after ten minutes. > * For the `auth_required` error, switch to the **Disconnection errors** tab. > > ```json theme={} > { > "failure": { > "fail_on": "connection", > "error": "" // Any account connection error. > } > } > ``` > [tab] Disconnection errors > > * You must [simulate a data refresh](/overview/sandbox-testing#simulate-a-data-refresh) after you have connected a sample user with the `test_password` sent in the response in order to trigger the disconnection error. > > ```json theme={} > { > "failure": { > "fail_on": "rescan", > "error": "auth_required" // Only value accepted. > } > } > ``` 2. Once the POST request is sent, you will receive a `test_password` in the response: ```json theme={} // *Example value { "test_password": "eyJmYWlsdXJlIjogeyJmYWlsX29uIjogImNvbm5lY3Rpb24iLCAiZXJyb3IiOiAiYWNjb3VudF9kaXNhYmxlZCJ9fQ==" } ``` 3. Use this `test_password` as the password login credential when connecting a sample user to trigger the error. ![Use the test password when connecting a sample user to trigger the error.](https://mintcdn.com/argyle/zs6lb-w1jQV9DVbr/images/overview/sandbox-testing/1-sandbox-testing.png?fit=max\&auto=format\&n=zs6lb-w1jQV9DVbr\&q=85\&s=7a9d7ed9fbb693929fca2fe4c0ea08a4) ## Sandbox limitations Billing features such as receipts, invoices, and billing CSVs are not supported in Sandbox and can only be generated in Production. # Verifications vs. Data APIs Source: https://docs.argyle.com/overview/verifications-vs-data-apis Choose a report workflow or retrieve the individual records your application needs. Applicants share payroll data, banking information, or documents through Argyle. * Choose **Verifications** when your application needs a completed report. * Choose **Data APIs** when it needs individual payroll records, uploaded files, or OCR and authenticity results for its own workflow. ## Payroll reports and paystub records Payroll VOIE reports summarize annual and year-to-date income. Use the **[Paystubs API](/api-reference/paystubs)** to calculate income for the period your workflow requires. For detailed payroll records and source files, use these **Data APIs**: * **[Paystubs](/api-reference/paystubs):** Individual payments, including pay dates, pay-period dates, and gross and net pay. * **[Identities](/api-reference/identities):** Employer and employment details associated with the connected account. * **[Payroll Documents](/api-reference/payroll-documents):** Original paystubs, tax forms, and other source files, when available. Field availability and history depend on the connected payroll account. ## Choose your path | What you need | Use | | - | - | | Payroll income or employment reports | Verifications — [Payroll](/verifications/verification-types/payroll) | | Banking income, asset, or transaction reports | Verifications — [Banking](/verifications/verification-types/banking) | | Mortgage income reports from uploaded documents | Verifications — [Doc VOI](/verifications/verification-types/document-voi) | | Individual payroll records for your own workflow or income calculations | [Data APIs](/data-apis/overview) | | Original paystubs, tax forms, and other files from connected payroll accounts | Data APIs — [Payroll Documents](/api-reference/payroll-documents) | | Uploaded files and their OCR or authenticity results | Data APIs — [User Uploads](/api-reference/user-uploads) | ## Compare the workflows | | Verifications | Data APIs | | - | - | - | | **Result** | A report PDF and, when supported, report JSON. | Individual records and document metadata, with links to available source files. | | **Workflow** | Order a verification, complete the required account-connection or document steps, and retrieve the report. | Let applicants connect payroll accounts or share documents, then retrieve the resources your application needs. | | **Readiness** | Track `verifications.updated` and the verification status. | Track payroll synchronization or document-processing webhooks for the resources you need. | | **Implementation guide** | [Verifications Quickstart](/verifications/quickstart) | [Data APIs](/data-apis/overview) | ## Tenant screening For tenant screening, we recommend: * **Payroll:** Use Data APIs to retrieve individual payroll records and calculate income for your screening process. * **Banking:** Use Verifications for income or asset reports. * **Uploaded documents:** Use [User Uploads](/api-reference/user-uploads) to retrieve files and OCR or authenticity results when enabled. See the [Tenant Screening guide](/verticals/tenant-screening) for implementation steps. # Build with Argyle Source: https://docs.argyle.com/partners Implement payroll, banking, and Doc VOI through the Partner API. Use the Partner API when your platform runs verifications for your customers. Each customer needs a `client` ID in Argyle so their users and verifications are associated with the correct organization. > [card] [Partner guides](/verifications/platform-partners) > > Set up your integration, create users, and follow the verification lifecycle. > [card] [API Reference](/partners/api-reference) > > Find partner endpoints, request examples, webhooks, data sets, and receipts. ## Get started 1. Obtain your partner API credentials and the customer's `client` ID from Argyle. 2. Follow the [Partner Quickstart](/partners/quickstart) to create a user and order a verification in Sandbox. 3. Use the [test profiles](/partners/testing) to check payroll, banking, and document workflows. If your organization is implementing Argyle for its own workflow, turn off **Partner mode**. # Partner API Reference Source: https://docs.argyle.com/partners/api-reference Find partner endpoints, examples, and webhooks. Use `/partners/v2` when your platform runs verifications for your customers. Each customer needs a `client` ID in Argyle. Start with the [Partner Quickstart](/partners/quickstart) for implementation steps. > [card] [Users](/api-reference/partners-verifications/create-a-user) > > Create users with the customer's client ID and update their details. > [card] [Verifications](/api-reference/partners-verifications/order-a-verification) > > Order, retrieve, refresh, update, or cancel verifications and create sessions. > [card] [Document uploads](/api-reference/partners-verifications/upload-a-document) > > Upload files for a customer's document verification. > [card] [Webhooks](/api-reference/partners-webhooks/updated) > > Track verification changes and manage partner webhook subscriptions. > [card] [Data Sets](/api-reference/partners-data-sets/list-all-accounts) > > Retrieve payroll accounts, bank accounts, paystubs, and payroll documents associated with supported verifications. > [card] [Receipts](/api-reference/partners-receipts) > > Retrieve receipts when enabled for your integration. # Verifications Source: https://docs.argyle.com/partners/overview Order payroll, banking, and Doc VOI reports through one lifecycle. A verification is an order for a report. You select the report type, then users connect their payroll or financial accounts, or documents are uploaded directly through the API or collected in Link. The result is a PDF and, when supported, JSON. ## Verification types > [card] [Payroll](/partners/verification-types/payroll) > > Generate income and employment reports from connected payroll accounts. > [card] [Banking](/partners/verification-types/banking) > > Generate asset, income, and transaction reports from connected financial accounts. > [card] [Doc VOI](/partners/verification-types/document-voi) > > Generate mortgage income reports from uploaded payroll documents. ## Workflow **1. Create or reuse a user** Reuse the person's existing user ID across payroll, banking, and document workflows, or create a user if needed. Update any missing details required by the next product before ordering its verification. **2. Order a verification** Select the report type and provide any type-specific configuration. **3. Start a session** Launch an embedded session or send an invite when the verification requires user action. **4. Track lifecycle updates** Subscribe to the `verifications.updated` webhook and use the verification status to determine the next action. **5. Retrieve the result** Download the completed report PDF or JSON from the URLs in the verification resource. [Follow the Quickstart](/partners/quickstart). ## Continue implementing > [card] [Verification Statuses](/partners/verification-statuses) > > Track status changes and retrieve completed results. > [card] [Reports and Source Documents](/partners/reports-and-source-documents) > > View report examples and retrieve available paystubs, tax forms, or uploaded files. > [card] [Re-verification](/partners/re-verification) > > Refresh connected data or submit updated Doc VOI files. > [card] [Recovery and Errors](/partners/recovery-and-errors) > > Resume incomplete sessions and correct invalid user details. > [card] [Testing](/partners/testing) > > Use payroll, banking, and Doc VOI test profiles. # Partner Quickstart Source: https://docs.argyle.com/partners/quickstart Build your first verification workflow. A verification follows five steps: 1. Create or reuse a user. 2. Order a verification. 3. Start a session when the user needs to connect an account. 4. Listen for verification status changes. 5. Retrieve the completed report. This Quickstart uses a payroll `voie` verification as the example. The same lifecycle applies to the other [verification types](/partners/overview#verification-types). ## Before you begin * Use the Sandbox API credentials for your partner integration. * Use the Sandbox base URL: `https://api-sandbox.argyle.com/partners/v2`. * Send API requests from your backend using [HTTP basic authentication](/verifications/platform-partners#authentication). * Set up [partner webhook handling](/verifications/platform-partners#webhooks), then subscribe to the [`verifications.updated`](/api-reference/partners-webhooks/updated) webhook before testing the complete workflow. ## Create or reuse a user Your Argyle Customer Success Manager will provide a `client` ID for each customer. Include it when creating the user so their records are associated with the correct customer. The `client` identifies the organization, not the person sharing information. If the person already has an Argyle user for the same customer, reuse that user ID across payroll, banking, and document workflows. Otherwise, [create a user](/api-reference/partners-verifications/create-a-user) and store the returned ID with your internal record. Before adding another product, [update the existing user](/api-reference/partners-verifications/update-a-user) with any missing details required by that product. Use the same user ID when ordering the verification. Required user details depend on the verification type: | Field | Payroll | Banking | Doc VOI | | - | - | - | - | | `first_name` | Required | Required | Required | | `last_name` | Required | Required | Required | | `ssn` | Not required | Required if `birth_date` is not provided | Required | | `birth_date` | Not required | Required if `ssn` is not provided | Not required | | `address` | Not required | Required | Not required | | `email` | Not required | Required if `phone_number` is not provided | Not required | | `phone_number` | Not required | Required if `email` is not provided | Not required | ```json theme={} { "client": "39096494-45c8-4fd8-9454-3d1cb2d62db7", "first_name": "Jane", "last_name": "Doe", "ssn": "000-00-0000", "email": "jane@example.com", "phone_number": "+15555555555", "address": { "city": "New York", "line1": "123 Main St", "line2": null, "state": "NY", "country": "US", "postal_code": "10001" }, "birth_date": { "year": 1990, "month": 1, "day": 13 } } ``` Store the returned user `id`. The user ID is required when ordering the verification. ## Order a verification Use [`POST /partners/v2/verifications`](/api-reference/partners-verifications/order-a-verification). Set `report.type` to the required report type. ```jsonc theme={} { "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69", "configuration": { "notified_recipients": [ "john.doe@mortgage.com" ] }, "report": { "type": "voie" }, "loan": { // Optional "number": "1234", "borrower_id": "ABC789", "application_id": "2121313", "officer_email": "john.doe@mortgage.com" }, "billing": { // Optional "cost_center": "5" } } ``` Store the returned verification `id`. Use the type-specific guides for additional request fields and examples: * [Payroll](/partners/verification-types/payroll) * [Banking](/partners/verification-types/banking) * [Doc VOI](/partners/verification-types/document-voi) ## Create a session Payroll and banking verifications require a session when the user needs to connect an account. Doc VOI uses [document uploads](/partners/verification-types/document-voi#upload-documents) instead. The verification must be active. An active verification is not completed or cancelled. ### Embedded session Use [`POST /partners/v2/sessions`](/api-reference/partners-verifications/create-a-session) with the verification ID. Session links expire after one hour. Create another session for the same active verification when a new link is required. The session request depends on whether the user is connecting a payroll or financial account. > [accordion] Payroll request: POST /partners/v2/sessions > > ```json theme={} > { > "verification": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b", > "configuration": { > "redirect_url": "https://your-application.com/return", > "flow_id": "12ABCD3E", > "language": "EN", > "mobile_app": true > } > } > ``` > [accordion] Banking request: POST /partners/v2/sessions > > ```json theme={} > { > "verification": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b", > "configuration": { > "experience": "97f1eccb-241d-4052-8409-fab2dcc489b", > "single_use_url": false, > "redirect_url": "https://your-application.com/return" > } > } > ``` > [accordion] Payroll response > > ```json theme={} > { > "verification": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b", > "configuration": { > "experience": null, > "single_use_url": false, > "redirect_url": "https://your-application.com/return", > "flow_id": "12ABCD3E", > "language": "EN", > "mobile_app": true > }, > "link": "https://connect.argyle.com/?...", > "data_source": "payroll" > } > ``` > [accordion] Banking response > > ```json theme={} > { > "verification": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b", > "configuration": { > "experience": "97f1eccb-241d-4052-8409-fab2dcc489b", > "single_use_url": false, > "redirect_url": "https://your-application.com/return" > }, > "link": "https://connect2.finicity.com?...", > "data_source": "banking" > } > ``` See the [Create a Session endpoint](/api-reference/partners-verifications/create-a-session) for every available request field. ### Invites To create an invite link, use [`POST /partners/v2/sessions`](/api-reference/partners-verifications/create-a-session) and set `type` to `invite`. The user must have at least one active payroll or banking verification. Include `configuration.email`, `configuration.phone_number`, or both to send the invite by email or SMS: ```json theme={} { "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69", "type": "invite", "configuration": { "email": "jane.doe@example.com", "phone_number": "+15555555555" } } ``` To share the link yourself without sending email or SMS, omit both contact fields. You can omit `configuration` entirely when no other invite settings are needed: ```json theme={} { "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69", "type": "invite" } ``` One invite can include one or more active payroll or banking verifications for the same user. Invite links expire after 180 days or when revoked. > [!NOTE] > > For wholesale mortgage implementations, add `external_metadata.broker` to the user and omit `configuration.flow_id` to use the default wholesale flow. A custom flow must be a wholesale flow to override that default. See [Wholesale Mortgage](/partners/wholesale-mortgage) for setup, flow selection, and notifications. ## Launch an embedded session Use the returned session `link` according to the verification's data source. ### Payroll * Pass `link` as `connectUrl` when initializing the [Web SDK](/link/initialization/web#initialize-with-connecturl) or [Mobile SDKs](/link/initialization/mobile-sdks). * For Hosted Link, open the URL in a browser context. Hosted Link does not provide Link callbacks. ### Banking * Pass `link` as `connectURL` when launching the banking SDK. * Use SDK callbacks for immediate frontend handling and the `verifications.updated` webhook for backend lifecycle tracking. * See [Banking Verifications](/partners/verification-types/banking#choose-a-session-type) for the SDK example and hosted-session requirements. ## Track status and retrieve the report Listen for the [`verifications.updated`](/api-reference/partners-webhooks/updated) webhook. When `status.code` is `completed` or `completed_with_errors`, retrieve the report from `report.file_url` or `report.json_url`. Continue with [Verification Statuses](/partners/verification-statuses). # Re-verification Source: https://docs.argyle.com/partners/re-verification Request updated verification results. Reuse the existing user when requesting updated results. The next step depends on whether the user's connection is still valid or they need to reconnect or provide new documents. ## Refresh without user action > [!NOTE] > > The refresh endpoint supports payroll, banking, and Doc VOI verifications. It returns a new verification ID and report. Use [`POST /partners/v2/verifications/refresh`](/api-reference/partners-verifications/refresh-a-verification) to create a **new** payroll or banking verification without the user needing to reconnect, as long as a valid connection is still available. For Doc VOI, use the same endpoint with `report.type = doc-voi-mortgage` to generate a new report from the user's existing uploaded documents without uploading additional documents. Track the new verification through [`verifications.updated`](/api-reference/partners-webhooks/updated) webhooks. Retrieve its report when the status reaches `completed` or `completed_with_errors`. See [Verification Statuses](/partners/verification-statuses). ## Reconnection required If a previously completed payroll or banking verification needs updated data and the connection is no longer valid, the user must reconnect. The same path applies when the user needs to connect another account. 1. Order a new verification for the existing `user` with [`POST /partners/v2/verifications`](/api-reference/partners-verifications/order-a-verification). 2. Create a [session](/partners/quickstart#create-a-session) for the new verification. 3. Return the user to [Link for payroll](/partners/verification-types/payroll#user-experience) or the [banking connection experience](/partners/verification-types/banking#choose-a-session-type) to complete the required connection steps. 4. Track the new verification's status and retrieve its completed report. > [!NOTE] > > If the verification is still active, create another session for that verification instead. An expired session or a request for MFA does not by itself require a new verification. See [Recovery and Errors](/partners/recovery-and-errors#session-not-completed). ## Doc VOI with new documents To refresh a Doc VOI report with additional or updated documents, order a new `doc-voi-mortgage` verification for the same `user` with [`POST /partners/v2/verifications`](/api-reference/partners-verifications/order-a-verification). The request shape is the same as a new document verification, including the `employments` requirements. Previously uploaded documents for the user remain available as the baseline for the new verification. After the new verification is created: 1. Upload each net-new document for the same `user` with [`POST /partners/v2/user-uploads`](/api-reference/partners-verifications/upload-a-document). 2. Listen for [`verifications.updated`](/api-reference/partners-webhooks/updated) webhooks as the verification moves through document processing. 3. Retrieve the refreshed report from `report.file_url` or `report.json_url` when the verification is complete. # Recovery and Errors Source: https://docs.argyle.com/partners/recovery-and-errors Resume incomplete sessions and correct invalid verification requests. Use the verification's current `status.state`, `status.code`, and `status.errors` to decide whether to resume the existing verification or create a new one. ## Choose a recovery action | Status or situation | Action | | - | - | | Active verification; session closed or expired | Create another session for the same verification. | | `connection_attempted` | Review the account connection error and return the user to the active verification. | | `syncing_error` | Create another session so the user can complete MFA or other required action. | | `more_data_required` | Upload the additional Doc VOI documents for the same user. | | `cancelled_by_client` or `argyle_timeout` | The verification cannot be resumed. Create a new verification if another attempt is appropriate. | | `system_error` | Review `status.errors` and contact Argyle Support before retrying. | ## Session not completed If the user closes the connection flow, or the session link expires, retrieve the verification and check its current status. When the verification remains active in `pending` or `user_session_started`, create a new session for the same verification with [`POST /partners/v2/sessions`](/partners/quickstart#create-a-session). Do not create another verification solely to replace an expired session link. For `connection_attempted` or `syncing_error`, review the current account connection error in `status.errors`, correct the issue, and create another session for the same active verification. ## User details missing or invalid If `POST /partners/v2/verifications` returns a 400 response for missing or invalid user details: 1. Update the user with [`PATCH /partners/v2/users/{id}`](/api-reference/partners-verifications/update-a-user). 2. Retry `POST /partners/v2/verifications`. ## More documents required When a Doc VOI verification enters `more_data_required`, review `status.errors` for the missing information. Upload the additional files for the same user with [`POST /partners/v2/user-uploads`](/api-reference/partners-verifications/upload-a-document). Continue listening for the `verifications.updated` webhook as processing resumes. # Reports and Source Documents Source: https://docs.argyle.com/partners/reports-and-source-documents View report examples and retrieve their supporting files. Source documents are the original paystubs, tax forms, and uploaded files that support a verification. This page shows report examples and how to retrieve completed reports and available source documents. > [!NOTE] > > Report and source-document URLs require [Argyle authentication headers](/verifications/platform-partners#authentication). Store and deliver these files according to your application retention requirements. ## Retrieve completed reports When a verification reaches `completed` or `completed_with_errors`, the verification resource contains: * `report.file_url` — the report PDF. * `report.json_url` — the report data in JSON format. Follow [Verification Statuses](/partners/verification-statuses#download-reports-and-json) for the webhook and retrieval flow. ## Retrieve source documents Connected payroll accounts can include paystubs, tax forms, and other source documents. Use the [Payroll Documents](/api-reference/partners-data-sets/list-all-payroll-documents) endpoints to list or retrieve document metadata, then request the returned `file_url` with Argyle authentication headers. Use the partner document upload endpoint when submitting files for Doc VOI. For source files from connected payroll accounts, use Partner Data Sets. ## Example reports > [accordion] Verification of Income and Employment (Payroll VOIE) — PDF and JSON > > [PDF](https://res.cloudinary.com/argyle-media/image/upload/v1749501632/docs-2025/voie_example_argyle.pdf) > > Report PDF > > ![Image of Argyle's Verification of Income and Employment (VOIE) report.](https://mintcdn.com/argyle/QY9l-CtcSx2-TuFM/images/api-ref/reports2/1-voie.png?fit=max\&auto=format\&n=QY9l-CtcSx2-TuFM\&q=85\&s=2abf3c9ca559e53db7bf43dcd5eb2d59) > > The JSON example below shows selected fields. > > [Download complete JSON](/examples/reports/payroll-voie.json) > > ```json theme={} > { > "report_id": "6da4c9a3-2e63-95e5-8be3-f9a52ddc489a", > "type": "voie", > "user_id": "018051aa-f7a9-a0db-2f38-6cfa325e9d69", > "created_at": "2023-03-26T09:20:06.081Z", > "employments": [ > { > "employment": "0186a27d-e5c6-735a-a359-6315b34d544c", > "employer": "Whole Goods", > "status": "active", > "base_pay": { > "amount": "75372.62", > "currency": "USD", > "period": "annual" > }, > "monthly_income": { > "argyle": { > "total": "7102.33", > "base": "6902.55", > "overtime": "165.94", > "bonus": "5.22", > "commission": "28.62", > "other": "0.00" > } > } > } > ] > } > ``` > [accordion] Verification of Income and Employment (Mortgage Payroll VOIE+) — PDF and JSON > > [PDF](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/VOIE_plus.pdf) > > When VOIE+ is enabled for your organization, mortgage VOIE reports include monthly income calculations from Freddie Mac when available. > > Continue to request `voie` through the Verifications API or `voie-mortgage` through the classic Reports API. > > **Report PDF** > > Freddie Mac's monthly income calculations appear in the corresponding employment section. Freddie Mac's Findings Report is appended to the same PDF when available. > > ![Image of a Verification of Income and Employment (Mortgage Payroll VOIE+) report.](https://mintcdn.com/argyle/LBzP1js8YRjtERKs/images/api-ref/reports2/voie-plus.png?fit=max\&auto=format\&n=LBzP1js8YRjtERKs\&q=85\&s=1d4ef33f618b23756bd3710ba5abcb0b) > > **Report JSON** > > Calculations appear under `employments[].monthly_income.aim_check`, with values for `total`, `base`, `overtime`, `bonus`, `commission`, and `other`. > > If all values in `aim_check` are `null`, Freddie Mac did not return a monthly income calculation for that employment. Lender should still proceed to submit through the full Loan Product Advisor (LPA) process for further review. > > The JSON examples below show selected fields. > > [Download complete JSON](/examples/reports/mortgage-payroll-voie-plus.json) > > ```json Report excerpt theme={} > { > "report_id": "cdf4d756-102b-4184-bd07-31f8ee41a2d3", > "type": "voie-mortgage", > "user_id": "01a1225f-5b1b-d05c-af72-eab13af50361", > "created_at": "2026-10-09T20:36:30.960Z", > "employments": [ > { > "employment": "89799b54-f34b-372f-9817-577965f215b3", > "employer": "QuantumByte Solutions", > "status": "active", > "base_pay": { > "amount": "48.08", > "currency": "USD", > "period": "hourly" > }, > "monthly_income": { > "argyle": { > "total": "1432.91", > "base": "1146.19", > "overtime": "164.88", > "bonus": "90.61", > "commission": "31.23", > "other": "0.00" > }, > "aim_check": { > "total": "1585.83", > "base": "1267.25", > "overtime": "183.88", > "bonus": "97.12", > "commission": "37.58", > "other": "0.00" > } > } > } > ] > } > ``` > > ```json aim_check theme={} > { > "employments": [ > { > "monthly_income": { > "aim_check": { > "total": "1585.83", > "base": "1267.25", > "overtime": "183.88", > "bonus": "97.12", > "commission": "37.58", > "other": "0.00" > } > } > } > ] > } > ``` > [accordion] Verification of Income and Employment (Government Payroll VOIE) — PDF and JSON > > [PDF](https://res.cloudinary.com/argyle-media/image/upload/v1783533516/docs-2026/voie-government_example_argyle.pdf) > > ![Image of Argyle's Verification of Income and Employment (Government Payroll VOIE) report.](https://mintcdn.com/argyle/5R0AhShkTxk7hi-c/images/api-ref/reports2/3-voie-government.png?fit=max\&auto=format\&n=5R0AhShkTxk7hi-c\&q=85\&s=604eba494234f57b47221fea88b526c2) > > The JSON example below shows selected fields. > > [Download complete JSON](/examples/reports/government-payroll-voie.json) > > ```json theme={} > { > "report_id": "7a4d2fd6-9c7d-4e0d-a8d3-9e97f54d21f1", > "type": "voie-government", > "user_id": "f83b9d2f-0b3d-4ec9-91d4-82cf9e1c1b2a", > "created_at": "2026-05-20T18:30:00.000Z", > "reporting_period": { > "days": 90, > "start_date": "2026-03-09", > "end_date": "2026-06-07" > }, > "certification": [ > { > "type": "report", > "employment": null, > "status": "certified", > "completed_at": "2026-05-20T18:30:00.000Z", > "user_comment": null > } > ], > "employments": [ > { > "employment": "0186a27d-e5c6-735a-a359-6315b34d544c", > "employer": "Whole Goods", > "income_source_type": "w2", > "certified": true, > "period_summary": [ > { > "period": { > "start_date": "2026-03-09", > "end_date": "2026-06-07" > }, > "currency": "USD", > "gross_pay": "18298.28", > "net_pay": "14065.93", > "hours": "914.75", > "mileage": null, > "paystubs_count": 7, > "trips_count": null > } > ] > } > ] > } > ``` > [accordion] Verification of Employment (Payroll VOE) — PDF and JSON > > [PDF](https://res.cloudinary.com/argyle-media/image/upload/v1746481161/docs-2025/voe_example.pdf) > > Report PDF > > ![Image of Argyle's Verification of Employment (VOE) report.](https://mintcdn.com/argyle/QY9l-CtcSx2-TuFM/images/api-ref/reports2/2-voe.png?fit=max\&auto=format\&n=QY9l-CtcSx2-TuFM\&q=85\&s=6c206b7a1dad09a13ec8d3e9f4ea3008) > > The JSON example below shows selected fields. > > [Download complete JSON](/examples/reports/payroll-voe.json) > > ```json theme={} > { > "report_id": "6c3fa756-2e76-43e1-55f6-e29fc6ae535d", > "type": "voe", > "user_id": "018051aa-f7a9-a0db-2f38-6cfa325e9d69", > "created_at": "2023-03-26T09:19:08.916Z", > "employments": [ > { > "employment": "0186a27d-e5c6-735a-a359-6315b34d544c", > "employer": "Whole Goods", > "status": "active", > "employment_type": "full-time", > "job_title": "Store Manager", > "start_date": "2020-08-28", > "end_date": null, > "last_paystub_date": "2023-03-24" > } > ] > } > ``` > [accordion] Verification of Assets (Banking VOA) — PDF and JSON > > [PDF](https://res.cloudinary.com/argyle-media/image/upload/v1749582203/docs-2025/VOA_Banking_Report.pdf) > > Report PDF > > ![Image of Verification of Assets (VOA) banking report.](https://mintcdn.com/argyle/EtHVUNI_SMseJQur/images/argyle-guides/api-ref/banking-reports/banking-voa.png?fit=max\&auto=format\&n=EtHVUNI_SMseJQur\&q=85\&s=90dfe8c33ce68adc18dd6bd993febceb) > > The JSON example below shows selected fields. > > [Download complete JSON](/examples/reports/banking-voa.json) > > ```json theme={} > { > "id": "m22kz9tzmz3t", > "type": "voa", > "status": "success", > "created_date": "2025-06-10T18:57:22.000Z", > "assets": { > "type": null, > "available_balance": 18349.6, > "current_balance": 22327.3, > "two_month_average": 21995.27, > "six_month_average": null, > "beginning_balance": 20942.02 > }, > "consolidated_available_balance": 18349.6, > "institutions": [ > { > "id": 102168, > "name": "FinBank Profiles - B", > "accounts": [ > { > "id": 8057635035, > "name": "Savings", > "type": "savings", > "balance": 22327.3 > } > ] > } > ] > } > ``` > [accordion] Verification of Assets & Income (Banking VOAI) — PDF and JSON > > [PDF](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/VOAI_Banking_Report.pdf) > > Report PDF > > ![Image of Verification of Assets & Income (VOAI) banking report.](https://mintcdn.com/argyle/ghfim0fZqG69QDy3/images/argyle-guides/api-ref/banking-reports/banking-voai-2026.png?fit=max\&auto=format\&n=ghfim0fZqG69QDy3\&q=85\&s=b518f57c8342a1f77f1752b843cc7b42) > > The JSON example below shows selected fields. > > [Download complete JSON](/examples/reports/banking-voai.json) > > ```json theme={} > { > "id": "q3senvchs15n", > "type": "voaHistory", > "status": "success", > "created_date": "2026-09-16T21:04:48.000Z", > "assets": { > "current_balance": 14911.0, > "two_month_average": 10745.1, > "six_month_average": 9592.05, > "beginning_balance": 38693.34 > }, > "consolidated_available_balance": 14911.0, > "institutions": [ > { > "id": 102105, > "name": "FinBank Profiles - A", > "accounts": [ > { > "id": 9035542498, > "name": "Checking", > "type": "checking", > "balance": 14911.0, > "income_streams": [ > { > "id": "q3senvchs15n1", > "name": "abc", > "status": "ACTIVE", > "confidence": 100, > "cadence": { > "start_date": "2025-09-30T12:00:00.000Z", > "stop_date": null, > "days": 13 > } > } > ] > } > ] > } > ] > } > ``` > [accordion] Verification of Income (Banking VOI) — PDF and JSON > > [PDF](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/VOI_Banking_Report.pdf) > > Report PDF > > ![Image of Verification of Income (VOI) banking report.](https://mintcdn.com/argyle/CvJPgig9j-lpaCnS/images/argyle-guides/api-ref/banking-reports/banking-voi-2026.png?fit=max\&auto=format\&n=CvJPgig9j-lpaCnS\&q=85\&s=41456c3aa6d6c473a3d6cbc3de24e0b5) > > The JSON example below shows selected fields. > > [Download complete JSON](/examples/reports/banking-voi.json) > > ```json theme={} > { > "id": "bdmczjhxc8vj-voi", > "type": "voi", > "status": "success", > "created_date": "2026-09-03T23:03:00.000Z", > "income": [ > { > "confidence_type": "HIGH", > "income_estimate": { > "estimated_gross_annual": 115731, > "net_annual": 81703.67, > "projected_gross_annual": 130005, > "projected_net_annual": 89052.02, > "average_monthly_net": 6808.64, > "average_monthly_gross": 9644.25 > } > } > ] > } > ``` > [accordion] Verification of Employment (Banking VOE) — PDF and JSON > > [PDF](https://res.cloudinary.com/argyle-media/image/upload/v1778709376/docs-2026/VOE_Transactions_Banking_Report.pdf) > > Report PDF > > ![Image of Verification of Employment (Banking VOE) banking report.](https://mintcdn.com/argyle/2zIhWH3AFpQVLqPj/images/argyle-guides/api-ref/banking-reports/banking-voe-transactions.png?fit=max\&auto=format\&n=2zIhWH3AFpQVLqPj\&q=85\&s=b3cf66e31c2bfc6fab6a0c9e32b9b7cb) > > The JSON example below shows selected fields. > > [Download complete JSON](/examples/reports/banking-voe.json) > > ```json theme={} > { > "id": "acbv1wdhitx6-voetransactions", > "type": "voeTransactions", > "status": "success", > "created_date": "2026-05-13T21:53:05.000Z", > "institutions": [ > { > "id": 102168, > "name": "FinBank Profiles - B", > "accounts": [ > { > "id": 9022110214, > "name": "Checking", > "type": "checking", > "income_streams": [ > { > "id": "acbv1wdhitx6-voetransactions1", > "name": "check-cash deposit", > "status": "ACTIVE", > "confidence": 100, > "cadence": { > "start_date": "2024-06-02T12:00:00.000Z", > "stop_date": null, > "days": 16 > }, > "days_since_last_transaction": 0, > "next_expected_transaction_date": "2026-05-29T12:00:00.000Z" > } > ] > } > ] > } > ] > } > ``` > [accordion] Verification of Income (Doc VOI) — PDF and JSON > > [PDF](https://res.cloudinary.com/argyle-media/image/upload/v1778710602/docs-2026/Doc_VOI.pdf) > > Report PDF > > ![Image of Verification of Income (Doc VOI) report.](https://mintcdn.com/argyle/2zIhWH3AFpQVLqPj/images/argyle-guides/api-ref/document-verifications/doc-voi.png?fit=max\&auto=format\&n=2zIhWH3AFpQVLqPj\&q=85\&s=ae1767eb9a4898900142f85c3cbe131e) > > The JSON example below shows selected fields. > > [Download complete JSON](/examples/reports/document-voi.json) > > ```json theme={} > { > "report_id": "02889578-fb0f-4fb5-8ee3-f2d8f3f8116b", > "type": "doc-voi-mortgage", > "user_id": "019e2367-129d-98d2-8ff0-56660fee2c83", > "created_at": "2026-05-13T22:15:55.226Z", > "documents": [ > { > "id": "019e2368-ceb6-102e-7c0f-4e4a957b53de", > "employer": "WAREHOUSE SERVICES INC", > "document_type": "paystubs", > "pay_date": "2026-05-12", > "pay_period_start_date": "2026-04-27", > "pay_period_end_date": "2026-05-12", > "year": null > } > ], > "employments": [ > { > "source": "Doc Upload", > "employer": "WAREHOUSE SERVICES INC", > "status": "active", > "monthly_income": { > "aim_check": { > "total": "6400.32", > "base": "3791.99", > "overtime": "1200.00", > "bonus": "1408.33", > "commission": "0.00", > "other": "0.00" > } > } > } > ] > } > ``` # Testing Source: https://docs.argyle.com/partners/testing Test each verification type in Sandbox. Use Sandbox API keys for your partner integration and the customer `client` ID provided by Argyle. Follow the [Partner Quickstart](/partners/quickstart) before testing the profiles below. This page adds the product-specific profiles and files used to test payroll, banking, and Doc VOI verifications. ## Payroll test profiles Use Argyle's [sample user credentials](https://docs.argyle.com/overview/sandbox-testing#connect-sample-users) in Link to connect to: * **Sandbox**: any employer or payroll provider * **Production**: `Platformtronic` or `Employertronic` For specific scenario testing, the following sample users are also available: | | Homer Loanseeker | Suzi Builder | Andy Freddie | | - | - | - | - | | Email | homer\_loanseeker\@argyle.com | suzi\_builder\@argyle.com | andy\_freddie\@argyle.com | | Username | homer\_loanseeker | suzi\_builder | andy\_freddie | | Password | passgood | passgood | passgood | | Verification code | 9081 | 9084 | 9088 | | Phone number | (800) 900-0101 | (800) 900-0104 | (800) 900-0108 | | Driver's license # | D1230101 | D1230104 | D1230108 | | **Returns** | **1 active employment** | **2 active employments** | **1 active and 1 terminated employment** | ## Banking test profiles > [!NOTE] > > When you're ready to begin testing, contact your Argyle Customer Success Manager to enable banking permissions. > [!WARNING] > > The Sandbox testing environment for banking supports a maximum of 500 users. To stay within this limit, implement user-management workflows and remove inactive users when they are no longer needed. The following sample test profiles can be connected to: * **Sandbox**: connect to `FinBank Profiles A` or `FinBank Profiles B` * **Production**: connect to `FinBank Billable` or `FinBank Oauth Billable` | Username | Password | Account types | Supported products | | - | - | - | - | | profile\_02 | profile\_02 | Savings, IRA, 401k, Credit Card | `voa`, `voi`, `voai` | | profile\_03 | profile\_03 | Checking, Personal Investment, 401K, Roth, Savings (Joint Account owners) | `voa`, `voi`, `voai` | | profile\_04 | profile\_04 | Checking, 403B, 529, Rollover, Mortgage | `voa`, `voi`, `voai` | | profile\_05 | profile\_05 | Checking, Investment, Stocks, UGMA, UTMA (Joint Account owners) | `voa`, `voi`, `voai` | | profile\_06 | profile\_06 | Checking, Retirement, KEOGH, 457, Credit Card | `voa`, `voi`, `voai` | | profile\_07 | profile\_07 | Checking, Stocks, CD, Investment Tax-Deferred, Employee Stock | `voa`, `voi`, `voai` | | profile\_08 | profile\_08 | Checking, Primary Savings, Money Market, 401A, Line of credit | `voa`, `voi`, `voai` | | profile\_09 | profile\_09 | Checking, Savings, Checking failed report. Errors include `102`, `103`, `185`. | `voa`, `voi`, `voai` *(failed report)* | For specific scenario testing, the following sample users are also available: | | Sue Wealthy | River Paycheck | Alex Student | | - | - | - | - | | Username | sue\_wealthy | river\_paycheck | alex\_student | | Password | profile\_700 | profile\_703 | profile\_704 | | Description | Sue is working as a Product Manager with a good steady income, a mortgage, and multiple investment accounts. She has a loan account and leases a car. Sue travels a few times a year. She has typical expenses like groceries, clothes, entertainment, gym membership, car expenses, and she has a pet. | River works in construction. He rents an apartment and has typical expenses like groceries, clothes, entertainment, household and car expenses. He has some savings but no investments, no loans and no credit cards. In some months, River's expenses exceed his income. | Alex is working full-time with a good salary but she is still paying off her student loan. She makes regular monthly repayments, but she still has over \$30,000 to pay off. Alex has typical expenses like groceries, clothes, entertainment, household, and car expenses. She has limited savings and she has started an investment account. | ## Doc VOI test documents > [!NOTE] > > When you're ready to begin testing, contact your Argyle Customer Success Manager to enable document permissions. Use the sample documents below for Doc VOI verifications. For all scenarios below, order a document verification with the following `employments` value: ```json theme={} "employments": [ { "employer": "Warehouse Services Inc", "status": "active", "hire_date": "2023-02-01", "termination_date": null } ] ``` > [!WARNING] > > Do not adjust file names. > [tab] Sandbox > > > [accordion] GSE-eligible monthly income > > > > Upload the following documents: > > > > * [Warehouse\_Services\_Inc\_paystub.pdf](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/Warehouse_Services_Inc_paystub.pdf) > > * [Warehouse\_Services\_Inc\_paystub\_2025.pdf](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/Warehouse_Services_Inc_paystub_2025.pdf) > > * [Warehouse\_Services\_Inc\_paystub\_2024.pdf](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/Warehouse_Services_Inc_paystub_2024.pdf) > > > [accordion] Not GSE-eligible monthly income > > > > Upload the following documents: > > > > * [Warehouse\_Services\_Inc\_paystub\_ineligible.pdf](https://res.cloudinary.com/argyle-media/image/upload/docs-2025/Warehouse_Services_Inc_paystub_ineligible.pdf) > > * [Warehouse\_Services\_Inc\_paystub\_2025.pdf](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/Warehouse_Services_Inc_paystub_2025.pdf) > > * [Warehouse\_Services\_Inc\_paystub\_2024.pdf](https://res.cloudinary.com/argyle-media/image/upload/docs-2025/Warehouse_Services_Inc_paystub_2024.pdf) > > > [accordion] Requires more data > > > > Upload only the following document: > > > > * [Warehouse\_Services\_Inc\_paystub.pdf](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/Warehouse_Services_Inc_paystub.pdf) > [tab] Production > > > [!NOTE] > > > > Production testing can be done with real documents. If needed, use the sample files below. > > > [accordion] GSE-eligible monthly income > > > > Upload the following documents: > > > > * [sandbox\_Warehouse\_Services\_Inc\_paystub.pdf](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/sandbox_Warehouse_Services_Inc_paystub.pdf) > > * [sandbox\_Warehouse\_Services\_Inc\_paystub\_2025.pdf](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/sandbox_Warehouse_Services_Inc_paystub_2025.pdf) > > * [sandbox\_Warehouse\_Services\_Inc\_paystub\_2024.pdf](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/sandbox_Warehouse_Services_Inc_paystub_2024.pdf) > > > [accordion] Not GSE-eligible monthly income > > > > Upload the following documents: > > > > * [sandbox\_Warehouse\_Services\_Inc\_paystub\_ineligible.pdf](https://res.cloudinary.com/argyle-media/image/upload/docs-2025/sandbox_Warehouse_Services_Inc_paystub_ineligible.pdf) > > * [sandbox\_Warehouse\_Services\_Inc\_paystub\_2025.pdf](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/sandbox_Warehouse_Services_Inc_paystub_2025.pdf) > > * [sandbox\_Warehouse\_Services\_Inc\_paystub\_2024.pdf](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/sandbox_Warehouse_Services_Inc_paystub_2024.pdf) > > > [accordion] Requires more data > > > > Upload only the following document: > > > > * [sandbox\_Warehouse\_Services\_Inc\_paystub.pdf](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/sandbox_Warehouse_Services_Inc_paystub.pdf) # Verification Statuses Source: https://docs.argyle.com/partners/verification-statuses Track verification status changes and retrieve completed report results. Use verification webhooks as the source of truth for backend lifecycle tracking. SDK callbacks can update the immediate frontend experience, but they do not replace verification status updates. ## Subscribe to webhooks Subscribe to the [`verifications.updated`](/api-reference/partners-webhooks/updated) webhook to track lifecycle events. > [!NOTE] > > Set `config.include_resource = true` so the webhook payload contains the full verification object inside `data.resource`. The most common verification `status.code` values are: | Status code | Meaning | | - | - | | `pending` | Verification created; user action may still be required. | | `user_session_started` | User opened the connection flow. | | `authenticated` | User authenticated and processing has started. | | `awaiting_certification` | Government verification is waiting for applicant self-certification. | | `documents_processing` | Uploaded documents are processing. | | `report_generating` | The report is generating. | | `completed` | The report is ready to retrieve. | | `completed_with_errors` | The report is ready, but contains limitations or deficiencies. | These are the primary lifecycle updates. See [`status`](/api-reference/partners-verifications/retrieve-a-verification#response-status) for all state transitions and their meanings. ## Download reports and JSON When `status.code` is `completed` or `completed_with_errors`, the `report` object contains: * `file_url` — PDF report * `json_url` — report in JSON format > [accordion] Example webhook > > ```json theme={} > { > "event": "verifications.updated", > "name": "name-for-the-webhook-subscription", > "data": { > "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69", > "verification": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b", > "resource": { > "id": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b", > "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69", > "created_at": "2023-03-09T16:22:06.081Z", > "updated_at": "2023-03-09T16:22:06.081Z", > "channel": "ncino", > "partner": { > "id": "019a76cd-a572-8a09-c6e4-b0a85e42b10f", > "name": "nCino" > }, > "status": { > "state": "COMPLETED", > "code": "completed", > "errors": [] > }, > "report": { > "id": "2a14ce6f-3aed-4c15-8ea2-92a17b6edb95", > "type": "doc-voi-mortgage", > "file_url": "www.argyle.com/storagename/pdf", > "json_url": "www.argyle.com/storagename/json" > }, > "employments": [ > { > "employer": "Starbucks", > "status": "active", > "hire_date": "2015-08-28", > "termination_date": null > } > ], > "loan": { > "number": "1234", > "borrower_id": "ABC789", > "application_id": "2121313", > "officer_email": "john.doe@mortgage.com" > }, > "billing": { > "cost_center": "5" > }, > "data_source": "documents" > } > } > } > ``` GET requests to `file_url` and `json_url` require [Argyle authentication headers](/verifications/platform-partners#authentication). # Banking Verifications Source: https://docs.argyle.com/partners/verification-types/banking Order asset, income, and transaction reports from financial accounts. Use a banking verification when the user will connect financial accounts and share the information required for an asset, income, or transaction report. ## Create or re-use a user If the person already has an Argyle user for the same customer, reuse that user ID across payroll, banking, and document workflows. [Update the existing user](/api-reference/partners-verifications/update-a-user) with any missing banking details before ordering the verification. Banking verifications require: * `first_name` and `last_name`. * `address`. * Either `ssn` or `birth_date`. * Either `email` or `phone_number`. For a new user, send the following body to [`POST /partners/v2/users`](/api-reference/partners-verifications/create-a-user). This example uses `birth_date` and `email`. Your Argyle Customer Success Manager will provide a `client` ID for each customer. Include it when creating the user so their records are associated with the correct customer. The `client` identifies the organization, not the person sharing information. ```json theme={} { "client": "39096494-45c8-4fd8-9454-3d1cb2d62db7", "first_name": "Jane", "last_name": "Doe", "email": "jane@example.com", "address": { "city": "New York", "line1": "123 Main St", "state": "NY", "country": "US", "postal_code": "10001" }, "birth_date": { "year": 1990, "month": 1, "day": 13 } } ``` Store the returned user `id` and use it as `user` when ordering the verification below. ## Order a banking verification * `voa` — Verification of Assets. * `voai` — Verification of Assets and Income. * `voi` — Verification of Income. * `voe-transactions` — Verification of Employment based on transaction data. Send the following body to [`POST /partners/v2/verifications`](/api-reference/partners-verifications/order-a-verification). Select the report type in `report.type`. The optional `report.configuration` object can define the history start date, income confidence threshold, and report custom fields. ```json theme={} { "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69", "report": { "type": "voai", "configuration": { "from_date": "2024-01-01T00:00:00Z", "income_stream_confidence_minimum": 50, "report_custom_fields": [ { "label": "loanID", "value": "12345", "shown": true } ] } } } ``` ## Choose a session type After ordering the verification, create an embedded session, send an invite, or create an invite link. ![A user connects financial accounts for a banking verification.](https://mintcdn.com/argyle/EtHVUNI_SMseJQur/images/argyle-guides/api-ref/banking-reports/1-banking.png?fit=max\&auto=format\&n=EtHVUNI_SMseJQur\&q=85\&s=e3e171f6dad5485eae24082b36fa81a9) ### Embedded banking Create a session with [`POST /partners/v2/sessions`](/api-reference/partners-verifications/create-a-session), then pass the returned session `link` to the banking SDK as `connectURL`. > [accordion] Banking SDK example > > ```html theme={} >
> > > ``` Use SDK callbacks for immediate frontend handling. Subscribe to the [`verifications.updated`](/api-reference/partners-webhooks/updated) webhook for backend lifecycle tracking. For SDK installation and configuration options, see the [banking SDK documentation](https://developer.mastercard.com/open-finance-us/documentation/connect/integrating/sdk/web-sdk/sdk/). ### Invites Create an invite session with `type = invite` and the user ID. Include `configuration.email`, `configuration.phone_number`, or both to send the invite by email or SMS. Omit both to share the returned `link` yourself. The user must have an active banking verification. The invitation opens a hosted connection flow, so no frontend SDK initialization is required. > [!NOTE] > > Banking invites and other hosted or no-SDK banking paths must be enabled by Argyle before use. Contact your Argyle Customer Success Manager before using one of these paths. See the [Quickstart invite example](/partners/quickstart#invites). ## Result Wait for the [`verifications.updated`](/api-reference/partners-webhooks/updated) webhook. When the verification reaches `completed` or `completed_with_errors`, retrieve the report from `report.file_url` or `report.json_url`. * See [Verification Statuses](/partners/verification-statuses). * Review the [banking report examples](/partners/reports-and-source-documents#banking-voa). * Use the [banking test profiles](/partners/testing#banking-test-profiles). # Doc VOI Source: https://docs.argyle.com/partners/verification-types/document-voi Order a mortgage income report from uploaded documents. Doc VOI uses paystubs and year-end income documents to support mortgage income calculations when a direct payroll connection is not used. > [!NOTE] > > Doc VOI is designed for mortgage workflows. For standalone document collection, OCR, and authenticity, use [Document Uploads](/workflows/document-processing). ## Create or re-use a user If the person already has an Argyle user for the same customer, reuse that user ID across payroll, banking, and document workflows. [Update the existing user](/api-reference/partners-verifications/update-a-user) with any missing details before ordering Doc VOI. The required fields are `first_name`, `last_name`, and `ssn`. For a new user, send the following body to [`POST /partners/v2/users`](/api-reference/partners-verifications/create-a-user): Your Argyle Customer Success Manager will provide a `client` ID for each customer. Include it when creating the user so their records are associated with the correct customer. The `client` identifies the organization, not the person sharing information. ```json theme={} { "client": "39096494-45c8-4fd8-9454-3d1cb2d62db7", "first_name": "Jane", "last_name": "Doe", "ssn": "000-00-0000" } ``` Store the returned user `id`. Use the same ID when ordering the verification and uploading its documents. ## Order a Doc VOI verification Send the following body to [`POST /partners/v2/verifications`](/api-reference/partners-verifications/order-a-verification). Set `report.type` to `doc-voi-mortgage` and include the employment details represented by the documents. ```json theme={} { "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69", "employments": [ { "employer": "Warehouse Services Inc", "status": "active", "hire_date": "2023-02-01", "termination_date": null } ], "report": { "type": "doc-voi-mortgage" } } ``` ## Required documents For each employment, provide: * The most recent paystub. * A W-2 or December/year-end paystub for each required prior year. The employment names and dates in the verification order should match the uploaded documents. The required history can vary by employment and mortgage workflow. If the verification enters `more_data_required`, upload the additional requested documents for the same user. ## Upload documents After ordering the verification, upload each document for the same user through [`POST /partners/v2/user-uploads`](/api-reference/partners-verifications/upload-a-document). A Doc VOI verification does not require a payroll or banking session. ![Doc VOI report PDF.](https://mintcdn.com/argyle/EtHVUNI_SMseJQur/images/argyle-guides/api-ref/document-verifications/1-documents.png?fit=max\&auto=format\&n=EtHVUNI_SMseJQur\&q=85\&s=47c994109741c21d13bfa75c60a90cb5) ## Result Wait for the [`verifications.updated`](/api-reference/partners-webhooks/updated) webhook while documents are processed and the report is generated. Retrieve the completed report from `report.file_url` or `report.json_url`. * See [Verification Statuses](/partners/verification-statuses). * Follow [Doc VOI re-verification](/partners/re-verification#doc-voi-with-new-documents) when updated documents are required. * Use the [Doc VOI test files](/partners/testing#doc-voi-test-documents). # Payroll Verifications Source: https://docs.argyle.com/partners/verification-types/payroll Order income and employment reports from payroll accounts. Use a payroll verification when the user will connect an employer or payroll-provider account and share income or employment information straight from the source. ## Create or re-use a user If the person already has an Argyle user for the same customer, reuse that user ID across payroll, banking, and document workflows. [Update the existing user](/api-reference/partners-verifications/update-a-user) if either `first_name` or `last_name` is missing; both are required for payroll verifications. For a new user, send the following body to [`POST /partners/v2/users`](/api-reference/partners-verifications/create-a-user): Your Argyle Customer Success Manager will provide a `client` ID for each customer. Include it when creating the user so their records are associated with the correct customer. The `client` identifies the organization, not the person sharing information. ```json theme={} { "client": "39096494-45c8-4fd8-9454-3d1cb2d62db7", "first_name": "Jane", "last_name": "Doe" } ``` Store the returned user `id` and use it as `user` when ordering the verification below. ## Order a payroll verification * `voie` — Verification of Income and Employment. * `voe` — Verification of Employment. Send the following body to [`POST /partners/v2/verifications`](/api-reference/partners-verifications/order-a-verification), using the required type in `report.type`: ```json theme={} { "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69", "report": { "type": "voie" } } ``` ## Government payroll `voie-government` is a payroll report type for government benefits workflows. The workflow can include applicant self-certification and other program-specific steps. See [Government Benefits](/verticals/government-benefits). ## User experience [Create an embedded or invite session](/partners/quickstart#create-a-session) after ordering the verification. The user opens Link, finds each relevant employer or payroll provider, and connects the corresponding account. ![Link is where payroll accounts are connected through Argyle.](https://mintcdn.com/argyle/zs6lb-w1jQV9DVbr/images/overview/how-argyle-works/2-how-argyle-works.png?fit=max\&auto=format\&n=zs6lb-w1jQV9DVbr\&q=85\&s=c9423cb37168de456ad6b65dce23efa6) Use the returned session `link` with the [Web SDK](/link/initialization/web#initialize-with-connecturl), [Mobile SDKs](/link/initialization/mobile-sdks), or [Hosted Link](/link/initialization/hosted-link). ## Result Wait for the [`verifications.updated`](/api-reference/partners-webhooks/updated) webhook. When the verification reaches `completed` or `completed_with_errors`, retrieve the report from `report.file_url` or `report.json_url`. * See [Verification Statuses](/partners/verification-statuses). * Review the [Payroll VOIE example](/partners/reports-and-source-documents#payroll-voie). * Use the [payroll test profiles](/partners/testing#payroll-test-profiles) in Sandbox. # Wholesale Mortgage Source: https://docs.argyle.com/partners/wholesale-mortgage Send broker-branded borrower invites through the Verifications API. Wholesale lenders can use the Verifications API to send borrower invites that display the mortgage broker's name and contact details. Borrowers use Argyle to share their income, employment, and asset information with the lender. The lender's application manages the broker's ordering workflow. For ordering through Encompass, see [TPO Connect](/integrations/pos-los/encompass/tpo-connect). ## Before you begin * Follow the [Quickstart](/partners/quickstart) for authentication and verification setup. * The wholesale lender's Argyle account must be configured for the Mortgage industry. Contact your Customer Success Manager if you need help with this setting. * Associate users and verifications with the lender. Broker details customize the borrower experience; brokers do not need separate Argyle accounts or API keys. ## Add broker details to the borrower When you [create a user](/api-reference/partners-verifications/create-a-user), include `external_metadata.broker`. For an existing borrower, [update the user](/api-reference/partners-verifications/update-a-user) before creating the invite. Your Argyle Customer Success Manager will provide a `client` ID for each customer. Include it when creating the user so their records are associated with the correct customer. The `client` identifies the organization, not the person sharing information. ```json theme={} { "client": "39096494-45c8-4fd8-9454-3d1cb2d62db7", "first_name": "John", "last_name": "Smith", "email": "john.smith@example.com", "external_metadata": { "broker": { "name": "Jane Diaz", "company_name": "Acme Mortgage", "email": "jane.diaz@example.com", "phone_number": "+14165551234", "nmls": "1234567" } } } ``` When adding a broker, `name` is required. `company_name`, `email`, `phone_number`, and `nmls` are optional. Use E.164 international format for the phone number. Missing contact details are omitted from the borrower-facing contact card. > [!NOTE] > > `company_name` supplies the `[Broker_company]` variable in [custom wholesale templates](/console/flows/email-sms-templates#wholesale-mortgage-templates). Keep using the same borrower user ID for subsequent verifications. Broker details are stored on the user, so they do not need to be supplied with each verification or invite. Include the additional [user details required by the verification type](/partners/quickstart#create-or-reuse-a-user), such as an address for banking verifications. ## Order verifications and send an invite 1. [Order a verification](/api-reference/partners-verifications/order-a-verification) for each required payroll or banking report. For wholesale loans, set `loan.division` to `wholesale` when ordering each verification. 2. To receive progress emails, set `configuration.notified_recipients` on each verification. Include the broker and any lender recipients who need updates. If this field is omitted, no verification progress emails are sent. 3. [Create a session](/api-reference/partners-verifications/create-a-session) with `type: invite` and the borrower user ID. Include `configuration.email`, `configuration.phone_number`, or both to send the invite by email or SMS. Omit both to share the returned `link` yourself. ```json theme={} { "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69", "type": "invite", "configuration": { "email": "john.smith@example.com", "reply_to": "jane.diaz@example.com" } } ``` The user must have at least one active payroll or banking verification. One invite can include multiple active verifications for the same borrower. `configuration.reply_to` controls where replies to the borrower invite go. It is separate from `configuration.notified_recipients` on the verification, which controls progress notifications. Adding broker contact details does not subscribe the broker or lender to those notifications. For document-based income verification, follow the [Doc VOI workflow](/partners/verification-types/document-voi). Doc VOI orders do not use an invite session. ## Choose the invite flow For Mortgage accounts, broker details determine whether the invite uses a wholesale or retail flow. Omit `configuration.flow_id` to use the matching default, or provide a custom flow created for that experience. | Broker details on the user | Provided flow | Flow used | | - | - | - | | Present | None | Default wholesale flow | | Present | Wholesale | Provided wholesale flow | | Present | Retail | Default wholesale flow | | Absent | None | Default retail flow | | Absent | Retail | Provided retail flow | | Absent | Wholesale | Default retail flow | Use separate custom flows for retail and wholesale. To customize wholesale messaging, ask your Customer Success Manager to enable wholesale flow creation, then create a [Mortgage Wholesale email/SMS template](/console/flows/email-sms-templates#wholesale-mortgage-templates). A custom flow is not required to use the default wholesale experience. ## Borrower experience ![A broker-branded email invitation opens a landing page where the borrower can connect payroll and bank accounts.](https://mintcdn.com/argyle/GL0Jr7nNNug7xalW/images/verifications/wholesale-borrower-experience.png?fit=max\&auto=format\&n=GL0Jr7nNNug7xalW\&q=85\&s=4d5415a06886b50c73783d76c21547ad) * The invite email, SMS, and landing page identify the broker. The default email sender name is `[Broker_name] via Argyle`. * The email and landing page show the broker's available contact details. * The lender remains named in the email footer and consent and data-sharing screens. Argyle Link and the banking connection experience may also display lender branding. * Subsequent invites for the same borrower retain the broker context, including when re-verification requires borrower action. Wholesale emails use the lender's [custom sender domain](/console/management/custom-sender-domain), when configured, or `notifications@argyle.com`. # Verifications Source: https://docs.argyle.com/verifications/overview Order payroll, banking, and Doc VOI reports through one lifecycle. A verification is an order for a report. You select the report type, then users connect their payroll or financial accounts, or documents are uploaded directly through the API or collected in Link. The result is a PDF and, when supported, JSON. ## Verification types > [card] [Payroll](/verifications/verification-types/payroll) > > Generate income and employment reports from connected payroll accounts. > [card] [Banking](/verifications/verification-types/banking) > > Generate asset, income, and transaction reports from connected financial accounts. > [card] [Doc VOI](/verifications/verification-types/document-voi) > > Generate mortgage income reports from uploaded payroll documents. Government benefits implementations use a payroll report with program-specific self-certification behavior. See [Government Benefits](/verticals/government-benefits). ## Workflow **1. Create or reuse a user** Reuse the person's existing user ID across payroll, banking, and document workflows, or create a user if needed. Update any missing details required by the next product before ordering its verification. **2. Order a verification** Select the report type and provide any type-specific configuration. **3. Start a session** Launch an embedded session or send an invite when the verification requires user action. **4. Track lifecycle updates** Subscribe to the `verifications.updated` webhook and use the verification status to determine the next action. **5. Retrieve the result** Download the completed report PDF or JSON from the URLs in the verification resource. [Follow the Quickstart](/verifications/quickstart). ## Continue implementing > [card] [Verification Statuses](/verifications/verification-statuses) > > Track status changes and retrieve completed results. > [card] [Reports and Source Documents](/verifications/reports-and-source-documents) > > View report examples and retrieve available paystubs, tax forms, or uploaded files. > [card] [Re-verification](/verifications/re-verification) > > Refresh connected data or submit updated Doc VOI files. > [card] [Recovery and Errors](/verifications/recovery-and-errors) > > Resume incomplete sessions and correct invalid user details. > [card] [Testing](/verifications/testing) > > Use payroll, banking, and Doc VOI test profiles. # Partner Implementations Source: https://docs.argyle.com/verifications/platform-partners Use Verifications through `/partners/v2`. This page is for platforms that use Argyle to run verifications for their customers. Each customer needs a [`client`](/api-reference/partners-verifications/create-a-user#body-client) ID in Argyle so users and verifications created through your platform are associated with the correct organization. ## Before you begin Your Argyle Customer Success manager will provide a `client` ID for each customer using your integration. Store the ID with that customer's configuration and include it when you create users on the customer's behalf. The `client` value identifies your customer's organization in Argyle's system. ## Authentication Send requests from your backend using your partner API key ID and secret with HTTP basic authentication. Use `https://api-sandbox.argyle.com/partners/v2` for Sandbox and `https://api.argyle.com/partners/v2` for Production. Use the keys for the selected environment. Partner mode only changes the documentation you are viewing. ![Partner credentials authenticate requests for both customers. Each create-user request supplies the client ID for the customer the user belongs to.](https://mintcdn.com/argyle/xwQm_O1WP486D3Pj/images/verifications/platform-partners/partner-authentication.png?fit=max\&auto=format\&n=xwQm_O1WP486D3Pj\&q=85\&s=22c85be3459e787a288dba192ac478fd) ## Create or reuse the user For embedded payroll and banking flows, start with a user associated with your customer. Order a verification using the user ID, then create a session using the verification ID. Use the returned session `link` to launch the frontend. ![Create a user with the customer's client ID, pass the returned user ID to order a verification, then pass the verification ID to create a session. Use the returned link to launch the frontend.](https://mintcdn.com/argyle/xwQm_O1WP486D3Pj/images/verifications/platform-partners/user-verification-session.png?fit=max\&auto=format\&n=xwQm_O1WP486D3Pj\&q=85\&s=3ba51445a143b1d3b42ef91d7b2eb227) If the person already has a user ID for that customer, reuse it. Otherwise, create a user with [`POST /partners/v2/users`](/api-reference/partners-verifications/create-a-user). Include the required [`client`](/api-reference/partners-verifications/create-a-user#body-client) ID for that customer, along with the personal information required for the verification type. ```json theme={} { "client": "39096494-45c8-4fd8-9454-3d1cb2d62db7", "first_name": "Jane", "last_name": "Doe", "ssn": "000-00-0000" } ``` Continue using the same user ID when ordering another product for that person and customer. If the product requires additional information, [update their details](/api-reference/partners-verifications/update-a-user) before placing the order. ## Endpoint family Use `/partners/v2` when your platform creates users and orders verifications for your customers. Use `/v2` when your organization is implementing Argyle for its own workflow. | Shared operation | Partner endpoint | | - | - | | Create a user | [`POST /partners/v2/users`](/api-reference/partners-verifications/create-a-user) | | Update a user | [`PATCH /partners/v2/users/{id}`](/api-reference/partners-verifications/update-a-user) | | Order a verification | [`POST /partners/v2/verifications`](/api-reference/partners-verifications/order-a-verification) | | Create a session | [`POST /partners/v2/sessions`](/api-reference/partners-verifications/create-a-session) | | Refresh a verification | [`POST /partners/v2/verifications/refresh`](/api-reference/partners-verifications/refresh-a-verification) | | Retrieve or update a verification | [Partner Verifications API](/api-reference/partners-verifications/retrieve-a-verification) | ## Implementation guides Follow the partner guides for request examples and implementation steps: * [Quickstart](/partners/quickstart) * [Verification Types](/partners/overview#verification-types) * [Verification Statuses](/partners/verification-statuses) * [Re-verification](/partners/re-verification) * [Recovery and Errors](/partners/recovery-and-errors) * [Testing](/partners/testing) The partner guides use `/partners/v2` throughout. Continue using this endpoint family for user, verification, session, and refresh requests. ## Webhooks Create partner webhook subscriptions through [`POST /partners/v2/webhooks`](/api-reference/partners-webhooks/create-a-webhook). Set `config.include_resource` to `true` for the `verifications.updated` webhook so the webhook contains the full verification resource. Handle duplicate webhook deliveries without creating duplicate records. Store the verification ID and use the current verification resource when deciding what to do next. Partner webhook pages: * [`verifications.updated`](/api-reference/partners-webhooks/updated) * [`verifications.creation_failed`](/api-reference/partners-webhooks/creation-failed) * [Partner webhook management](/api-reference/partners-webhooks/list-all-webhooks) ## Data sets and receipts Partner implementations can retrieve the accounts, payroll documents, and paystubs associated with supported verifications through the [Partner Data Sets](/api-reference/partners-data-sets/list-all-accounts) endpoints. Use [Partner Receipts](/api-reference/partners-receipts) for receipt retrieval when enabled for the integration. # Verifications Quickstart Source: https://docs.argyle.com/verifications/quickstart Build your first verification workflow. A verification follows five steps: 1. Create or reuse a user. 2. Order a verification. 3. Start a session when the user needs to connect an account. 4. Listen for verification status changes. 5. Retrieve the completed report. This Quickstart uses a payroll `voie` verification as the example. The same lifecycle applies to the other [verification types](/verifications/overview#verification-types). ## Before you begin * Create Sandbox API keys in [Console](https://console.argyle.com/api-keys). * Use the Sandbox base URL: `https://api-sandbox.argyle.com/v2`. * Send API requests from your backend using [HTTP basic authentication](/api-guide/overview#authentication). * Set up [webhook handling](/api-guide/webhooks), then subscribe to the [`verifications.updated`](/api-reference/verifications-webhooks/updated) webhook before testing the complete workflow. ## Create or reuse a user If the person already has an Argyle user with your organization, reuse that user ID across payroll, banking, and document workflows. Otherwise, [create a user](/api-reference/users/create-a-user) and store the returned ID with your internal record. Before adding another product, [update the existing user](/api-reference/users/update-a-user) with any missing details required by that product. Use the same user ID when ordering the verification. Required user details depend on the verification type: | Field | Payroll | Banking | Doc VOI | | - | - | - | - | | `first_name` | Required | Required | Required | | `last_name` | Required | Required | Required | | `ssn` | Not required | Required if `birth_date` is not provided | Required | | `birth_date` | Not required | Required if `ssn` is not provided | Not required | | `address` | Not required | Required | Not required | | `email` | Not required | Required if `phone_number` is not provided | Not required | | `phone_number` | Not required | Required if `email` is not provided | Not required | ```json theme={} { "first_name": "Jane", "last_name": "Doe", "ssn": "000-00-0000", "email": "jane@example.com", "phone_number": "+15555555555", "address": { "city": "New York", "line1": "123 Main St", "line2": null, "state": "NY", "country": "US", "postal_code": "10001" }, "birth_date": { "year": 1990, "month": 1, "day": 13 } } ``` Store the returned user `id`. The user ID is required when ordering the verification. ## Order a verification Use [`POST /v2/verifications`](/api-reference/verifications/order-a-verification). Set `report.type` to the required report type. ```jsonc theme={} { "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69", "configuration": { "notified_recipients": [ "john.doe@mortgage.com" ] }, "report": { "type": "voie" }, "loan": { // Optional "number": "1234", "borrower_id": "ABC789", "application_id": "2121313", "officer_email": "john.doe@mortgage.com" }, "billing": { // Optional "cost_center": "5" } } ``` Store the returned verification `id`. Use the type-specific guides for additional request fields and examples: * [Payroll](/verifications/verification-types/payroll) * [Banking](/verifications/verification-types/banking) * [Doc VOI](/verifications/verification-types/document-voi) For government programs, see [Government Benefits](/verticals/government-benefits). ## Create a session Payroll and banking verifications require a session when the user needs to connect an account. Doc VOI uses [document uploads](/verifications/verification-types/document-voi#upload-documents) instead. The verification must be active. An active verification is not completed or cancelled. ### Embedded session Use [`POST /v2/sessions`](/api-reference/verifications/create-a-session) with the verification ID. Session links expire after one hour. Create another session for the same active verification when a new link is required. The session request depends on whether the user is connecting a payroll or financial account. > [accordion] Payroll request: POST /v2/sessions > > ```json theme={} > { > "verification": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b", > "configuration": { > "redirect_url": "https://your-application.com/return", > "flow_id": "12ABCD3E", > "language": "EN", > "mobile_app": true > } > } > ``` > [accordion] Banking request: POST /v2/sessions > > ```json theme={} > { > "verification": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b", > "configuration": { > "experience": "97f1eccb-241d-4052-8409-fab2dcc489b", > "single_use_url": false, > "redirect_url": "https://your-application.com/return" > } > } > ``` > [accordion] Payroll response > > ```json theme={} > { > "verification": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b", > "configuration": { > "experience": null, > "single_use_url": false, > "redirect_url": "https://your-application.com/return", > "flow_id": "12ABCD3E", > "language": "EN", > "mobile_app": true > }, > "link": "https://connect.argyle.com/?...", > "data_source": "payroll" > } > ``` > [accordion] Banking response > > ```json theme={} > { > "verification": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b", > "configuration": { > "experience": "97f1eccb-241d-4052-8409-fab2dcc489b", > "single_use_url": false, > "redirect_url": "https://your-application.com/return" > }, > "link": "https://connect2.finicity.com?...", > "data_source": "banking" > } > ``` See the [Create a Session endpoint](/api-reference/verifications/create-a-session) for every available request field. ### Invites To create an invite link, use [`POST /v2/sessions`](/api-reference/verifications/create-a-session) and set `type` to `invite`. The user must have at least one active payroll or banking verification. Include `configuration.email`, `configuration.phone_number`, or both to send the invite by email or SMS: ```json theme={} { "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69", "type": "invite", "configuration": { "email": "jane.doe@example.com", "phone_number": "+15555555555" } } ``` To share the link yourself without sending email or SMS, omit both contact fields. You can omit `configuration` entirely when no other invite settings are needed: ```json theme={} { "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69", "type": "invite" } ``` One invite can include one or more active payroll or banking verifications for the same user. Invite links expire after 180 days or when revoked. > [!NOTE] > > For wholesale mortgage implementations, add `external_metadata.broker` to the user and omit `configuration.flow_id` to use the default wholesale flow. A custom flow must be a wholesale flow to override that default. See [Wholesale Mortgage](/verifications/wholesale-mortgage) for setup, flow selection, and notifications. ## Launch an embedded session Use the returned session `link` according to the verification's data source. ### Payroll * Pass `link` as `connectUrl` when initializing the [Web SDK](/link/initialization/web#initialize-with-connecturl) or [Mobile SDKs](/link/initialization/mobile-sdks). * For Hosted Link, open the URL in a browser context. Hosted Link does not provide Link callbacks. ### Banking * Pass `link` as `connectURL` when launching the banking SDK. * Use SDK callbacks for immediate frontend handling and the `verifications.updated` webhook for backend lifecycle tracking. * See [Banking Verifications](/verifications/verification-types/banking#choose-a-session-type) for the SDK example and hosted-session requirements. ## Track status and retrieve the report Listen for the [`verifications.updated`](/api-reference/verifications-webhooks/updated) webhook. When `status.code` is `completed` or `completed_with_errors`, retrieve the report from `report.file_url` or `report.json_url`. Continue with [Verification Statuses](/verifications/verification-statuses). # Re-verification Source: https://docs.argyle.com/verifications/re-verification Request updated verification results. Reuse the existing user when requesting updated results. The next step depends on whether the user's connection is still valid or they need to reconnect or provide new documents. ## Refresh without user action > [!NOTE] > > The refresh endpoint supports payroll, banking, and Doc VOI verifications. It returns a new verification ID and report. Use [`POST /v2/verifications/refresh`](/api-reference/verifications/refresh-a-verification) to create a **new** payroll or banking verification without the user needing to reconnect, as long as a valid connection is still available. For Doc VOI, use the same endpoint with `report.type = doc-voi-mortgage` to generate a new report from the user's existing uploaded documents without uploading additional documents. Track the new verification through [`verifications.updated`](/api-reference/verifications-webhooks/updated) webhooks. Retrieve its report when the status reaches `completed` or `completed_with_errors`. See [Verification Statuses](/verifications/verification-statuses). ## Reconnection required If a previously completed payroll or banking verification needs updated data and the connection is no longer valid, the user must reconnect. The same path applies when the user needs to connect another account. 1. Order a new verification for the existing `user` with [`POST /v2/verifications`](/api-reference/verifications/order-a-verification). 2. Create a [session](/verifications/quickstart#create-a-session) for the new verification. 3. Return the user to [Link for payroll](/verifications/verification-types/payroll#user-experience) or the [banking connection experience](/verifications/verification-types/banking#choose-a-session-type) to complete the required connection steps. 4. Track the new verification's status and retrieve its completed report. > [!NOTE] > > If the verification is still active, create another session for that verification instead. An expired session or a request for MFA does not by itself require a new verification. See [Recovery and Errors](/verifications/recovery-and-errors#session-not-completed). ## Doc VOI with new documents To refresh a Doc VOI report with additional or updated documents, order a new `doc-voi-mortgage` verification for the same `user` with [`POST /v2/verifications`](/api-reference/verifications/order-a-verification). The request shape is the same as a new document verification, including the `employments` requirements. Previously uploaded documents for the user remain available as the baseline for the new verification. After the new verification is created: 1. Upload each net-new document for the same `user` with [`POST /v2/user-uploads`](/api-reference/user-uploads/upload-a-document). 2. Listen for [`verifications.updated`](/api-reference/verifications-webhooks/updated) webhooks as the verification moves through document processing. 3. Retrieve the refreshed report from `report.file_url` or `report.json_url` when the verification is complete. # Recovery and Errors Source: https://docs.argyle.com/verifications/recovery-and-errors Resume incomplete sessions and correct invalid verification requests. Use the verification's current `status.state`, `status.code`, and `status.errors` to decide whether to resume the existing verification or create a new one. ## Choose a recovery action | Status or situation | Action | | - | - | | Active verification; session closed or expired | Create another session for the same verification. | | `connection_attempted` | Review the account connection error and return the user to the active verification. | | `syncing_error` | Create another session so the user can complete MFA or other required action. | | `more_data_required` | Upload the additional Doc VOI documents for the same user. | | `cancelled_by_client` or `argyle_timeout` | The verification cannot be resumed. Create a new verification if another attempt is appropriate. | | `system_error` | Review `status.errors` and contact Argyle Support before retrying. | ## Session not completed If the user closes the connection flow, or the session link expires, retrieve the verification and check its current status. When the verification remains active in `pending` or `user_session_started`, create a new session for the same verification with [`POST /v2/sessions`](/verifications/quickstart#create-a-session). Do not create another verification solely to replace an expired session link. For `connection_attempted` or `syncing_error`, review the current [Account Connection Error](/api-reference/account-connection-errors), correct the issue, and create another session for the same active verification. ## User details missing or invalid If `POST /v2/verifications` returns a 400 response for missing or invalid user details: 1. Update the user with [`PATCH /v2/users/{id}`](/api-reference/users/update-a-user). 2. Retry `POST /v2/verifications`. ## More documents required When a Doc VOI verification enters `more_data_required`, review `status.errors` for the missing information. Upload the additional files for the same user with [`POST /v2/user-uploads`](/api-reference/user-uploads/upload-a-document). Continue listening for the `verifications.updated` webhook as processing resumes. # Reports and Source Documents Source: https://docs.argyle.com/verifications/reports-and-source-documents View report examples and retrieve their supporting files. Source documents are the original paystubs, tax forms, and uploaded files that support a verification. This page shows report examples and how to retrieve completed reports and available source documents. > [!NOTE] > > Report and source-document URLs require [Argyle authentication headers](/api-guide/overview#authentication). Store and deliver these files according to your application retention requirements. ## Retrieve completed reports When a verification reaches `completed` or `completed_with_errors`, the verification resource contains: * `report.file_url` — the report PDF. * `report.json_url` — the report data in JSON format. Follow [Verification Statuses](/verifications/verification-statuses#download-reports-and-json) for the webhook and retrieval flow. ## Retrieve source documents Connected payroll accounts can include paystubs, tax forms, and other source documents. Use the [Payroll Documents](/api-reference/payroll-documents) endpoints to list or retrieve document metadata, then request the returned `file_url` with Argyle authentication headers. Documents uploaded by a user are available through [User Uploads](/api-reference/user-uploads). The upload object also provides an authenticated `file_url` for the source file. ## Example reports > [accordion] Verification of Income and Employment (Payroll VOIE) — PDF and JSON > > [PDF](https://res.cloudinary.com/argyle-media/image/upload/v1749501632/docs-2025/voie_example_argyle.pdf) > > Report PDF > > ![Image of Argyle's Verification of Income and Employment (VOIE) report.](https://mintcdn.com/argyle/QY9l-CtcSx2-TuFM/images/api-ref/reports2/1-voie.png?fit=max\&auto=format\&n=QY9l-CtcSx2-TuFM\&q=85\&s=2abf3c9ca559e53db7bf43dcd5eb2d59) > > The JSON example below shows selected fields. > > [Download complete JSON](/examples/reports/payroll-voie.json) > > ```json theme={} > { > "report_id": "6da4c9a3-2e63-95e5-8be3-f9a52ddc489a", > "type": "voie", > "user_id": "018051aa-f7a9-a0db-2f38-6cfa325e9d69", > "created_at": "2023-03-26T09:20:06.081Z", > "employments": [ > { > "employment": "0186a27d-e5c6-735a-a359-6315b34d544c", > "employer": "Whole Goods", > "status": "active", > "base_pay": { > "amount": "75372.62", > "currency": "USD", > "period": "annual" > }, > "monthly_income": { > "argyle": { > "total": "7102.33", > "base": "6902.55", > "overtime": "165.94", > "bonus": "5.22", > "commission": "28.62", > "other": "0.00" > } > } > } > ] > } > ``` > [accordion] Verification of Income and Employment (Mortgage Payroll VOIE+) — PDF and JSON > > [PDF](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/VOIE_plus.pdf) > > When VOIE+ is enabled for your organization, mortgage VOIE reports include monthly income calculations from Freddie Mac when available. > > Continue to request `voie` through the Verifications API or `voie-mortgage` through the classic Reports API. > > **Report PDF** > > Freddie Mac's monthly income calculations appear in the corresponding employment section. Freddie Mac's Findings Report is appended to the same PDF when available. > > ![Image of a Verification of Income and Employment (Mortgage Payroll VOIE+) report.](https://mintcdn.com/argyle/LBzP1js8YRjtERKs/images/api-ref/reports2/voie-plus.png?fit=max\&auto=format\&n=LBzP1js8YRjtERKs\&q=85\&s=1d4ef33f618b23756bd3710ba5abcb0b) > > **Report JSON** > > Calculations appear under `employments[].monthly_income.aim_check`, with values for `total`, `base`, `overtime`, `bonus`, `commission`, and `other`. > > If all values in `aim_check` are `null`, Freddie Mac did not return a monthly income calculation for that employment. Lender should still proceed to submit through the full Loan Product Advisor (LPA) process for further review. > > The JSON examples below show selected fields. > > [Download complete JSON](/examples/reports/mortgage-payroll-voie-plus.json) > > ```json Report excerpt theme={} > { > "report_id": "cdf4d756-102b-4184-bd07-31f8ee41a2d3", > "type": "voie-mortgage", > "user_id": "01a1225f-5b1b-d05c-af72-eab13af50361", > "created_at": "2026-10-09T20:36:30.960Z", > "employments": [ > { > "employment": "89799b54-f34b-372f-9817-577965f215b3", > "employer": "QuantumByte Solutions", > "status": "active", > "base_pay": { > "amount": "48.08", > "currency": "USD", > "period": "hourly" > }, > "monthly_income": { > "argyle": { > "total": "1432.91", > "base": "1146.19", > "overtime": "164.88", > "bonus": "90.61", > "commission": "31.23", > "other": "0.00" > }, > "aim_check": { > "total": "1585.83", > "base": "1267.25", > "overtime": "183.88", > "bonus": "97.12", > "commission": "37.58", > "other": "0.00" > } > } > } > ] > } > ``` > > ```json aim_check theme={} > { > "employments": [ > { > "monthly_income": { > "aim_check": { > "total": "1585.83", > "base": "1267.25", > "overtime": "183.88", > "bonus": "97.12", > "commission": "37.58", > "other": "0.00" > } > } > } > ] > } > ``` > [accordion] Verification of Income and Employment (Government Payroll VOIE) — PDF and JSON > > [PDF](https://res.cloudinary.com/argyle-media/image/upload/v1783533516/docs-2026/voie-government_example_argyle.pdf) > > ![Image of Argyle's Verification of Income and Employment (Government Payroll VOIE) report.](https://mintcdn.com/argyle/5R0AhShkTxk7hi-c/images/api-ref/reports2/3-voie-government.png?fit=max\&auto=format\&n=5R0AhShkTxk7hi-c\&q=85\&s=604eba494234f57b47221fea88b526c2) > > The JSON example below shows selected fields. > > [Download complete JSON](/examples/reports/government-payroll-voie.json) > > ```json theme={} > { > "report_id": "7a4d2fd6-9c7d-4e0d-a8d3-9e97f54d21f1", > "type": "voie-government", > "user_id": "f83b9d2f-0b3d-4ec9-91d4-82cf9e1c1b2a", > "created_at": "2026-05-20T18:30:00.000Z", > "reporting_period": { > "days": 90, > "start_date": "2026-03-09", > "end_date": "2026-06-07" > }, > "certification": [ > { > "type": "report", > "employment": null, > "status": "certified", > "completed_at": "2026-05-20T18:30:00.000Z", > "user_comment": null > } > ], > "employments": [ > { > "employment": "0186a27d-e5c6-735a-a359-6315b34d544c", > "employer": "Whole Goods", > "income_source_type": "w2", > "certified": true, > "period_summary": [ > { > "period": { > "start_date": "2026-03-09", > "end_date": "2026-06-07" > }, > "currency": "USD", > "gross_pay": "18298.28", > "net_pay": "14065.93", > "hours": "914.75", > "mileage": null, > "paystubs_count": 7, > "trips_count": null > } > ] > } > ] > } > ``` > [accordion] Verification of Employment (Payroll VOE) — PDF and JSON > > [PDF](https://res.cloudinary.com/argyle-media/image/upload/v1746481161/docs-2025/voe_example.pdf) > > Report PDF > > ![Image of Argyle's Verification of Employment (VOE) report.](https://mintcdn.com/argyle/QY9l-CtcSx2-TuFM/images/api-ref/reports2/2-voe.png?fit=max\&auto=format\&n=QY9l-CtcSx2-TuFM\&q=85\&s=6c206b7a1dad09a13ec8d3e9f4ea3008) > > The JSON example below shows selected fields. > > [Download complete JSON](/examples/reports/payroll-voe.json) > > ```json theme={} > { > "report_id": "6c3fa756-2e76-43e1-55f6-e29fc6ae535d", > "type": "voe", > "user_id": "018051aa-f7a9-a0db-2f38-6cfa325e9d69", > "created_at": "2023-03-26T09:19:08.916Z", > "employments": [ > { > "employment": "0186a27d-e5c6-735a-a359-6315b34d544c", > "employer": "Whole Goods", > "status": "active", > "employment_type": "full-time", > "job_title": "Store Manager", > "start_date": "2020-08-28", > "end_date": null, > "last_paystub_date": "2023-03-24" > } > ] > } > ``` > [accordion] Verification of Assets (Banking VOA) — PDF and JSON > > [PDF](https://res.cloudinary.com/argyle-media/image/upload/v1749582203/docs-2025/VOA_Banking_Report.pdf) > > Report PDF > > ![Image of Verification of Assets (VOA) banking report.](https://mintcdn.com/argyle/EtHVUNI_SMseJQur/images/argyle-guides/api-ref/banking-reports/banking-voa.png?fit=max\&auto=format\&n=EtHVUNI_SMseJQur\&q=85\&s=90dfe8c33ce68adc18dd6bd993febceb) > > The JSON example below shows selected fields. > > [Download complete JSON](/examples/reports/banking-voa.json) > > ```json theme={} > { > "id": "m22kz9tzmz3t", > "type": "voa", > "status": "success", > "created_date": "2025-06-10T18:57:22.000Z", > "assets": { > "type": null, > "available_balance": 18349.6, > "current_balance": 22327.3, > "two_month_average": 21995.27, > "six_month_average": null, > "beginning_balance": 20942.02 > }, > "consolidated_available_balance": 18349.6, > "institutions": [ > { > "id": 102168, > "name": "FinBank Profiles - B", > "accounts": [ > { > "id": 8057635035, > "name": "Savings", > "type": "savings", > "balance": 22327.3 > } > ] > } > ] > } > ``` > [accordion] Verification of Assets & Income (Banking VOAI) — PDF and JSON > > [PDF](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/VOAI_Banking_Report.pdf) > > Report PDF > > ![Image of Verification of Assets & Income (VOAI) banking report.](https://mintcdn.com/argyle/ghfim0fZqG69QDy3/images/argyle-guides/api-ref/banking-reports/banking-voai-2026.png?fit=max\&auto=format\&n=ghfim0fZqG69QDy3\&q=85\&s=b518f57c8342a1f77f1752b843cc7b42) > > The JSON example below shows selected fields. > > [Download complete JSON](/examples/reports/banking-voai.json) > > ```json theme={} > { > "id": "q3senvchs15n", > "type": "voaHistory", > "status": "success", > "created_date": "2026-09-16T21:04:48.000Z", > "assets": { > "current_balance": 14911.0, > "two_month_average": 10745.1, > "six_month_average": 9592.05, > "beginning_balance": 38693.34 > }, > "consolidated_available_balance": 14911.0, > "institutions": [ > { > "id": 102105, > "name": "FinBank Profiles - A", > "accounts": [ > { > "id": 9035542498, > "name": "Checking", > "type": "checking", > "balance": 14911.0, > "income_streams": [ > { > "id": "q3senvchs15n1", > "name": "abc", > "status": "ACTIVE", > "confidence": 100, > "cadence": { > "start_date": "2025-09-30T12:00:00.000Z", > "stop_date": null, > "days": 13 > } > } > ] > } > ] > } > ] > } > ``` > [accordion] Verification of Income (Banking VOI) — PDF and JSON > > [PDF](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/VOI_Banking_Report.pdf) > > Report PDF > > ![Image of Verification of Income (VOI) banking report.](https://mintcdn.com/argyle/CvJPgig9j-lpaCnS/images/argyle-guides/api-ref/banking-reports/banking-voi-2026.png?fit=max\&auto=format\&n=CvJPgig9j-lpaCnS\&q=85\&s=41456c3aa6d6c473a3d6cbc3de24e0b5) > > The JSON example below shows selected fields. > > [Download complete JSON](/examples/reports/banking-voi.json) > > ```json theme={} > { > "id": "bdmczjhxc8vj-voi", > "type": "voi", > "status": "success", > "created_date": "2026-09-03T23:03:00.000Z", > "income": [ > { > "confidence_type": "HIGH", > "income_estimate": { > "estimated_gross_annual": 115731, > "net_annual": 81703.67, > "projected_gross_annual": 130005, > "projected_net_annual": 89052.02, > "average_monthly_net": 6808.64, > "average_monthly_gross": 9644.25 > } > } > ] > } > ``` > [accordion] Verification of Employment (Banking VOE) — PDF and JSON > > [PDF](https://res.cloudinary.com/argyle-media/image/upload/v1778709376/docs-2026/VOE_Transactions_Banking_Report.pdf) > > Report PDF > > ![Image of Verification of Employment (Banking VOE) banking report.](https://mintcdn.com/argyle/2zIhWH3AFpQVLqPj/images/argyle-guides/api-ref/banking-reports/banking-voe-transactions.png?fit=max\&auto=format\&n=2zIhWH3AFpQVLqPj\&q=85\&s=b3cf66e31c2bfc6fab6a0c9e32b9b7cb) > > The JSON example below shows selected fields. > > [Download complete JSON](/examples/reports/banking-voe.json) > > ```json theme={} > { > "id": "acbv1wdhitx6-voetransactions", > "type": "voeTransactions", > "status": "success", > "created_date": "2026-05-13T21:53:05.000Z", > "institutions": [ > { > "id": 102168, > "name": "FinBank Profiles - B", > "accounts": [ > { > "id": 9022110214, > "name": "Checking", > "type": "checking", > "income_streams": [ > { > "id": "acbv1wdhitx6-voetransactions1", > "name": "check-cash deposit", > "status": "ACTIVE", > "confidence": 100, > "cadence": { > "start_date": "2024-06-02T12:00:00.000Z", > "stop_date": null, > "days": 16 > }, > "days_since_last_transaction": 0, > "next_expected_transaction_date": "2026-05-29T12:00:00.000Z" > } > ] > } > ] > } > ] > } > ``` > [accordion] Verification of Income (Doc VOI) — PDF and JSON > > [PDF](https://res.cloudinary.com/argyle-media/image/upload/v1778710602/docs-2026/Doc_VOI.pdf) > > Report PDF > > ![Image of Verification of Income (Doc VOI) report.](https://mintcdn.com/argyle/2zIhWH3AFpQVLqPj/images/argyle-guides/api-ref/document-verifications/doc-voi.png?fit=max\&auto=format\&n=2zIhWH3AFpQVLqPj\&q=85\&s=ae1767eb9a4898900142f85c3cbe131e) > > The JSON example below shows selected fields. > > [Download complete JSON](/examples/reports/document-voi.json) > > ```json theme={} > { > "report_id": "02889578-fb0f-4fb5-8ee3-f2d8f3f8116b", > "type": "doc-voi-mortgage", > "user_id": "019e2367-129d-98d2-8ff0-56660fee2c83", > "created_at": "2026-05-13T22:15:55.226Z", > "documents": [ > { > "id": "019e2368-ceb6-102e-7c0f-4e4a957b53de", > "employer": "WAREHOUSE SERVICES INC", > "document_type": "paystubs", > "pay_date": "2026-05-12", > "pay_period_start_date": "2026-04-27", > "pay_period_end_date": "2026-05-12", > "year": null > } > ], > "employments": [ > { > "source": "Doc Upload", > "employer": "WAREHOUSE SERVICES INC", > "status": "active", > "monthly_income": { > "aim_check": { > "total": "6400.32", > "base": "3791.99", > "overtime": "1200.00", > "bonus": "1408.33", > "commission": "0.00", > "other": "0.00" > } > } > } > ] > } > ``` # Testing Source: https://docs.argyle.com/verifications/testing Test each verification type in Sandbox. Start with [Sandbox Testing](/overview/sandbox-testing) for API keys, sample payroll accounts, simulated refreshes, and connection errors. This page adds the product-specific profiles and files used to test payroll, banking, and Doc VOI verifications. ## Payroll test profiles Use Argyle's [sample user credentials](https://docs.argyle.com/overview/sandbox-testing#connect-sample-users) in Link to connect to: * **Sandbox**: any employer or payroll provider * **Production**: `Platformtronic` or `Employertronic` For specific scenario testing, the following sample users are also available: | | Homer Loanseeker | Suzi Builder | Andy Freddie | | - | - | - | - | | Email | homer\_loanseeker\@argyle.com | suzi\_builder\@argyle.com | andy\_freddie\@argyle.com | | Username | homer\_loanseeker | suzi\_builder | andy\_freddie | | Password | passgood | passgood | passgood | | Verification code | 9081 | 9084 | 9088 | | Phone number | (800) 900-0101 | (800) 900-0104 | (800) 900-0108 | | Driver's license # | D1230101 | D1230104 | D1230108 | | **Returns** | **1 active employment** | **2 active employments** | **1 active and 1 terminated employment** | ## Banking test profiles > [!NOTE] > > When you're ready to begin testing, contact your Argyle Customer Success Manager to enable banking permissions. > [!WARNING] > > The Sandbox testing environment for banking supports a maximum of 500 users. To stay within this limit, implement user-management workflows and remove inactive users when they are no longer needed. The following sample test profiles can be connected to: * **Sandbox**: connect to `FinBank Profiles A` or `FinBank Profiles B` * **Production**: connect to `FinBank Billable` or `FinBank Oauth Billable` | Username | Password | Account types | Supported products | | - | - | - | - | | profile\_02 | profile\_02 | Savings, IRA, 401k, Credit Card | `voa`, `voi`, `voai` | | profile\_03 | profile\_03 | Checking, Personal Investment, 401K, Roth, Savings (Joint Account owners) | `voa`, `voi`, `voai` | | profile\_04 | profile\_04 | Checking, 403B, 529, Rollover, Mortgage | `voa`, `voi`, `voai` | | profile\_05 | profile\_05 | Checking, Investment, Stocks, UGMA, UTMA (Joint Account owners) | `voa`, `voi`, `voai` | | profile\_06 | profile\_06 | Checking, Retirement, KEOGH, 457, Credit Card | `voa`, `voi`, `voai` | | profile\_07 | profile\_07 | Checking, Stocks, CD, Investment Tax-Deferred, Employee Stock | `voa`, `voi`, `voai` | | profile\_08 | profile\_08 | Checking, Primary Savings, Money Market, 401A, Line of credit | `voa`, `voi`, `voai` | | profile\_09 | profile\_09 | Checking, Savings, Checking failed report. Errors include `102`, `103`, `185`. | `voa`, `voi`, `voai` *(failed report)* | For specific scenario testing, the following sample users are also available: | | Sue Wealthy | River Paycheck | Alex Student | | - | - | - | - | | Username | sue\_wealthy | river\_paycheck | alex\_student | | Password | profile\_700 | profile\_703 | profile\_704 | | Description | Sue is working as a Product Manager with a good steady income, a mortgage, and multiple investment accounts. She has a loan account and leases a car. Sue travels a few times a year. She has typical expenses like groceries, clothes, entertainment, gym membership, car expenses, and she has a pet. | River works in construction. He rents an apartment and has typical expenses like groceries, clothes, entertainment, household and car expenses. He has some savings but no investments, no loans and no credit cards. In some months, River's expenses exceed his income. | Alex is working full-time with a good salary but she is still paying off her student loan. She makes regular monthly repayments, but she still has over \$30,000 to pay off. Alex has typical expenses like groceries, clothes, entertainment, household, and car expenses. She has limited savings and she has started an investment account. | ## Doc VOI test documents > [!NOTE] > > When you're ready to begin testing, contact your Argyle Customer Success Manager to enable document permissions. Use the sample documents below for Doc VOI verifications. For all scenarios below, order a document verification with the following `employments` value: ```json theme={} "employments": [ { "employer": "Warehouse Services Inc", "status": "active", "hire_date": "2023-02-01", "termination_date": null } ] ``` > [!WARNING] > > Do not adjust file names. > [tab] Sandbox > > > [accordion] GSE-eligible monthly income > > > > Upload the following documents: > > > > * [Warehouse\_Services\_Inc\_paystub.pdf](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/Warehouse_Services_Inc_paystub.pdf) > > * [Warehouse\_Services\_Inc\_paystub\_2025.pdf](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/Warehouse_Services_Inc_paystub_2025.pdf) > > * [Warehouse\_Services\_Inc\_paystub\_2024.pdf](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/Warehouse_Services_Inc_paystub_2024.pdf) > > > [accordion] Not GSE-eligible monthly income > > > > Upload the following documents: > > > > * [Warehouse\_Services\_Inc\_paystub\_ineligible.pdf](https://res.cloudinary.com/argyle-media/image/upload/docs-2025/Warehouse_Services_Inc_paystub_ineligible.pdf) > > * [Warehouse\_Services\_Inc\_paystub\_2025.pdf](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/Warehouse_Services_Inc_paystub_2025.pdf) > > * [Warehouse\_Services\_Inc\_paystub\_2024.pdf](https://res.cloudinary.com/argyle-media/image/upload/docs-2025/Warehouse_Services_Inc_paystub_2024.pdf) > > > [accordion] Requires more data > > > > Upload only the following document: > > > > * [Warehouse\_Services\_Inc\_paystub.pdf](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/Warehouse_Services_Inc_paystub.pdf) > [tab] Production > > > [!NOTE] > > > > Production testing can be done with real documents. If needed, use the sample files below. > > > [accordion] GSE-eligible monthly income > > > > Upload the following documents: > > > > * [sandbox\_Warehouse\_Services\_Inc\_paystub.pdf](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/sandbox_Warehouse_Services_Inc_paystub.pdf) > > * [sandbox\_Warehouse\_Services\_Inc\_paystub\_2025.pdf](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/sandbox_Warehouse_Services_Inc_paystub_2025.pdf) > > * [sandbox\_Warehouse\_Services\_Inc\_paystub\_2024.pdf](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/sandbox_Warehouse_Services_Inc_paystub_2024.pdf) > > > [accordion] Not GSE-eligible monthly income > > > > Upload the following documents: > > > > * [sandbox\_Warehouse\_Services\_Inc\_paystub\_ineligible.pdf](https://res.cloudinary.com/argyle-media/image/upload/docs-2025/sandbox_Warehouse_Services_Inc_paystub_ineligible.pdf) > > * [sandbox\_Warehouse\_Services\_Inc\_paystub\_2025.pdf](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/sandbox_Warehouse_Services_Inc_paystub_2025.pdf) > > * [sandbox\_Warehouse\_Services\_Inc\_paystub\_2024.pdf](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/sandbox_Warehouse_Services_Inc_paystub_2024.pdf) > > > [accordion] Requires more data > > > > Upload only the following document: > > > > * [sandbox\_Warehouse\_Services\_Inc\_paystub.pdf](https://res.cloudinary.com/argyle-media/image/upload/docs-2026/sandbox_Warehouse_Services_Inc_paystub.pdf) # Verification Statuses Source: https://docs.argyle.com/verifications/verification-statuses Track verification status changes and retrieve completed report results. Use verification webhooks as the source of truth for backend lifecycle tracking. SDK callbacks can update the immediate frontend experience, but they do not replace verification status updates. ## Subscribe to webhooks Subscribe to the [`verifications.updated`](/api-reference/verifications-webhooks/updated) webhook to track lifecycle events. > [!NOTE] > > Set `config.include_resource = true` so the webhook payload contains the full verification object inside `data.resource`. The most common verification `status.code` values are: | Status code | Meaning | | - | - | | `pending` | Verification created; user action may still be required. | | `user_session_started` | User opened the connection flow. | | `authenticated` | User authenticated and processing has started. | | `awaiting_certification` | Government verification is waiting for applicant self-certification. | | `documents_processing` | Uploaded documents are processing. | | `report_generating` | The report is generating. | | `completed` | The report is ready to retrieve. | | `completed_with_errors` | The report is ready, but contains limitations or deficiencies. | These are the primary lifecycle updates. See [`status`](/api-reference/verifications/retrieve-a-verification#response-status) for all state transitions and their meanings. ## Download reports and JSON When `status.code` is `completed` or `completed_with_errors`, the `report` object contains: * `file_url` — PDF report * `json_url` — report in JSON format > [accordion] Example webhook > > ```json theme={} > { > "event": "verifications.updated", > "name": "name-for-the-webhook-subscription", > "data": { > "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69", > "verification": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b", > "resource": { > "id": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b", > "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69", > "created_at": "2023-03-09T16:22:06.081Z", > "updated_at": "2023-03-09T16:22:06.081Z", > "channel": "api", > "status": { > "state": "COMPLETED", > "code": "completed", > "errors": [] > }, > "report": { > "id": "2a14ce6f-3aed-4c15-8ea2-92a17b6edb95", > "type": "doc-voi-mortgage", > "file_url": "www.argyle.com/storagename/pdf", > "json_url": "www.argyle.com/storagename/json" > }, > "employments": [ > { > "employer": "Starbucks", > "status": "active", > "hire_date": "2015-08-28", > "termination_date": null > } > ], > "loan": { > "number": "1234", > "borrower_id": "ABC789", > "application_id": "2121313", > "officer_email": "john.doe@mortgage.com" > }, > "billing": { > "cost_center": "5" > }, > "data_source": "documents" > } > } > } > ``` GET requests to `file_url` and `json_url` require [Argyle authentication headers](/api-guide/overview#authentication). # Banking Verifications Source: https://docs.argyle.com/verifications/verification-types/banking Order asset, income, and transaction reports from financial accounts. Use a banking verification when the user will connect financial accounts and share the information required for an asset, income, or transaction report. ## Create or re-use a user If the person already has an Argyle user with your organization, reuse that user ID across payroll, banking, and document workflows. [Update the existing user](/api-reference/users/update-a-user) with any missing banking details before ordering the verification. Banking verifications require: * `first_name` and `last_name`. * `address`. * Either `ssn` or `birth_date`. * Either `email` or `phone_number`. For a new user, send the following body to [`POST /v2/users`](/api-reference/users/create-a-user). This example uses `birth_date` and `email`. ```json theme={} { "first_name": "Jane", "last_name": "Doe", "email": "jane@example.com", "address": { "city": "New York", "line1": "123 Main St", "state": "NY", "country": "US", "postal_code": "10001" }, "birth_date": { "year": 1990, "month": 1, "day": 13 } } ``` Store the returned user `id` and use it as `user` when ordering the verification below. ## Order a banking verification * `voa` — Verification of Assets. * `voai` — Verification of Assets and Income. * `voi` — Verification of Income. * `voe-transactions` — Verification of Employment based on transaction data. Send the following body to [`POST /v2/verifications`](/api-reference/verifications/order-a-verification). Select the report type in `report.type`. The optional `report.configuration` object can define the history start date, income confidence threshold, and report custom fields. ```json theme={} { "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69", "report": { "type": "voai", "configuration": { "from_date": "2024-01-01T00:00:00Z", "income_stream_confidence_minimum": 50, "report_custom_fields": [ { "label": "loanID", "value": "12345", "shown": true } ] } } } ``` ## Choose a session type After ordering the verification, create an embedded session, send an invite, or create an invite link. ![A user connects financial accounts for a banking verification.](https://mintcdn.com/argyle/EtHVUNI_SMseJQur/images/argyle-guides/api-ref/banking-reports/1-banking.png?fit=max\&auto=format\&n=EtHVUNI_SMseJQur\&q=85\&s=e3e171f6dad5485eae24082b36fa81a9) ### Embedded banking Create a session with [`POST /v2/sessions`](/api-reference/verifications/create-a-session), then pass the returned session `link` to the banking SDK as `connectURL`. > [accordion] Banking SDK example > > ```html theme={} >
> > > ``` Use SDK callbacks for immediate frontend handling. Subscribe to the [`verifications.updated`](/api-reference/verifications-webhooks/updated) webhook for backend lifecycle tracking. For SDK installation and configuration options, see the [banking SDK documentation](https://developer.mastercard.com/open-finance-us/documentation/connect/integrating/sdk/web-sdk/sdk/). ### Invites Create an invite session with `type = invite` and the user ID. Include `configuration.email`, `configuration.phone_number`, or both to send the invite by email or SMS. Omit both to share the returned `link` yourself. The user must have an active banking verification. The invitation opens a hosted connection flow, so no frontend SDK initialization is required. > [!NOTE] > > Banking invites and other hosted or no-SDK banking paths must be enabled by Argyle before use. Contact your Argyle Customer Success Manager before using one of these paths. See the [Quickstart invite example](/verifications/quickstart#invites). ## Result Wait for the [`verifications.updated`](/api-reference/verifications-webhooks/updated) webhook. When the verification reaches `completed` or `completed_with_errors`, retrieve the report from `report.file_url` or `report.json_url`. * See [Verification Statuses](/verifications/verification-statuses). * Review the [banking report examples](/verifications/reports-and-source-documents#banking-voa). * Use the [banking test profiles](/verifications/testing#banking-test-profiles). # Doc VOI Source: https://docs.argyle.com/verifications/verification-types/document-voi Order a mortgage income report from uploaded documents. Doc VOI uses paystubs and year-end income documents to support mortgage income calculations when a direct payroll connection is not used. > [!NOTE] > > Doc VOI is designed for mortgage workflows. For standalone document collection, OCR, and authenticity, use [Document Uploads](/workflows/document-processing). ## Create or re-use a user If the person already has an Argyle user with your organization, reuse that user ID across payroll, banking, and document workflows. [Update the existing user](/api-reference/users/update-a-user) with any missing details before ordering Doc VOI. The required fields are `first_name`, `last_name`, and `ssn`. For a new user, send the following body to [`POST /v2/users`](/api-reference/users/create-a-user): ```json theme={} { "first_name": "Jane", "last_name": "Doe", "ssn": "000-00-0000" } ``` Store the returned user `id`. Use the same ID when ordering the verification and uploading its documents. ## Order a Doc VOI verification Send the following body to [`POST /v2/verifications`](/api-reference/verifications/order-a-verification). Set `report.type` to `doc-voi-mortgage` and include the employment details represented by the documents. ```json theme={} { "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69", "employments": [ { "employer": "Warehouse Services Inc", "status": "active", "hire_date": "2023-02-01", "termination_date": null } ], "report": { "type": "doc-voi-mortgage" } } ``` ## Required documents For each employment, provide: * The most recent paystub. * A W-2 or December/year-end paystub for each required prior year. The employment names and dates in the verification order should match the uploaded documents. The required history can vary by employment and mortgage workflow. If the verification enters `more_data_required`, upload the additional requested documents for the same user. ## Upload documents After ordering the verification, upload each document for the same user through [`POST /v2/user-uploads`](/api-reference/user-uploads/upload-a-document). A Doc VOI verification does not require a payroll or banking session. ![Doc VOI report PDF.](https://mintcdn.com/argyle/EtHVUNI_SMseJQur/images/argyle-guides/api-ref/document-verifications/1-documents.png?fit=max\&auto=format\&n=EtHVUNI_SMseJQur\&q=85\&s=47c994109741c21d13bfa75c60a90cb5) ## Result Wait for the [`verifications.updated`](/api-reference/verifications-webhooks/updated) webhook while documents are processed and the report is generated. Retrieve the completed report from `report.file_url` or `report.json_url`. * See [Verification Statuses](/verifications/verification-statuses). * Follow [Doc VOI re-verification](/verifications/re-verification#doc-voi-with-new-documents) when updated documents are required. * Use the [Doc VOI test files](/verifications/testing#doc-voi-test-documents). # Payroll Verifications Source: https://docs.argyle.com/verifications/verification-types/payroll Order income and employment reports from payroll accounts. Use a payroll verification when the user will connect an employer or payroll-provider account and share income or employment information straight from the source. > [!NOTE] > > For tenant screening or other workflows that need individual payroll records and your own income calculations, use [Data APIs](/data-apis/overview). Compare [Verifications vs. Data APIs](/overview/verifications-vs-data-apis) before ordering a payroll report. ## Create or re-use a user If the person already has an Argyle user with your organization, reuse that user ID across payroll, banking, and document workflows. [Update the existing user](/api-reference/users/update-a-user) if either `first_name` or `last_name` is missing; both are required for payroll verifications. For a new user, send the following body to [`POST /v2/users`](/api-reference/users/create-a-user): ```json theme={} { "first_name": "Jane", "last_name": "Doe" } ``` Store the returned user `id` and use it as `user` when ordering the verification below. ## Order a payroll verification * `voie` — Verification of Income and Employment. * `voe` — Verification of Employment. Send the following body to [`POST /v2/verifications`](/api-reference/verifications/order-a-verification), using the required type in `report.type`: ```json theme={} { "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69", "report": { "type": "voie" } } ``` ## Government payroll `voie-government` is a payroll report type for government benefits workflows. The workflow can include applicant self-certification and other program-specific steps. See [Government Benefits](/verticals/government-benefits). ## User experience [Create an embedded or invite session](/verifications/quickstart#create-a-session) after ordering the verification. The user opens Link, finds each relevant employer or payroll provider, and connects the corresponding account. ![Link is where payroll accounts are connected through Argyle.](https://mintcdn.com/argyle/zs6lb-w1jQV9DVbr/images/overview/how-argyle-works/2-how-argyle-works.png?fit=max\&auto=format\&n=zs6lb-w1jQV9DVbr\&q=85\&s=c9423cb37168de456ad6b65dce23efa6) Use the returned session `link` with the [Web SDK](/link/initialization/web#initialize-with-connecturl), [Mobile SDKs](/link/initialization/mobile-sdks), or [Hosted Link](/link/initialization/hosted-link). ## Result Wait for the [`verifications.updated`](/api-reference/verifications-webhooks/updated) webhook. When the verification reaches `completed` or `completed_with_errors`, retrieve the report from `report.file_url` or `report.json_url`. * See [Verification Statuses](/verifications/verification-statuses). * Review the [Payroll VOIE example](/verifications/reports-and-source-documents#payroll-voie). * Use the [payroll test profiles](/verifications/testing#payroll-test-profiles) in Sandbox. # Wholesale Mortgage Source: https://docs.argyle.com/verifications/wholesale-mortgage Send broker-branded borrower invites through the Verifications API. Wholesale lenders can use the Verifications API to send borrower invites that display the mortgage broker's name and contact details. Borrowers use Argyle to share their income, employment, and asset information with the lender. The lender's application manages the broker's ordering workflow. For ordering through Encompass, see [TPO Connect](/integrations/pos-los/encompass/tpo-connect). ## Before you begin * Follow the [Quickstart](/verifications/quickstart) for authentication and verification setup. * The wholesale lender's Argyle account must be configured for the Mortgage industry. Contact your Customer Success Manager if you need help with this setting. * Associate users and verifications with the lender. Broker details customize the borrower experience; brokers do not need separate Argyle accounts or API keys. ## Add broker details to the borrower When you [create a user](/api-reference/users/create-a-user), include `external_metadata.broker`. For an existing borrower, [update the user](/api-reference/users/update-a-user) before creating the invite. ```json theme={} { "first_name": "John", "last_name": "Smith", "email": "john.smith@example.com", "external_metadata": { "broker": { "name": "Jane Diaz", "company_name": "Acme Mortgage", "email": "jane.diaz@example.com", "phone_number": "+14165551234", "nmls": "1234567" } } } ``` When adding a broker, `name` is required. `company_name`, `email`, `phone_number`, and `nmls` are optional. Use E.164 international format for the phone number. Missing contact details are omitted from the borrower-facing contact card. > [!NOTE] > > `company_name` supplies the `[Broker_company]` variable in [custom wholesale templates](/console/flows/email-sms-templates#wholesale-mortgage-templates). Keep using the same borrower user ID for subsequent verifications. Broker details are stored on the user, so they do not need to be supplied with each verification or invite. Include the additional [user details required by the verification type](/verifications/quickstart#create-or-reuse-a-user), such as an address for banking verifications. ## Order verifications and send an invite 1. [Order a verification](/api-reference/verifications/order-a-verification) for each required payroll or banking report. For wholesale loans, set `loan.division` to `wholesale` when ordering each verification. 2. To receive progress emails, set `configuration.notified_recipients` on each verification. Include the broker and any lender recipients who need updates. If this field is omitted, no verification progress emails are sent. 3. [Create a session](/api-reference/verifications/create-a-session) with `type: invite` and the borrower user ID. Include `configuration.email`, `configuration.phone_number`, or both to send the invite by email or SMS. Omit both to share the returned `link` yourself. ```json theme={} { "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69", "type": "invite", "configuration": { "email": "john.smith@example.com", "reply_to": "jane.diaz@example.com" } } ``` The user must have at least one active payroll or banking verification. One invite can include multiple active verifications for the same borrower. `configuration.reply_to` controls where replies to the borrower invite go. It is separate from `configuration.notified_recipients` on the verification, which controls progress notifications. Adding broker contact details does not subscribe the broker or lender to those notifications. For document-based income verification, follow the [Doc VOI workflow](/verifications/verification-types/document-voi). Doc VOI orders do not use an invite session. ## Choose the invite flow For Mortgage accounts, broker details determine whether the invite uses a wholesale or retail flow. Omit `configuration.flow_id` to use the matching default, or provide a custom flow created for that experience. | Broker details on the user | Provided flow | Flow used | | - | - | - | | Present | None | Default wholesale flow | | Present | Wholesale | Provided wholesale flow | | Present | Retail | Default wholesale flow | | Absent | None | Default retail flow | | Absent | Retail | Provided retail flow | | Absent | Wholesale | Default retail flow | Use separate custom flows for retail and wholesale. To customize wholesale messaging, ask your Customer Success Manager to enable wholesale flow creation, then create a [Mortgage Wholesale email/SMS template](/console/flows/email-sms-templates#wholesale-mortgage-templates). A custom flow is not required to use the default wholesale experience. ## Borrower experience ![A broker-branded email invitation opens a landing page where the borrower can connect payroll and bank accounts.](https://mintcdn.com/argyle/GL0Jr7nNNug7xalW/images/verifications/wholesale-borrower-experience.png?fit=max\&auto=format\&n=GL0Jr7nNNug7xalW\&q=85\&s=4d5415a06886b50c73783d76c21547ad) * The invite email, SMS, and landing page identify the broker. The default email sender name is `[Broker_name] via Argyle`. * The email and landing page show the broker's available contact details. * The lender remains named in the email footer and consent and data-sharing screens. Argyle Link and the banking connection experience may also display lender branding. * Subsequent invites for the same borrower retain the broker context, including when re-verification requires borrower action. Wholesale emails use the lender's [custom sender domain](/console/management/custom-sender-domain), when configured, or `notifications@argyle.com`. # Verticals Source: https://docs.argyle.com/verticals Explore implementations for specific industries and programs. > [card] [Mortgage](/verticals/mortgage) > > Order payroll, banking, and Doc VOI throughout the mortgage lifecycle. > [card] [Tenant Screening](/verticals/tenant-screening) > > Retrieve the income and employment data required for tenant screening. > [card] [Government Benefits](/verticals/government-benefits) > > Combine payroll, banking, and applicant-certified data in benefits workflows. > [card] [Personal Lending](/verticals/personal-lending) > > Use recent payroll and banking data in personal lending workflows. > [card] [Background Check](/verticals/background-check) > > Retrieve employment records for pre-employment and background checks. > [card] [Gig and Workforce](/verticals/gig-and-workforce) > > Process gig, shift, vehicle, rating, and pay data as it becomes available. > [card] [Custom Workflows](/verticals/custom-workflows) > > Choose the data you need, how users share it, and when your application can proceed. # Background Check Source: https://docs.argyle.com/verticals/background-check Retrieve applicant-shared employment records for a background check. Background-check implementations most often use the Data APIs to retrieve employment records applicants share from their payroll accounts. Start with Identities, then add paystubs or source documents only when the check also requires income evidence. ## Define the employment request Decide whether the check requires: * The applicant's current employer, prior employers, or both. * One connected account or multiple accounts covering the required employment history. * Identity and employment fields only, or supporting paystubs and payroll documents. * An embedded experience in your applicant portal or an email/SMS invitation. ## Choose the applicant experience > [card] [Embedded Link](/link/initialization/overview) > > Launch Link where applicants already provide employment information. > [card] [Email or SMS](/console/flows/email-sms-templates) > > Send a hosted Link invitation when the applicant completes the request outside your application. Create one Argyle [user](/api-reference/users/create-a-user) for the applicant and retain the ID. Use [`external_id`](/overview/data-structure/users#external-identifiers) for an application or candidate identifier you need to query later. Keep the same user when the applicant returns or connects another employer. ## Readiness Use the event that matches the completeness required by the check: * The [`accounts.connected`](/api-reference/accounts-webhooks/connected) webhook confirms that an account connection succeeded, but does not mean employment data is ready. * The [`identities.added`](/api-reference/identities-webhooks/added) webhook lets you retrieve an identity as soon as it is created. Continue processing identity updates when fields change. * The [`users.fully_synced`](/api-reference/users-webhooks/fully-synced) webhook indicates that initial delivery finished for every newly connected payroll account. Use it when the check must wait for all available employment records. Track every account separately. An applicant can successfully share one employment source while another account fails or requires action. ## Retrieve employment records * Use [Identities](/api-reference/identities) for employer name, employment status, job title, pay details, and hire or termination dates. * Use [Employments](/overview/data-structure/employments) to match identities with supporting paystubs and payroll documents for the same job. * Add [Paystubs](/api-reference/paystubs) and [Payroll Documents](/api-reference/payroll-documents) when the check requires income or source-document support. Query by user to assemble the applicant's records, or by account to retrieve records from one connection. An account can contain data from more than one employment. Use the `employment` filter when you only need records for a specific employment, or retrieve all records and match them afterward to retain unmatched paystubs. ## Exceptions and fallback Subscribe to the [`accounts.failed`](/api-reference/accounts-webhooks/failed) webhook and the [`accounts.updated`](/api-reference/accounts-webhooks/updated) webhook with `config.include_resource = true` so your system can distinguish an incomplete request from a connection that needs applicant action. * Let applicants connect another account when employment history spans more than one source. * Return the existing user to [Reconnect an Account](/workflows/reconnecting-accounts) when a previously connected account requires action. * Offer [Document Uploads](/workflows/document-processing) when your process accepts documents after an employer cannot be found or connected. See [Data Delivery and Readiness](/overview/data-delivery) for the complete synchronization model. # Custom Workflows Source: https://docs.argyle.com/verticals/custom-workflows Choose the data you need, how users share it, and when your application can proceed. Use this guide when your application needs a different combination of products or data than the other vertical guides describe. Decide what information you need and how users will share it, then choose the guides and endpoints for your implementation. ## Choose the implementation path > [card] [Verifications](/verifications/overview) > > Order a report, track its status, and retrieve the completed result. > [card] [Data APIs](/data-apis/overview) > > Retrieve records to use in your own calculations or review process. ## Define the workflow Before implementing, identify: | Decision | Questions to answer | | - | - | | Entry point | Will users connect inside your application, through an email/SMS invite, or through direct login to a known source? | | Account scope | Can one account satisfy the request, or must the user connect every relevant income source? | | Data scope | Which [data sets](/overview/data-structure/data-sets), report types, and history windows are required? | | Readiness | Can processing begin from one resource event or partial history, or must the workflow wait for all initial data? | | Fallback | What happens when a source cannot be found, authentication fails, or the required data does not arrive? | | Return experience | Does the workflow need reconnection, updated data, additional documents, or another report later? | ## Implementation checklist 1. Create one Argyle [user](/api-reference/users) and retain the ID for the entire workflow. 2. Choose a [Link account-connection experience](/workflows/account-connections), a hosted invitation, or a verification session. 3. Store every returned [account](/api-reference/accounts) ID and track account status independently. 4. Subscribe to the account, resource, and synchronization webhooks that prove your required data is ready. 5. Retrieve records through the relevant list endpoints, follow pagination, and retain resource IDs for later updates. 6. Add an application-level timeout and a clear path for connection errors or incomplete data. 7. Handle [Document Uploads](/workflows/document-processing), [reconnections](/workflows/reconnecting-accounts), and [ongoing refresh](/overview/ongoing-refresh) when the workflow requires them. 8. Delete users or accounts when your application no longer needs them, according to your retention requirements. Test success, multiple-account, incomplete-data, reconnection, and fallback scenarios in [Sandbox](/overview/sandbox-testing). Use [Data Delivery and Readiness](/overview/data-delivery) to select the correct synchronization events and the [API Reference overview](/api-reference/overview) to select the endpoint family. # Gig and Workforce Source: https://docs.argyle.com/verticals/gig-and-workforce Process gig, shift, vehicle, rating, and pay data from connected accounts. Use the Data APIs to retrieve gig, shift, and pay records from accounts workers connect. Decide which records and how much history you need before choosing the webhooks to subscribe to. ## Define the data you need Choose only the resources your application needs: * [Gigs](/api-reference/gigs) and [Shifts](/api-reference/shifts) for work completed, payments, and scheduled shifts. * [Identities](/api-reference/identities), [Paystubs](/api-reference/paystubs), [Payroll Documents](/api-reference/payroll-documents), and [Deposit Destinations](/api-reference/deposit-destinations) for worker and payment records. * [Vehicles](/api-reference/vehicles) and [Ratings](/api-reference/ratings) when those resources are available from the connected source. Resource availability and history vary by source. Check [Items](/api-reference/items) for the supported data sets and refresh behavior instead of assuming every connected account returns the same records. ## Connect worker accounts 1. Create a [user](/api-reference/users/create-a-user) and retain the ID in your system. 2. Launch [Link](/link/initialization/overview). Use [direct login](/workflows/account-connections#direct-login) when the application already knows the platform the worker needs to connect. 3. Let the worker connect every account required by the workflow. 4. Store and monitor each [account](/api-reference/accounts) independently. ## Choose a readiness window Do not wait for complete account history when a recent window is sufficient: * The [`gigs.partially_synced`](/api-reference/gigs-webhooks/partially-synced) webhook indicates that Gigs are available through the configured number of days for one newly connected account. * The [`shifts.partially_synced`](/api-reference/shifts-webhooks/partially-synced) webhook provides the same control for Shifts. * Use the corresponding fully-synced event when all available records for that resource are required. * Use the [`users.fully_synced`](/api-reference/users-webhooks/fully-synced) webhook only when processing must wait for initial delivery from every newly connected payroll account. Partial- and fully-synced events apply to initial delivery. Reconnection and ongoing updates use account and resource events instead. ## Process the event stream Retrieve records through paginated list endpoints and process `.added`, `.updated`, and, where available, `.removed` events for the resources your application stores. Keep resource IDs so later events update or remove the correct record. Subscribe to the [`accounts.updated`](/api-reference/accounts-webhooks/updated) webhook with `config.include_resource = true` and the [`accounts.removed`](/api-reference/accounts-webhooks/removed) webhook to track the connection lifecycle. Return the existing user to [Reconnect an Account](/workflows/reconnecting-accounts) when the worker needs to reauthenticate. See [Data Delivery and Readiness](/overview/data-delivery) for initial synchronization and [Ongoing Refresh](/overview/ongoing-refresh) for new records after the initial delivery. # Government Benefits Source: https://docs.argyle.com/verticals/government-benefits Use payroll, banking, and applicant-certified data in government benefits workflows. Government benefits programs can use payroll records, banking reports, or a standardized government payroll report. Reuse the same Argyle user when an applicant completes more than one path. ## Choose the program inputs > [card] [Payroll Data APIs](/data-apis/overview) > > Retrieve identities, paystubs, and payroll documents for program-specific rules. > [card] [Banking](/verifications/verification-types/banking) > > Order income, asset, or transaction reports from financial accounts applicants connect. > [card] [Government Report](#government-report) > > Generate a payroll income report with optional applicant self-certification. ## Shared workflow 1. Create or reuse an Argyle [user](/overview/data-structure/users) for the applicant and retain the ID with the case record. 2. Start the appropriate payroll or banking connection, or order the government report. 3. Let the applicant connect every account needed for the program determination. 4. Track Data API readiness with account and resource webhooks. Track report-based requests with the [`verifications.updated`](/api-reference/verifications-webhooks/updated) webhook. 5. Retrieve the records or completed reports required by your eligibility system. ## Payroll data For program-specific calculations, retrieve the underlying records directly: * [Identities](/api-reference/identities) for employer and employment information. * [Paystubs](/api-reference/paystubs) for earnings, deductions, taxes, and pay-period data. * [Payroll Documents](/api-reference/payroll-documents) for source documents available from connected accounts. Use the [`paystubs.partially_synced`](/api-reference/paystubs-webhooks/partially-synced) webhook when the program needs a defined history window. Use the [`users.fully_synced`](/api-reference/users-webhooks/fully-synced) webhook only when the workflow must wait for all initial data from every newly connected payroll account. ## Banking Banking uses the same user but a separate verification and session. Choose the banking report type required by the program, listen for verification status changes, and retrieve the completed PDF or JSON from the verification resource. ## Government report Set `report.type` to `voie-government` when [ordering the verification](/api-reference/verifications/order-a-verification). Applicant self-certification is enabled by default in the standard workflow. Set `report.self_certification` to `false` when applicant review and confirmation are not required. ```json theme={} { "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69", "report": { "type": "voie-government", "self_certification": true } } ``` ![Applicant self-certification flow for a government payroll report.](https://mintcdn.com/argyle/nqG2n0cnn6j5JMl3/images/argyle-guides/api-ref/reports2/3-government-overview.png?fit=max\&auto=format\&n=nqG2n0cnn6j5JMl3\&q=85\&s=2cbacc7699b77539a08c70257d5c55de) When self-certification is enabled, the verification can enter `awaiting_certification` after the applicant connects the required accounts. The applicant reviews the available income information in Link before submitting it. ## Exceptions and returning applicants * Track each payroll account separately so one incomplete connection does not hide records available from another. * Monitor the [`accounts.updated`](/api-reference/accounts-webhooks/updated) webhook for connections that require applicant action. * Return the existing user to [Reconnect an Account](/workflows/reconnecting-accounts) rather than creating another case identity. * Add [Document Uploads](/workflows/document-processing) when the program accepts documents as an alternate source. See [Data Delivery and Readiness](/overview/data-delivery) for direct payroll data, [Verification Statuses](/verifications/verification-statuses) for report-based requests, and the [Government VOIE example](/verifications/reports-and-source-documents#government-voie) for the report structure. # Mortgage Source: https://docs.argyle.com/verticals/mortgage Implement payroll, banking, and Doc VOI across the mortgage lifecycle. Mortgage implementations use Verifications to order payroll, banking, and Doc VOI products through one lifecycle. The same user can complete multiple verification types as a loan moves from application through closing. ## Choose verification products > [card] [Payroll](/verifications/verification-types/payroll) > > Use payroll data borrowers share for income and employment reports. > [card] [Banking](/verifications/verification-types/banking) > > Use banking data borrowers share for asset, income, and transaction reports. > [card] [Doc VOI](/verifications/verification-types/document-voi) > > Use documents borrowers upload for mortgage income reports. ## Implementation workflow **1. Create or reuse the borrower** Maintain one Argyle [user](/overview/data-structure/users) for each borrower. Store the user ID with your application or loan record, and use [`external_id`](/overview/data-structure/users#external-identifiers) when you need to find the borrower by an identifier from your system. **2. Order each verification** Create a [verification](/api-reference/verifications/order-a-verification) for each required report type. Provide the user details required by that product before placing the order. **3. Start the borrower experience** Create a [session](/api-reference/verifications/create-a-session) when the borrower needs to connect a payroll or bank account or upload documents. Launch the returned URL through the appropriate embedded or hosted experience. **4. Track the lifecycle** Subscribe to the [`verifications.updated`](/api-reference/verifications-webhooks/updated) webhook with `config.include_resource = true`. Use verification status for backend decisions; Link callbacks are for the immediate frontend experience. **5. Retrieve the result** When the verification reaches `completed` or `completed_with_errors`, download the PDF or JSON from the authenticated URLs in the verification resource. ## Wholesale mortgage Wholesale lenders can offer broker-branded borrower invites through the Verifications API or Encompass TPO Connect. The broker's name and contact details appear in the invite and landing page, while the lender remains the Argyle account holder. * [Verifications API](/verifications/wholesale-mortgage): Add broker details to the borrower and send an invite using a wholesale flow. * [Encompass TPO Connect](/integrations/pos-los/encompass/tpo-connect): Enable broker ordering with the lender's credentials and configure manual or automated orders. ## Returning borrowers Do not create another user when a borrower returns later in the loan. Reuse the original user and choose the return path that matches the request: * Use [instant refresh](/verifications/re-verification#instant-refresh) when the existing connection or uploaded documents can support a new report. * Create a new active verification and session when the borrower needs to connect another account or provide new documents. * Create another session for the same active verification if the borrower left before completing the original session. See [Recovery and Errors](/verifications/recovery-and-errors) for invalid user details, incomplete sessions, and other recovery paths. ## Reports and source documents Treat the verification webhook as the report-readiness signal. If you also need paystubs or payroll documents, use the employment IDs in the report JSON to limit those requests to employments included in the report. * Review [Reports and Source Documents](/verifications/reports-and-source-documents). * Connect Argyle to [Point of Sale Systems](/integrations/pos-los/point-of-sale-systems) or [Loan Origination Systems](/integrations/pos-los/loan-origination-systems). * See [Day 1 Certainty® and AIM](/integrations/d1c-aim/verifications) for supported GSE workflows and reference-ID guidance. Start with the [Verifications Quickstart](/verifications/quickstart) for complete request examples. ## Order verifications in Console > [!NOTE] > > Contact your Argyle customer success manager to enable verifications in Console. Mortgage teams can also order payroll and banking verifications directly in [Console](https://console.argyle.com/). 1. Open **Verifications** and select **Order verification**. 2. Choose a flow and the available income and employment or asset report types you need. 3. Enter the borrower details and send an invitation by email, SMS, or both. 4. Track each verification's status, download available reports and source documents, and refresh eligible Console orders as the loan progresses. After a verification is ordered, borrowers receive an invitation to share their payroll or banking data. Doc VOI results and verifications ordered through the API or partner systems are also available for viewing in Console. See [Console Verifications](/console/verifications) for the full walkthrough, required borrower details, and available actions. # Personal Lending Source: https://docs.argyle.com/verticals/personal-lending Use payroll data, banking reports, and uploaded documents in personal lending workflows. Applicants can share payroll data, connect bank accounts, or upload documents for a personal lending application. Choose the products and data required by your lending policy. ## Choose products > [card] [Payroll](#payroll) > > Retrieve payroll records for your application or underwriting workflow. > [card] [Banking](#banking) > > Use Banking Verifications for income and asset reports. > [card] [Document uploads](#document-uploads) > > Receive uploaded files and retrieve OCR and authenticity results when enabled. Create one Argyle user for the applicant and store the user ID with the application record. Reuse it across products and when the applicant returns. ## Payroll Use the Data APIs when your application needs direct access to payroll records. Common data sets include: * [Identities](/api-reference/identities) for employer, employment status, job, pay, and hire-date information. * [Paystubs](/api-reference/paystubs) for recent income history. * [Payroll Documents](/api-reference/payroll-documents) when source files are required. * [Deposit Destinations](/api-reference/deposit-destinations) for paycheck-allocation information. If your workflow needs a completed payroll report, use [Payroll Verifications](/verifications/verification-types/payroll). ### Connect payroll accounts Launch [embedded Link](/link/initialization/overview) inside your application, or send an [email/SMS invitation](/api-reference/invites/send-an-invite). For invitations, store the invite ID with the applicant's user ID. When your application collects the employer name first, use [Employer Search](/api-reference/employer-search) to check coverage. [Direct login](/workflows/account-connections#direct-login) can take the applicant to a known source. Track each connected account independently. The [`accounts.connected`](/api-reference/accounts-webhooks/connected) webhook confirms successful authentication, but does not mean payroll data is ready. ### Retrieve payroll data 1. Retrieve employment information after the [`identities.added`](/api-reference/identities-webhooks/added) webhook, and handle subsequent identity updates. 2. Subscribe to the [`paystubs.partially_synced`](/api-reference/paystubs-webhooks/partially-synced) webhook with `config.days_synced` set to the history your lending policy requires. Retrieve paystubs using the account and available dates from the webhook. 3. Also handle the [`paystubs.fully_synced`](/api-reference/paystubs-webhooks/fully-synced) webhook, because an account can complete without a partial-sync event. 4. Use the [`users.fully_synced`](/api-reference/users-webhooks/fully-synced) webhook when waiting for all initial data across the applicant's newly connected payroll accounts. Follow [Data Delivery and Readiness](/overview/data-delivery#retrieving-paystubs) for multiple accounts, missing partial-sync events, and timeouts. Check that the returned records meet the required history and field requirements before continuing. Use the `employment` field to [match identities, paystubs, and payroll documents](/overview/data-structure/employments) for the same job. An account can contain records from multiple jobs. Filtering by employment excludes unmatched records; retrieve all records first when those records are also needed. ## Banking Use [Banking Verifications](/verifications/verification-types/banking) when the applicant will share banking information for an income or asset report. 1. If the applicant already has a user from payroll or document collection, reuse that user ID. Otherwise, create a user. Update any missing [required banking details](/verifications/quickstart#create-a-user) before ordering the verification. 2. Order the required report, such as `voi` for income or `voai` for assets and income. 3. Create a session and launch its link with the [banking SDK](/verifications/verification-types/banking#embedded-banking). Hosted banking invitations must be enabled by Argyle before use. 4. Wait for the `verifications.updated` webhook and retrieve the report PDF or JSON when its status is `completed` or `completed_with_errors`. Use verification status to determine banking report readiness. Payroll synchronization events do not apply to this path. ## Document uploads Offer documents as an initial option or when an applicant cannot connect an account. A [document-upload-only Flow](/workflows/document-processing#document-upload-only) lets the applicant upload files in Link without a payroll connection. If you already collect documents outside Link, [upload them through the API](/api-reference/user-uploads/upload-a-document). Retrieve files through [User Uploads](/api-reference/user-uploads). When OCR is enabled, use [OCR completion and failure webhooks](/integrations/ocr/ocrolus#ocr-webhooks) to track processing and retrieve the results from `metadata.ocr_documents[]`. Authenticity results have their own webhook. See [OCR and Authenticity](/integrations/ocr/ocrolus) for supported documents, result fields, and errors. Doc VOI is designed for mortgage income calculations; standalone document collection and OCR use the User Uploads API. ## Incomplete and returning applicants Subscribe to the [`accounts.updated`](/api-reference/accounts-webhooks/updated) webhook with `config.include_resource = true` for payroll connection status changes. Set an application-level timeout for requests that do not produce the required records. * Return the existing user to [Reconnect an Account](/workflows/reconnecting-accounts) when credentials or MFA need attention. * Let the applicant upload additional documents through the same document Flow. * Use [Ongoing Refresh](/overview/ongoing-refresh) if it is enabled for your organization and your lending workflow requires records after the initial decision. For incomplete banking sessions or report errors, follow [Recovery and Errors](/verifications/recovery-and-errors). # Tenant Screening Source: https://docs.argyle.com/verticals/tenant-screening Use payroll data, banking reports, and uploaded documents for tenant screening. Applicants can share payroll data, connect bank accounts, or upload documents for tenant screening. Choose the products that provide the information your screening process requires. ## Choose products > [card] [Payroll](#payroll) > > Retrieve identities, paystubs, and source documents from accounts applicants connect. > [card] [Banking](#banking) > > Use Banking Verifications for income and asset reports. > [card] [Document uploads](#document-uploads) > > Receive uploaded files and retrieve OCR and authenticity results when enabled. You can offer these products individually or together. ## Payroll > [!NOTE] > > For tenant screening, use the [Paystubs API](/api-reference/paystubs) to calculate income for your screening process. See [Verifications vs. Data APIs](/overview/verifications-vs-data-apis) for a comparison. Use the Data APIs when your screening process needs employer, employment status, pay, or income history fields from [Identities](/api-reference/identities) and [Paystubs](/api-reference/paystubs). Add [Payroll Documents](/api-reference/payroll-documents) when you also need source files. Before implementing, determine which fields and how much paystub history you need, whether source documents are required, and what to offer when the required data is unavailable. ### Connect payroll accounts 1. Reuse the applicant's existing [user ID](/overview/data-structure/users), or [create a user](/api-reference/users/create-a-user) and store the returned ID with the applicant record in your system. 2. Create a [user token](/api-reference/user-tokens/create-a-user-token) and launch [Link](/link/initialization/overview) so the applicant can find their employer or payroll provider. 3. Let the applicant connect additional accounts when income from more than one job is needed. 4. Store each connected account ID and track its status independently. Use [Link callbacks](/link/reference/callbacks) to update the applicant experience. For example, the [`onAccountConnected` callback](/link/reference/callbacks#onaccountconnected) can advance the applicant to the next screen after a successful connection. Use webhooks to determine when payroll data is ready. ### Retrieve payroll data Subscribe to the webhooks that match the data you need: | Webhook | Use | | - | - | | [`paystubs.partially_synced`](/api-reference/paystubs-webhooks/partially-synced) | Retrieve paystubs for the requested history window. Use the account ID and `available_from` / `available_to` dates from the webhook. | | [`users.fully_synced`](/api-reference/users-webhooks/fully-synced) | Initial data retrieval has finished for all newly connected payroll accounts attached to the user. | Set `config.days_synced` on the `paystubs.partially_synced` subscription to specify how many days of paystub history you need. The default is 30 days. You can create separate subscriptions for different history windows. The history window and Paystubs API date filters use each paystub's payment date (`paystub_date`), not the start or end date of its pay period. > [!NOTE] > > Do not wait only for the `paystubs.partially_synced` webhook. Also handle `users.fully_synced` and set a timeout so applicants are not left waiting if data is unavailable, an account connection error occurs, or an expected webhook is not received. Contact your Argyle Customer Success Manager for a recommended timeout window. See [Retrieving paystubs](/overview/data-delivery#retrieving-paystubs) for the complete flow. Follow pagination and retain resource IDs so later updates modify the corresponding records in your system. A completed sync means all available records were retrieved; check that those records meet your screening requirements. ### Match employments A payroll account may contain paystubs from multiple jobs. To retrieve the paystubs for the job associated with the connected account: 1. Retrieve the account's [identity information](/api-reference/identities) to identify the job and read its `employment` ID. 2. Use that ID as the `employment` filter when [listing paystubs](/api-reference/paystubs/list-all-paystubs). The returned paystubs will have the same employment ID as the identity. Paystubs with `employment: null` are excluded by this filter. See [Employments](/overview/data-structure/employments) for more on filtering and handling unmatched paystubs. ## Banking Use [Banking Verifications](/verifications/verification-types/banking) when applicants will share banking information for an income or asset report. 1. If the applicant already has a user from payroll or document collection, reuse that user ID. Otherwise, create a user. Update any missing [required banking details](/verifications/quickstart#create-a-user) before ordering the verification. 2. Order a verification with the required report type, such as `voi` for income or `voai` for assets and income. 3. Create a banking session and launch the returned link using the [banking SDK](/verifications/verification-types/banking#embedded-banking). Hosted banking invitations must be enabled by Argyle before use. 4. Wait for the `verifications.updated` webhook. When the verification reaches `completed` or `completed_with_errors`, retrieve its report PDF or JSON. Banking uses verification status for report readiness. Payroll synchronization events do not indicate that a banking report is ready. ## Document uploads You can also offer a dedicated document upload entry point in your application. Applicants upload files through [Link](/link/overview), the same experience used to connect payroll accounts, with a separate Flow configured for document uploads only. ### Document uploads only 1. Create a [document-upload-only Flow](/workflows/document-processing#document-upload-only) in Console. 2. Select the document categories and required quantities, then save the Flow. 3. Create a [user token](/link/user-tokens) for the applicant and launch Link with that token and Flow ID from your application's document upload entry point. Applicants go directly to document uploads without connecting a payroll account. If you already collect files outside Link, [upload them through the API](/api-reference/user-uploads/upload-a-document). Retrieve uploaded files through [User Uploads](/api-reference/user-uploads). When OCR is enabled, listen for [OCR completion and failure webhooks](/integrations/ocr/ocrolus#ocr-webhooks), then retrieve the results from `metadata.ocr_documents[]`. Authenticity results have their own webhook. See [OCR and Authenticity](/integrations/ocr/ocrolus) for supported documents, fields, and processing errors. > [!NOTE] > > Doc VOI is designed for mortgage income calculations. For tenant-screening document collection, OCR, and authenticity, use Document Uploads and the User Uploads API. ## Common issues * **Unmatched paystubs:** A `null` employment does not mean the paystub is unusable. Keep it available for separate processing, without applying another employment's status to it. * **Missing partial-sync event:** The event is not sent if no paystubs are available, the most recent paystub's payment date is older than the requested window, or retrieval completes in one pull. Handle full synchronization and your application's timeout. * **Connection errors:** Subscribe to the [`accounts.updated`](/api-reference/accounts-webhooks/updated) webhook with `config.include_resource = true` and inspect the account's connection status and errors. Offer another connection attempt when appropriate. When an applicant returns, reuse their existing user ID. Follow [Reconnect an Account](/workflows/reconnecting-accounts) when credentials or MFA are required, or let them return to the document Flow to provide additional files. # Account Connections Source: https://docs.argyle.com/workflows/account-connections Choose a payroll connection experience. Users connect payroll accounts through Link at their direction. Choose the starting experience based on what your application already knows about the user's income source. Configure the experience in a Console Flow, through Link initialization parameters, or in the verification session request where supported. > [!NOTE] > > This guide applies to payroll connections and document-upload flows in Link. For banking, create a verification session and follow [Banking Verifications](/verifications/verification-types/banking#choose-a-session-type). ## Search Search is the **default** user experience in Link. > [tab] Step 1 > > The user searches from a general list of potential incomes sources. This includes employers, government entities, and payroll services. > > ![Search screen in Link.](https://mintcdn.com/argyle/zs6lb-w1jQV9DVbr/images/workflows/account-connections/1-account-connections.png?fit=max\&auto=format\&n=zs6lb-w1jQV9DVbr\&q=85\&s=be0c4e8f64af01df757a4389aa4cc236) > [tab] Step 2 > > If the user cannot find their source of income from this general list, they will be prompted to search from a list of only payroll providers that service multiple employers. > > ![Can't find income source screen in Link.](https://mintcdn.com/argyle/lpddaw6ggr_B1oHD/images/argyle-guides/workflows/account-connections/2-account-connections.png?fit=max\&auto=format\&n=lpddaw6ggr_B1oHD\&q=85\&s=62cb71373764ff4af23f940c714740b1) > > > [!NOTE] > > > > These payroll providers are searchable in step 1, but we have found narrowing the search focus to payroll providers improves the connection success rate for users. > [tab] Step 3 > > If the user successfully finds their source of income, they are taken to its respective login screen. From the login screen, the user can enter their login credentials to connect their account. > > ![Login screen in Link.](https://mintcdn.com/argyle/0Z2zBY-iD5Q5BvPN/images/argyle-guides/link/analytics/3-login-screen.png?fit=max\&auto=format\&n=0Z2zBY-iD5Q5BvPN\&q=85\&s=22a866e61fab748d61da3553ab4a8dea) > > * If the user cannot remember their login credentials, the login screen provides a link to the platform's username/password reset process. > * Each login screen is tailored to match the input fields used by the underlying payroll system. For example, some systems require a username and password, others an email and password, while others may use SSO methods to login. You can preview the login screen for any employer or payroll system in Console using [Flows](https://console.argyle.com/flows). > [tab] Step 4 > > If the user cannot ultimately find their source of income, they are asked to submit a response form and list their employers or payroll providers. > > ![Response form screen in Link.](https://mintcdn.com/argyle/lpddaw6ggr_B1oHD/images/argyle-guides/workflows/account-connections/4-account-connections.png?fit=max\&auto=format\&n=lpddaw6ggr_B1oHD\&q=85\&s=3f9271523e114f21e6af3f1f65bb67bd) ### Common customizations * Excluding specific Items or Item categories (employers, gig platforms, payroll providers, or government benefits). * Adjusting the fallback experience when users cannot find their source of income. > [accordion] Item groupings > > Certain Items are used to "group" other individual Items, and may or may not support payroll connections themselves. These Items will have a **Grouping** tag in Console's [Coverage](https://console.argyle.com/coverage) page. > > Groupings can be: > > * Payroll providers that support login credentials for multiple employers. > * Employers that utilize multiple payroll providers. > * Common employers such as franchises that allow individual locations or regions to independently choose third-party payroll systems for their employees. > > When a user selects a grouping that *does not* directly support payroll connections, a dropdown menu of individual Items that *do* support payroll connections and are related to the particular grouping are shown. > > ![Groupings in Link.](https://mintcdn.com/argyle/lpddaw6ggr_B1oHD/images/argyle-guides/workflows/account-connections/5-account-connections.png?fit=max\&auto=format\&n=lpddaw6ggr_B1oHD\&q=85\&s=1a07626d5ef773544a33817c0623ec9a) ## List As an alternative to search, Link also supports custom lists: ![List screen in Link.](https://mintcdn.com/argyle/zs6lb-w1jQV9DVbr/images/workflows/account-connections/6-account-connections.png?fit=max\&auto=format\&n=zs6lb-w1jQV9DVbr\&q=85\&s=e7273fed005f971c6d6f54fe16e34c8e) 1. Create a custom list using [Flows](https://console.argyle.com/flows) in Console. 2. Apply saved email/SMS template Flows when [sending invites](/console/flows/email-sms-templates#sending-invites), or copy the ID of a saved [embedded experience](/console/flows/embedded-experiences) and add the following line to your embedded [Link initialization](/link/initialization): ```json theme={} flowId: "" ``` Alternative: 1. Add an array of Item ID's directly within your Link initialization: ```json theme={} items: ["", "", "..."] ``` ## Direct login Directly open a specific Item in Link when the user's employer or payroll provider is already known. ### New connections ![Login screen in Link.](https://mintcdn.com/argyle/0Z2zBY-iD5Q5BvPN/images/argyle-guides/link/analytics/3-login-screen.png?fit=max\&auto=format\&n=0Z2zBY-iD5Q5BvPN\&q=85\&s=22a866e61fab748d61da3553ab4a8dea) 1. [Create a customized Flow](/console/flows/embedded-experiences) in Console with "Direct login" selected in the **Search and connect** section. 2. Your customizations will: * Automatically be applied to the [Shareable URL](/console/flows/shareable-urls) after saving the Shareable URL Flow. * Be applied when [sending invites](/console/flows/email-sms-templates#sending-invites) if the saved Email/SMS Template Flow is selected from the dropdown. * Be applied when [embedding Link](/console/flows/embedded-experiences) by copying the `ID` of a saved Embedded Experience Flow and including it within the optional `flowId` [initialization parameter](/link/initialization/overview#optional-initialization-parameters) in your Link initialization: ```json theme={} flowId: "" ``` Alternative: 1. Add an `items` array to your embedded Link initialization with only one Item. ```json theme={} items: [""] ``` 2. (Optional) If you are embedding Link and want to allow users to return to Link's full search experience from the login screen: * Create a "New Flow" in the [Flows](https://console.argyle.com/flows) area of Console and select "Embedded Experience" * In the **Search and connect** section, select "Search" and adjust the search experience for your users * Next, in the same **Search and connect** section, select "Direct Login" * Enable the "Allow users to access full Search experience" toggle * Select one employer in the "Search to select income sources" selection box > [!NOTE] > > The Item you input in the `items` array (see below) will override this employer when Link is initialized. * Save the Flow and copy the Flow `ID` from the main Flows page * Add both an `items` array with only one Item, and the copied `flowId` string to your embedded Link initialization: ```json theme={} items: [""] flowId: "" ``` ### Existing connections ![Directly connect a user to an already-connected payroll account.](https://mintcdn.com/argyle/zs6lb-w1jQV9DVbr/images/workflows/account-connections/11-account-connections.png?fit=max\&auto=format\&n=zs6lb-w1jQV9DVbr\&q=85\&s=2fb5c9656677896054bfbf49b7d49827) * If you originally invited the user through Console's [send invites](/console/flows/email-sms-templates#sending-invites) feature, follow the steps in our Email/SMS Flows Guide for [reconnecting existing users](/console/flows/email-sms-templates#reconnecting-existing-users). * If you are embedding Link, use the optional `accountId` [initialization parameter](/link/initialization/overview#optional-initialization-parameters) and pass in the [ID of the account](/api-reference/accounts#object). ```json theme={} accountId: "" ``` ### Sample app If you are [embedding Link](/link/initialization), check out our Employer Search sample app ([Demo](https://sampleapps.argyle.com/employer-search)) ([Github](https://github.com/argyle-sample-apps/employer-search)) ([Documentation](/overview/employer-search)) to see an example project that showcases the direct login method. In the sample app, a simple employer search bar powered by Argyle's [employer-search endpoint](/api-reference/employer-search) lets users search for their employer. After making a selection, the user is sent directly to that Item's login screen in Link. ![A search bar lets users search for their employer and directly connect to the respective login screen.](https://mintcdn.com/argyle/lpddaw6ggr_B1oHD/images/argyle-guides/sample-apps/employer-search/1-employer-search-app.png?fit=max\&auto=format\&n=lpddaw6ggr_B1oHD\&q=85\&s=53341dc0ebc74f3d93d7ddd7380f991b) ## Document upload Directly connect users to the document upload screen in Link, bypassing the payroll account connection process. Visit our [Document Processing Guide](/workflows/document-processing) for more information. ![Link supports directly uploading documents such as paystubs, W-2s, and 1099s.](https://mintcdn.com/argyle/zs6lb-w1jQV9DVbr/images/overview/how-argyle-works/5-how-argyle-works.png?fit=max\&auto=format\&n=zs6lb-w1jQV9DVbr\&q=85\&s=0adeffff94b9f94a99c58aa50540413b) ## Completing MFA Most payroll systems require multi-factor authentication (MFA) when a user logs in or takes action such as updating their direct deposit settings. * The MFA process can be completed directly within Link. * Users can leave Link to retrieve their authentication information and return to the same Link session while it remains active. ![MFA screen in Link.](https://mintcdn.com/argyle/0Z2zBY-iD5Q5BvPN/images/argyle-guides/link/analytics/4-MFA-screen.png?fit=max\&auto=format\&n=0Z2zBY-iD5Q5BvPN\&q=85\&s=34f6d7702abfa4171f5112bbf8415ee3) ## Troubleshooting ### Connection pending Link will display "Connection pending" if an account connection is experiencing significant delays. * Users will be able to exit Link or return to the search screen to connect additional accounts. * You can monitor the account's connection status [via the API](/api-reference/accounts#object-connection-status), through the [Connections](https://console.argyle.com/connections) section of Console, or by subscribing to the [`accounts.updated`](/api-reference/accounts-webhooks/updated) webhook. The account will have an initial status of `connecting` (**API**) or "Attempted" (**Console**) until the connection successfully completes or an [account connection error](/api-reference/account-connection-errors) occurs. ![Link will show connection pending if the connection process does not complete after a certain amount of time.](https://mintcdn.com/argyle/zs6lb-w1jQV9DVbr/images/workflows/account-connections/12-account-connections.png?fit=max\&auto=format\&n=zs6lb-w1jQV9DVbr\&q=85\&s=fd23280167b8938eeb31a4999af8afe3) ### Expired user token If a user waits too long to complete MFA, they may encounter the `expired_user_token` Link error. Create a new [user token](/link/user-tokens) instead of relying on a specific token lifetime. To reactivate Link for the user, [create a new user token](/api-reference/user-tokens/create-a-user-token) and either: * Re-initialize Link with the new user token. * Pass the user token to the [`onTokenExpired`](/link/reference/callbacks#ontokenexpired) callback. ![expired\_user\_token Link error](https://mintcdn.com/argyle/0Z2zBY-iD5Q5BvPN/images/argyle-guides/link/error-codes/4-expired-user-token.png?fit=max\&auto=format\&n=0Z2zBY-iD5Q5BvPN\&q=85\&s=063a02ef72fe1816e66c966de4bd1c20) ## Customizations For more information on customizing the connection process in Link, visit our [Flows Guides](/console/flows/embedded-experiences). # Document Processing Source: https://docs.argyle.com/workflows/document-processing Upload and process documents. Documents can be uploaded directly through the API or collected from users in Link. Supported documents include W-2s, 1099s, paystubs, proof of identity, proof of address, and other files. ![Link supports directly uploading documents such as paystubs, W-2s, and 1099s as well as proof of identity, proof of address, and a miscellaneous (re-namable) category of documents.](https://mintcdn.com/argyle/zs6lb-w1jQV9DVbr/images/overview/how-argyle-works/5-how-argyle-works.png?fit=max\&auto=format\&n=zs6lb-w1jQV9DVbr\&q=85\&s=0adeffff94b9f94a99c58aa50540413b) ## Uploading documents ### User uploads within Link Document uploads can be enabled and customized through the [Flows](https://console.argyle.com/flows) section of Console. > [accordion] How to enable document uploads on Link's intro screen > > 1. Create or edit an existing Flow. > > 2. In the **Intro screen** section, enable the "Intro screen" and "Document upload" toggles. > > 3. In the **Document upload settings** section: > > * Customize the text of the document upload submission screen. > * Select the document upload categories you would like to display. Choose whether a selected category is optional or required. If required, specify how many documents are needed for the category. > [accordion] How to enable document uploads as a fallback (employer not found or incorrect login credentials) > > 1. Create or edit an existing Flow. > > 2. In the **Search and connect** section, scroll down to **Fallback experiences** and select the "Document upload" toggle for one or both fallback scenarios: > > * **User finds no search results** (*not applicable to [Direct login](/workflows/account-connections#direct-login) flows*): Users are prompted to upload documents when they are unable to locate their employer or payroll provider through Link search. > > * **User provides incorrect credentials**: Users are prompted to upload documents when a payroll connection attempt is unsuccessful. > > 3. In the **Document upload settings** section: > > * Customize the text of the document upload submission screen. > * Select the document upload categories you would like to display. Choose whether a selected category is optional or required. If required, specify how many documents are needed for the category. > [accordion] How to enable document uploads on Link's success screen (after an account connection) > > 1. Create or edit an existing Flow. > > 2. In the **Success screen** section, select "Allow users to upload documents after a successful connection". > > 3. In the **Document upload settings** section: > > * Customize the text of the document upload submission screen. > * Select the document upload categories you would like to display. Choose whether a selected category is optional or required. If required, specify how many documents are needed for the category. The following document uploaded categories are currently supported: | Category | Description | OCR supported | Authenticity supported | | - | - | - | - | | Paystubs | Paystubs used as proof of income. | Yes | Yes | | W-2s | Yearly wage, salary, and tax information. | Yes | Yes | | 1099s | Income other than wages, salaries, and tips. | Yes | Yes, for [supported forms](/integrations/ocr/ocrolus#authenticity-scores) | | Proof of identity | Valid form of identity such as a driver's license or passport. | No | No | | Proof of address | Residential address verification, such as a utility bill, bank statement, or lease agreement. | No | No | | Miscellaneous | Re-nameable category for miscellaneous documents. | No | No | If all document categories are marked as *Optional*, the option to "Skip document upload" will be presented to users: ![If all document upload categories are marked as optional, the option to skip document upload will be presented to users.](https://mintcdn.com/argyle/QYNgkspEsQEdzfi4/images/argyle-guides/workflows/document-upload/7-document-upload.png?fit=max\&auto=format\&n=QYNgkspEsQEdzfi4\&q=85\&s=2e4268475ba3c20e00d4a0f14f65de47) After enabling document uploads and saving your Flow in Console: * **Shareable URLs** — Document uploads will be active when any user enters Link through your saved shareable URL. * **Email/SMS Templates** — When [inviting new users](/console/flows/email-sms-templates#inviting-new-users), select the Flow from the **Template** dropdown. * **Embedded Experiences** — Copy the Flow ID from Console and add the following line to your [Link initialization](/link/initialization/overview#optional-initialization-parameters): ```json theme={} flowId: "" // (e.g. "V32M5YBC") ``` ### Document upload only 1. Create or edit an existing Flow. 2. In the **Search and connect** section, select "Doc upload". 3. In the **Document upload settings** section: * Customize the text of the document upload submission screen. * Select the document upload categories you would like to display. Choose whether a selected category is optional or required. If required, specify how many documents are needed for the category. After saving the Flow, use its Flow ID when launching Link. Users will open the document upload screen without connecting a payroll account. ![Select Doc upload in the search and connect tab when creating a Link flow customization.](https://mintcdn.com/argyle/QYNgkspEsQEdzfi4/images/argyle-guides/workflows/document-upload/5-document-upload.png?fit=max\&auto=format\&n=QYNgkspEsQEdzfi4\&q=85\&s=d305b411502027a91db11ac069fc79f5) ### Additional uploads (returning users) When document uploads are enabled, users can [return to Link](/workflows/reconnecting-accounts) and upload additional documents or delete previously uploaded documents. Category limits configured in the Flow continue to apply when the user returns. ![Users can return to Link if you need them to upload additional documents.](https://mintcdn.com/argyle/QYNgkspEsQEdzfi4/images/argyle-guides/workflows/document-upload/6-document-upload.png?fit=max\&auto=format\&n=QYNgkspEsQEdzfi4\&q=85\&s=597277ab54c1f461ba7bafa45fc07e5f) ### Direct uploads via the API If you already collect documents outside Link, upload them with [`POST /v2/user-uploads`](/api-reference/user-uploads/upload-a-document). > [!NOTE] > > Uploading documents via the API can be used in combination with [document authenticity and OCR](/workflows/document-processing#document-authenticity-and-ocr). OCR and authenticity information can also be retrieved via the API — see our [OCR guide](/integrations/ocr/ocrolus#api) for more information. ## Retrieving uploaded documents Retrieve uploaded documents through the [User Uploads API](/api-reference/user-uploads). Use [User Upload webhooks](/api-reference/user-uploads-webhooks/added) for backend processing and `onDocumentsSubmitted` for immediate [Link callback](/link/reference/callbacks#ondocumentssubmitted) handling. Uploaded documents can also be retrieved within the [Connections section of Console](https://console.argyle.com/connections) after selecting an individual user. Any uploaded documents will be available for download in an **Uploaded documents** tab. ![If a user has uploaded documents through Link, they will appear in an Uploaded Documents tab on the user's page in Console.](https://mintcdn.com/argyle/X2Ud-Ls5bpXC3Xsk/images/argyle-guides/integrations/document-ocr-processors/2-OCR.png?fit=max\&auto=format\&n=X2Ud-Ls5bpXC3Xsk\&q=85\&s=15a597c09e758e006539b57076d826f8) ## Document authenticity and OCR Supported uploaded documents can be processed through [Ocrolus](/integrations/ocr/ocrolus) for OCR and authenticity signals. View the results in [Console](/integrations/ocr/ocrolus#console) or retrieve `metadata.ocr_documents[]` through the [User Uploads API](/api-reference/user-uploads). Use [OCR webhooks](/integrations/ocr/ocrolus#ocr-webhooks) to track OCR completion, failures, and authenticity results. See [OCR errors](/integrations/ocr/ocrolus#ocr-errors) when a document cannot be processed. ![Summary information of document authenticity returned by Ocrolus can be viewed in Console.](https://mintcdn.com/argyle/X2Ud-Ls5bpXC3Xsk/images/argyle-guides/integrations/document-ocr-processors/3-OCR.png?fit=max\&auto=format\&n=X2Ud-Ls5bpXC3Xsk\&q=85\&s=46a236fa361202ed5b0c193b1e16c898) ## Supported file types | File format | Link support | Ocrolus OCR support | | - | - | - | | PDF | Web, iOS, Android, React Native, Flutter | Yes | | JPG image uploads | Web, iOS, Android, React Native, Flutter | Yes | | PNG image uploads | Web, iOS, Android, React Native, Flutter | Yes | | HEIC image uploads | Web, iOS, Android, React Native, Flutter | Yes | | Photo capture | Web, iOS, Android, React Native, Flutter | Yes | ## Restricting to only PDFs Document uploads can be restricted to only PDF file types by enabling the **Restrict to PDF only** toggle for each document type in the [Flows](https://console.argyle.com/flows) section of Console. ![Toggle Restrict to PDF only to restrict file uploads to PDFs only.](https://mintcdn.com/argyle/uzAEgPS2J3g8X799/images/argyle-guides/workflows/document-upload/8-document-upload.png?fit=max\&auto=format\&n=uzAEgPS2J3g8X799\&q=85\&s=33979d80efc102561bd448e4132218c8) When a document type is restricted to PDF only, Link will adjust accordingly to guide users. Depending on the device used to upload documents, they will either be prevented from selecting non-PDF file types or shown an error if a non-PDF file type is uploaded. ![Link's doc upload button will change to say Upload PDF instead of Upload, and an invalid file format error will be shown if the user attempts to upload a non-pdf file type.](https://mintcdn.com/argyle/uzAEgPS2J3g8X799/images/argyle-guides/workflows/document-upload/9-document-upload.png?fit=max\&auto=format\&n=uzAEgPS2J3g8X799\&q=85\&s=1913bee6645413071572ac48b18c36c2) # Reconnecting Accounts Source: https://docs.argyle.com/workflows/reconnecting-accounts Resume payroll or banking connections that need user action. A connection can require user action after the original session. Reuse the existing user and active verification whenever the workflow allows it. Payroll account IDs, account errors, and the Link reconnection screens described below apply to payroll connections. For banking, create another session for the active verification and restart the connection flow. See [Banking Verifications](/verifications/verification-types/banking#choose-a-session-type). ## Choose the return path ### Active verification If a payroll or banking verification remains active in `pending` or `user_session_started`, create a new session for the same verification with [`POST /v2/sessions`](/api-reference/verifications/create-a-session). Session links expire after one hour. An expired session does not require another user or verification. For an invite session, create a new invite for the existing user and active verifications when the original invite has expired or been revoked. See [Recovery and Errors](/verifications/recovery-and-errors#session-not-completed). ### New verification or refreshed report A completed or cancelled verification is terminal. * Create a new verification when the user needs to complete another verification order. * Use [Re-verification](/verifications/re-verification) when an existing connection or uploaded documents can support an updated report. ### Embedded Link for Data APIs For a direct-data implementation: 1. Create a new [user token](/api-reference/user-tokens/create-a-user-token) for the existing user. 2. Initialize Link with that user token. 3. Include `accountId` to open the existing account directly. ```json theme={} { "userToken": "USER_TOKEN", "accountId": "ACCOUNT_ID" } ``` Retrieve account IDs from the [Accounts API](/api-reference/accounts/list-all-accounts) or copy the ID from the account details in Console. ### Console invitations and Shareable URLs For users originally sent through Console, use [Connections](https://console.argyle.com/connections) to resend or copy their existing link when that option is available. For Shareable URL implementations, follow the [reconnecting users](/console/flows/shareable-urls#reconnecting-users) workflow. Avoid creating another user only to return the same person to Link. A duplicate user separates the person's existing accounts and data from the new record. ## Why accounts disconnect Some connected payroll systems require users to reauthenticate periodically or update credentials. Existing data remains available after a disconnection, but ongoing refresh pauses until the user reconnects the account. The account error identifies the required action. ## Reauthorization required An `auth_required` error means the payroll system requires the user to reauthorize access. 1. Return the user to the existing account in Link. 2. The user selects **Reconnect**. 3. The user completes any required MFA step. The user generally does not need to reenter their username and password for this error. ![A user selects Reconnect to reauthorize an existing account.](https://mintcdn.com/argyle/zs6lb-w1jQV9DVbr/images/workflows/reconnecting-accounts/1-reconnecting-accounts.png?fit=max\&auto=format\&n=zs6lb-w1jQV9DVbr\&q=85\&s=f425c6b2761548edcefa7c38d43a3a9c) ## Expired credentials An `expired_credentials` error means the payroll system rejected the stored username or password. 1. Return the user to the existing account in Link. 2. The user opens **Login help** and updates their credentials with the payroll system. 3. The user returns to Link and enters the updated credentials. ![Login help directs users to update expired payroll credentials.](https://mintcdn.com/argyle/zs6lb-w1jQV9DVbr/images/workflows/reconnecting-accounts/2-reconnecting-accounts.png?fit=max\&auto=format\&n=zs6lb-w1jQV9DVbr\&q=85\&s=ee925961643e64d31be4c3728732ec3a) ## MFA The payroll system controls which MFA methods are available and how the user receives or completes the challenge. Link displays the required input after authentication reaches the MFA step. See [Completing MFA](/workflows/account-connections#completing-mfa). ## Test disconnections In Sandbox, use the error-testing controls in [Flows](https://console.argyle.com/flows) or the Sandbox account update endpoint to simulate account errors. See [Sandbox Testing](/overview/sandbox-testing#simulate-errors-in-console). ## Revoking access Users can revoke a connection from the account details in Link. They can also request help removing a connection by emailing [privacy@argyle.com](mailto:privacy@argyle.com). After a connection is removed: * Data from that account is no longer available to your organization through Console or the API. * The [`accounts.removed`](/api-reference/accounts-webhooks/removed) webhook is sent for the removed account. * Reconnecting the same source later creates a new account ID. See [Data Security](/overview/data-security#connections-and-deletion) for retention and deletion guidance. ## Monitor account status Subscribe to the [`accounts.updated`](/api-reference/accounts-webhooks/updated) webhook with `config.include_resource = true`. When the account resource has `connection.status = error`, inspect the current error code and follow its remediation. Use the [Account Connection Errors](/api-reference/account-connection-errors) catalog rather than matching only the message text. Subscribe to the [`accounts.removed`](/api-reference/accounts-webhooks/removed) webhook to track revoked or deleted connections.