Timestamp (ISO 8601) when the account was last updated. An update occurs every time an account is scanned for new data, and when any values of the account object change (such as an updated connection status).
Object containing information on data availability for each of Argyle's data sets, and any user-uploaded documents or "can't find my income" response forms.
Object containing the account's ongoing_refresh status (whether the account will be updated with new data after each data refresh).
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Argyle Docs","colors":{"primary":"#214E48","light":"#7FB2A8","dark":"#1D1D1D"},"logo":{"light":"https://mintcdn.com/argyle/HtlySCcYVcDJWXiY/logo/light.svg?fit=max\u0026auto=format\u0026n=HtlySCcYVcDJWXiY\u0026q=85\u0026s=3d77b5555b7fdd5185b855e858558376","dark":"https://mintcdn.com/argyle/HtlySCcYVcDJWXiY/logo/dark.svg?fit=max\u0026auto=format\u0026n=HtlySCcYVcDJWXiY\u0026q=85\u0026s=9fd2f436065a41825b9839fb81c76467","href":"/"},"favicon":"https://mintcdn.com/argyle/xZQDezYDpb8d7zmN/favicon.png?fit=max\u0026auto=format\u0026n=xZQDezYDpb8d7zmN\u0026q=85\u0026s=046e800dc429a2f398d20a345dd7350a","api":{"openapi":["openAPI/account-webhook-updated.yaml","openAPI/account-webhooks-added.yaml","openAPI/accounts-webhooks-connected.yaml","openAPI/accounts-webhooks-failed.yaml","openAPI/accounts-webhooks-removed.yaml","openAPI/accounts.yaml","openAPI/deposit-destinations.yaml","openAPI/employer-search.yaml","openAPI/employments.yaml","openAPI/gigs-webhooks-added.yaml","openAPI/gigs-webhooks-fully-synced.yaml","openAPI/gigs-webhooks-partially-synced.yaml","openAPI/gigs-webhooks-removed.yaml","openAPI/gigs-webhooks-updated.yaml","openAPI/gigs.yaml","openAPI/identities-webhooks-added.yaml","openAPI/identities-webhooks-updated.yaml","openAPI/identities.yaml","openAPI/invites.yaml","openAPI/item-filters.yaml","openAPI/items-webhooks-removed.yaml","openAPI/items-webhooks-updated.yaml","openAPI/items.yaml","openAPI/open-banking.yaml","openAPI/payroll-documents-webhooks-added.yaml","openAPI/payroll-documents-webhooks-ocr-completed.yaml","openAPI/payroll-documents-webhooks-ocr-failed.yaml","openAPI/payroll-documents-webhooks-removed.yaml","openAPI/payroll-documents-webhooks-updated.yaml","openAPI/payroll-documents.yaml","openAPI/paystubs-webhooks-added.yaml","openAPI/paystubs-webhooks-fully-synced.yaml","openAPI/paystubs-webhooks-partially-synced.yaml","openAPI/paystubs-webhooks-updated.yaml","openAPI/paystubs.yaml","openAPI/ratings-webhooks-added.yaml","openAPI/ratings-webhooks-updated.yaml","openAPI/ratings.yaml","openAPI/receipts.yaml","openAPI/reports-webhooks-generated.yaml","openAPI/reports-webhooks-ready.yaml","openAPI/reports.yaml","openAPI/shifts-webhooks-added.yaml","openAPI/shifts-webhooks-fully-synced.yaml","openAPI/shifts-webhooks-partially-synced.yaml","openAPI/shifts-webhooks-removed.yaml","openAPI/shifts-webhooks-updated.yaml","openAPI/shifts.yaml","openAPI/user-forms-webhooks-removed.yaml","openAPI/user-forms-webhooks.yaml","openAPI/user-forms.yaml","openAPI/user-tokens.yaml","openAPI/user-uploads-webhooks-added.yaml","openAPI/user-uploads-webhooks-ocr-authenticity.yaml","openAPI/user-uploads-webhooks-ocr-completed.yaml","openAPI/user-uploads-webhooks-ocr-failed.yaml","openAPI/user-uploads-webhooks-removed.yaml","openAPI/user-uploads.yaml","openAPI/users-webhooks.yaml","openAPI/users.yaml","openAPI/verifications-partners-webhooks-creation-failed.yaml","openAPI/verifications-partners-webhooks-connection-added.yaml","openAPI/verifications-partners-webhooks-updated.yaml","openAPI/verifications-partners.yaml","openAPI/verifications-webhooks-creation-failed.yaml","openAPI/verifications-webhooks-connection-added.yaml","openAPI/verifications-webhooks-updated.yaml","openAPI/vehicles-webhooks-added.yaml","openAPI/vehicles-webhooks-removed.yaml","openAPI/vehicles-webhooks-updated.yaml","openAPI/vehicles.yaml","openAPI/verifications.yaml","openAPI/webhooks.yaml"],"mdx":{"server":["https://api-sandbox.argyle.com","https://api.argyle.com"]}},"appearance":{"default":"light"},"navbar":{"links":[{"href":"/changelog","label":"Changelog"},{"href":"https://console.argyle.com/sign-in","label":"Sign in"}],"primary":{"type":"button","label":"Contact sales","href":"https://argyle.com/contact-sales/"}},"footer":{"socials":{}},"seo":{"metatags":{"og:image":"https://docs.argyle.com/images/social/argyle-docs.png","og:image:alt":"Argyle","twitter:image":"https://docs.argyle.com/images/social/argyle-docs.png","twitter:image:alt":"Argyle"}},"fonts":{"heading":{"family":"Plain","source":"fonts/Plain-Regular.woff2","format":"woff2"},"body":{"family":"Plain","source":"fonts/Plain-Regular.woff2","format":"woff2"}},"styling":{"codeblocks":{},"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"argyle","hasAudioNarration":false,"actualSubdomain":"argyle","customDomains":["docs.argyle.com"],"gitSource":{"type":"github","owner":"argyle-systems","repo":"argyle-mintlify","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae245fb51449a9936dc6c30","collectionId":"c89435dc-da28-4211-aa0b-919b1afef5e9","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae245fb51449a9936dc6c30"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae3663ffa8478333aab6a5a","clientVersion":"0.0.4021","searchFilterCounts":[{"language":"default","tag":"Clients","count":215},{"language":"default","tag":"API Reference","count":169},{"language":"default","tag":"Guides","count":76},{"language":"default","tag":"Webhooks","count":50},{"language":"default","tag":"Partners","count":40},{"language":"default","tag":"Verifications","count":38},{"language":"default","tag":"Payroll Data Sets","count":24},{"language":"default","tag":"Core Resources","count":21},{"language":"default","tag":"Workflows","count":16},{"language":"default","tag":"Verticals","count":16}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","href":"/_mintlify/custom/argyle/c71dc7693384de52/style.css"},{"filePath":"changelog.css","href":"/_mintlify/custom/argyle/81c93b48daa6fd82/changelog.css"}],"page":{"pagePath":"api-reference/accounts/retrieve-an-account","slug":"/api-reference/accounts/retrieve-an-account","pageMetadata":{"title":"Retrieve An Account","description":"Retrieves an account object.\n","openapi":"openAPI/accounts.yaml get /v2/accounts/{id}","badge":"GET","href":"/api-reference/accounts/retrieve-an-account"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Retrieves an account object.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":{},"config":{},"pageMetadata":{"title":"Retrieve An Account","description":"Retrieves an account object.\n","openapi":"openAPI/accounts.yaml get /v2/accounts/{id}","badge":"GET","href":"/api-reference/accounts/retrieve-an-account"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/argyle/af2164acf85a6b07/remove-image.js","/_mintlify/custom/argyle/0819c75d96f0177a/syntax-highlight.js","/_mintlify/custom/argyle/72285dbf6c5af137/legacy-hash-redirect.js","/_mintlify/custom/argyle/6e9f1651420bfe27/syntax-highlight-20260225.js","/_mintlify/custom/argyle/6c5de915fd850018/session-example-sync.js","/_mintlify/custom/argyle/58987997dede87ed/audience-navigation.js","/_mintlify/custom/argyle/6e74c8b91218c4d2/audience-toggle.js","/_mintlify/custom/argyle/4b7ec966460f12b0/changelog-minisearch.js","/_mintlify/custom/argyle/cc05ec1a3c7e032f/changelog-navigation.js","/_mintlify/custom/argyle/77d8a125002fffa8/changelog-search.js","/_mintlify/custom/argyle/53f62f407a9be5ea/changelog-subscribe.js","/_mintlify/custom/argyle/ccdcfecc455cb06e/changelog-tags.js"],"openApiReferenceData":{"operation":{"summary":"Retrieve an account","description":"Retrieves an account object.\n","parameters":["ea838c68-ea9d-4bc3-847d-fc9e6f8dde95"],"responses":{"200":"82a7924c-a5c3-4320-8b1a-39f4eaab5996"},"method":"get","type":"path","servers":["76de092f-b2a2-4705-9150-5d74913f963f","c740ec4b-7443-4350-824b-1b7b72d48d67"],"security":["19988c29-c291-4676-9592-1c854cf5dc7f"],"path":"/v2/accounts/{id}","baseUrlOptions":["https://api-sandbox.argyle.com","https://api.argyle.com"],"title":"Retrieve an account","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"ea838c68-ea9d-4bc3-847d-fc9e6f8dde95":{"in":"path","name":"id","schema":{"type":"string","format":"uuid","isRequired":true,"description":"ID of the account object to be retrieved.","uniqueKey":"","typeLabel":"string\u003cuuid>"},"required":true,"description":"ID of the account object to be retrieved."}},"responses":{"82a7924c-a5c3-4320-8b1a-39f4eaab5996":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"id":"0187c66e-e7e5-811c-b006-2232f00f426a","user":"018051aa-f7a9-a0db-2f38-6cfa325e9d69","employers":["Whole Goods"],"item":"item_123456789","source":"thepayrollcompany","created_at":"2023-01-30T12:53:22.561Z","updated_at":"2023-01-30T12:55:04.478Z","scanned_at":"2023-01-30T12:55:04.016Z","connection":{"status":"connected","error_code":null,"error_message":null,"updated_at":"2023-01-30T12:53:25.561Z"},"direct_deposit_switch":{"status":"success","error_code":null,"error_message":null,"updated_at":"2023-01-30T12:55:03.478Z"},"availability":{"shifts":{"status":"synced","updated_at":"2023-01-30T12:55:03Z","available_count":94,"available_from":"2020-04-11T12:53:27Z","available_to":"2023-01-25T00:00:00Z"},"gigs":{"status":"synced","updated_at":"2023-01-30T12:55:03Z","available_count":217,"available_from":"2020-04-11T12:53:27Z","available_to":"2023-01-25T00:00:00Z"},"paystubs":{"status":"synced","updated_at":"2023-01-30T12:55:03Z","available_count":68,"available_from":"2020-05-11T12:53:27Z","available_to":"2023-01-29T23:59:59Z"},"payroll_documents":{"status":"synced","updated_at":"2023-01-30T12:53:44.308Z"},"identities":{"status":"synced","updated_at":"2023-01-30T12:53:44.028Z"},"ratings":{"status":"synced","updated_at":"2023-01-30T12:55:03.359Z"},"vehicles":{"status":"synced","updated_at":"2023-01-30T12:53:44.321Z"},"deposit_destinations":{"status":"synced","updated_at":"2023-01-30T12:53:42.586Z"},"user_forms":{"status":"in_progress","updated_at":"2023-01-30T12:53:42.586Z","available_count":0,"files_count":1,"in_progress_count":1},"user_uploads":{"status":"synced","updated_at":"2023-01-30T12:54:41.621Z","files_count":2,"in_progress_count":0}},"ongoing_refresh":{"status":"enabled"}},"properties":{"id":{"type":"string","format":"uuid","description":"Unique ID of the connected payroll account.","uniqueKey":"id","typeLabel":"string\u003cuuid>"},"user":{"type":"string","format":"uuid","description":"ID of the user that connected the account.","uniqueKey":"user","typeLabel":"string\u003cuuid>"},"employers":{"type":"array","items":{"type":"string","uniqueKey":"employers.items.[INDEX]","typeLabel":"string"},"description":"Employers associated with the account.\n\nA single employer is usually returned per account. Exceptions can occur when an LLC and Co. version of the same employer is returned.\n","uniqueKey":"employers","typeLabel":"string[]"},"item":{"type":"string","description":"ID of the Item in Link through which the account was connected.","uniqueKey":"item","typeLabel":"string"},"source":{"type":"string","description":"Payroll data source. Typically a third-party payroll system unless the employer uses an in-house system.","uniqueKey":"source","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when the user connected the account.","uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when the account was last updated. An update occurs every time an account is scanned for new data, and when any values of the account object change (such as an updated connection status).","uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"},"scanned_at":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when the account was last scanned for new data. A `null` value indicates the account was never connected.","uniqueKey":"scanned_at","typeLabel":"string\u003cdate-time>"},"connection":{"type":"object","description":"Object containing information about the account's connection status.","properties":{"status":{"type":"string","enum":["connecting","connected","error"],"description":"Status of Argyle's connection with the user's payroll system.\n\n- `connecting` — The user submitted new or revised login credentials through Link and Argyle is establishing the connection.\n- `connected` — An account connection was successfully made. See the `availability` object for updates on initial data retrieval.\n- `error` — An [account connection error](/api-reference/account-connection-errors) has occurred. Data refreshes have been paused.\n","uniqueKey":"connection.status","typeLabel":"enum\u003cstring>"},"error_code":{"type":"string","enum":["account_disabled","account_inaccessible","account_incomplete","account_nonunique","account_not_found","all_employers_connected","auth_method_temporarily_unavailable","auth_required","connection_unavailable","credentials_managed_by_organization","existing_account_found","expired_credentials","full_auth_required","insufficient_account_data","invalid_account_type","invalid_auth","invalid_credentials","invalid_employer_identifier","invalid_login_method","invalid_login_url","invalid_mfa","invalid_store_identifier","known_employer_redirect","login_attempts_exceeded","login_cancelled_by_the_user","login_gov_not_linked","mfa_attempts_exceeded","mfa_cancelled_by_the_user","mfa_exhausted","mfa_not_configured","mfa_timeout","multi_driver_account","ongoing_refresh_disabled","passkey_limit_reached","personal_data_access_not_granted","physical_mfa_unsupported","platform_temporarily_unavailable","platform_unavailable","service_unavailable","session_limit_reached","system_error","temporary_credentials","tos_required","trial_connections_exhausted","trial_period_expired","unrecognized_employer_email","unsupported_auth_type","unsupported_business_account","unsupported_language","unsupported_mfa_method","user_action_timeout"],"description":"The [account connection error](/api-reference/account-connection-errors) that occurred.","uniqueKey":"connection.error_code","typeLabel":"enum\u003cstring>"},"error_message":{"type":"string","description":"Description of the error. Common causes and troubleshooting steps can be found in account connection errors.","uniqueKey":"connection.error_message","typeLabel":"string"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when the connection status last changed.","uniqueKey":"connection.updated_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"connection","typeLabel":"object"},"direct_deposit_switch":{"type":"object","description":"Object containing deposit switch status information.","properties":{"status":{"type":"string","enum":["idle","awaiting_confirmation","awaiting_user_action","awaiting_connection","scanning","updating","success","error"],"description":"Status of a deposit switch.\n\n- `idle` — The deposit switch process has not started.\n- `awaiting_confirmation` — The user started the deposit switch flow in Link but has not clicked \"Confirm\".\n- `awaiting_user_action` — The user has confirmed the deposit switch but needs to complete a multi-factor authentication (MFA) step.\n- `awaiting_connection` — Argyle is connecting to the user's payroll system.\n- `scanning` — Argyle is scanning the user's existing direct deposits before initiating the deposit switch.\n- `updating` — The deposit switch is in progress.\n- `success` — The deposit switch was successful.\n- `error` — A deposit switch error occurred, and the deposit switch could not be completed.\n","uniqueKey":"direct_deposit_switch.status","typeLabel":"enum\u003cstring>"},"error_code":{"type":"string","enum":["account_invalid","account_closed","account_blocked","confirmation_expired","confirmation_invalid","confirmation_timeout","deposit_account_mismatch","deposit_destination_unsupported","employer_unsupported","employer_account_invalid","employer_account_closed","employer_account_blocked","employer_confirmation_invalid","internal_server_error","invalid_request","item_invalid","name_mismatch","payroll_account_mismatch","temporarily_unavailable","terminate_flow","unauthorized","unexpected","user_input_required"],"description":"The deposit switch error that occurred.","uniqueKey":"direct_deposit_switch.error_code","typeLabel":"enum\u003cstring>"},"error_message":{"type":"string","description":"Description of the error. Common causes and troubleshooting steps can be found in deposit switch errors.","uniqueKey":"direct_deposit_switch.error_message","typeLabel":"string"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when the deposit switch status last changed.","uniqueKey":"direct_deposit_switch.updated_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"direct_deposit_switch","typeLabel":"object"},"availability":{"type":"object","description":"Object containing information on data availability for each of Argyle's data sets, and any user-uploaded documents or \"can't find my income\" response forms.","properties":{"shifts":{"oneOf":[{"type":"object","description":"Status of the account's most recent data scan (initial data retrieval included) or [document upload](/api-reference/user-uploads) submission.\n\n- `in_progress` — A data scan is in progress, or a document was uploaded but not submitted.\n- `synced` — The most recent data scan of the account was successful, or an uploaded document was submitted.\n- `sync_failed` — Data retrieval during the most recent data scan failed, resulting in an [account connection error](/api-reference/account-connection-errors).\n","properties":{"status":{"type":"string","enum":["in_progress","synced","sync_failed"],"uniqueKey":"availability.shifts.oneOf.0.status","typeLabel":"enum\u003cstring>"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) of the most recent change to available data.","uniqueKey":"availability.shifts.oneOf.0.updated_at","typeLabel":"string\u003cdate-time>"},"available_count":{"type":"integer","description":"Number of gig events, paystubs available, or response form submissions.\n\nDuring initial data retrieval, the `available_count` will increase until all data has been retrieved and `availability.status` becomes `synced`.\n","uniqueKey":"availability.shifts.oneOf.0.available_count","typeLabel":"integer"},"files_count":{"type":"integer","description":"Total number of uploaded documents.","uniqueKey":"availability.shifts.oneOf.0.files_count","typeLabel":"integer"},"in_progress_count":{"type":"integer","description":"Total number of documents uploaded or response forms in progress but not submitted.","uniqueKey":"availability.shifts.oneOf.0.in_progress_count","typeLabel":"integer"},"available_from":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) of the earliest gig or paystub available.","uniqueKey":"availability.shifts.oneOf.0.available_from","typeLabel":"string\u003cdate-time>"},"available_to":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) of the latest gig or paystub available.","uniqueKey":"availability.shifts.oneOf.0.available_to","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"availability.shifts.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"availability.shifts.oneOf.1","typeLabel":"null"}],"uniqueKey":"availability.shifts","typeLabel":"object | null"},"gigs":{"oneOf":[{"type":"object","description":"Status of the account's most recent data scan (initial data retrieval included) or [document upload](/api-reference/user-uploads) submission.\n\n- `in_progress` — A data scan is in progress, or a document was uploaded but not submitted.\n- `synced` — The most recent data scan of the account was successful, or an uploaded document was submitted.\n- `sync_failed` — Data retrieval during the most recent data scan failed, resulting in an [account connection error](/api-reference/account-connection-errors).\n","properties":{"status":{"type":"string","enum":["in_progress","synced","sync_failed"],"uniqueKey":"availability.gigs.oneOf.0.status","typeLabel":"enum\u003cstring>"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) of the most recent change to available data.","uniqueKey":"availability.gigs.oneOf.0.updated_at","typeLabel":"string\u003cdate-time>"},"available_count":{"type":"integer","description":"Number of gig events, paystubs available, or response form submissions.\n\nDuring initial data retrieval, the `available_count` will increase until all data has been retrieved and `availability.status` becomes `synced`.\n","uniqueKey":"availability.gigs.oneOf.0.available_count","typeLabel":"integer"},"files_count":{"type":"integer","description":"Total number of uploaded documents.","uniqueKey":"availability.gigs.oneOf.0.files_count","typeLabel":"integer"},"in_progress_count":{"type":"integer","description":"Total number of documents uploaded or response forms in progress but not submitted.","uniqueKey":"availability.gigs.oneOf.0.in_progress_count","typeLabel":"integer"},"available_from":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) of the earliest gig or paystub available.","uniqueKey":"availability.gigs.oneOf.0.available_from","typeLabel":"string\u003cdate-time>"},"available_to":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) of the latest gig or paystub available.","uniqueKey":"availability.gigs.oneOf.0.available_to","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"availability.gigs.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"availability.gigs.oneOf.1","typeLabel":"null"}],"uniqueKey":"availability.gigs","typeLabel":"object | null"},"paystubs":{"oneOf":[{"type":"object","description":"Status of the account's most recent data scan (initial data retrieval included) or [document upload](/api-reference/user-uploads) submission.\n\n- `in_progress` — A data scan is in progress, or a document was uploaded but not submitted.\n- `synced` — The most recent data scan of the account was successful, or an uploaded document was submitted.\n- `sync_failed` — Data retrieval during the most recent data scan failed, resulting in an [account connection error](/api-reference/account-connection-errors).\n","properties":{"status":{"type":"string","enum":["in_progress","synced","sync_failed"],"uniqueKey":"availability.paystubs.oneOf.0.status","typeLabel":"enum\u003cstring>"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) of the most recent change to available data.","uniqueKey":"availability.paystubs.oneOf.0.updated_at","typeLabel":"string\u003cdate-time>"},"available_count":{"type":"integer","description":"Number of gig events, paystubs available, or response form submissions.\n\nDuring initial data retrieval, the `available_count` will increase until all data has been retrieved and `availability.status` becomes `synced`.\n","uniqueKey":"availability.paystubs.oneOf.0.available_count","typeLabel":"integer"},"files_count":{"type":"integer","description":"Total number of uploaded documents.","uniqueKey":"availability.paystubs.oneOf.0.files_count","typeLabel":"integer"},"in_progress_count":{"type":"integer","description":"Total number of documents uploaded or response forms in progress but not submitted.","uniqueKey":"availability.paystubs.oneOf.0.in_progress_count","typeLabel":"integer"},"available_from":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) of the earliest gig or paystub available.","uniqueKey":"availability.paystubs.oneOf.0.available_from","typeLabel":"string\u003cdate-time>"},"available_to":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) of the latest gig or paystub available.","uniqueKey":"availability.paystubs.oneOf.0.available_to","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"availability.paystubs.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"availability.paystubs.oneOf.1","typeLabel":"null"}],"uniqueKey":"availability.paystubs","typeLabel":"object | null"},"payroll_documents":{"oneOf":[{"type":"object","description":"Status of the account's most recent data scan (initial data retrieval included) or [document upload](/api-reference/user-uploads) submission.\n\n- `in_progress` — A data scan is in progress, or a document was uploaded but not submitted.\n- `synced` — The most recent data scan of the account was successful, or an uploaded document was submitted.\n- `sync_failed` — Data retrieval during the most recent data scan failed, resulting in an [account connection error](/api-reference/account-connection-errors).\n","properties":{"status":{"type":"string","enum":["in_progress","synced","sync_failed"],"uniqueKey":"availability.payroll_documents.oneOf.0.status","typeLabel":"enum\u003cstring>"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) of the most recent change to available data.","uniqueKey":"availability.payroll_documents.oneOf.0.updated_at","typeLabel":"string\u003cdate-time>"},"available_count":{"type":"integer","description":"Number of gig events, paystubs available, or response form submissions.\n\nDuring initial data retrieval, the `available_count` will increase until all data has been retrieved and `availability.status` becomes `synced`.\n","uniqueKey":"availability.payroll_documents.oneOf.0.available_count","typeLabel":"integer"},"files_count":{"type":"integer","description":"Total number of uploaded documents.","uniqueKey":"availability.payroll_documents.oneOf.0.files_count","typeLabel":"integer"},"in_progress_count":{"type":"integer","description":"Total number of documents uploaded or response forms in progress but not submitted.","uniqueKey":"availability.payroll_documents.oneOf.0.in_progress_count","typeLabel":"integer"},"available_from":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) of the earliest gig or paystub available.","uniqueKey":"availability.payroll_documents.oneOf.0.available_from","typeLabel":"string\u003cdate-time>"},"available_to":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) of the latest gig or paystub available.","uniqueKey":"availability.payroll_documents.oneOf.0.available_to","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"availability.payroll_documents.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"availability.payroll_documents.oneOf.1","typeLabel":"null"}],"uniqueKey":"availability.payroll_documents","typeLabel":"object | null"},"identities":{"oneOf":[{"type":"object","description":"Status of the account's most recent data scan (initial data retrieval included) or [document upload](/api-reference/user-uploads) submission.\n\n- `in_progress` — A data scan is in progress, or a document was uploaded but not submitted.\n- `synced` — The most recent data scan of the account was successful, or an uploaded document was submitted.\n- `sync_failed` — Data retrieval during the most recent data scan failed, resulting in an [account connection error](/api-reference/account-connection-errors).\n","properties":{"status":{"type":"string","enum":["in_progress","synced","sync_failed"],"uniqueKey":"availability.identities.oneOf.0.status","typeLabel":"enum\u003cstring>"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) of the most recent change to available data.","uniqueKey":"availability.identities.oneOf.0.updated_at","typeLabel":"string\u003cdate-time>"},"available_count":{"type":"integer","description":"Number of gig events, paystubs available, or response form submissions.\n\nDuring initial data retrieval, the `available_count` will increase until all data has been retrieved and `availability.status` becomes `synced`.\n","uniqueKey":"availability.identities.oneOf.0.available_count","typeLabel":"integer"},"files_count":{"type":"integer","description":"Total number of uploaded documents.","uniqueKey":"availability.identities.oneOf.0.files_count","typeLabel":"integer"},"in_progress_count":{"type":"integer","description":"Total number of documents uploaded or response forms in progress but not submitted.","uniqueKey":"availability.identities.oneOf.0.in_progress_count","typeLabel":"integer"},"available_from":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) of the earliest gig or paystub available.","uniqueKey":"availability.identities.oneOf.0.available_from","typeLabel":"string\u003cdate-time>"},"available_to":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) of the latest gig or paystub available.","uniqueKey":"availability.identities.oneOf.0.available_to","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"availability.identities.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"availability.identities.oneOf.1","typeLabel":"null"}],"uniqueKey":"availability.identities","typeLabel":"object | null"},"ratings":{"oneOf":[{"type":"object","description":"Status of the account's most recent data scan (initial data retrieval included) or [document upload](/api-reference/user-uploads) submission.\n\n- `in_progress` — A data scan is in progress, or a document was uploaded but not submitted.\n- `synced` — The most recent data scan of the account was successful, or an uploaded document was submitted.\n- `sync_failed` — Data retrieval during the most recent data scan failed, resulting in an [account connection error](/api-reference/account-connection-errors).\n","properties":{"status":{"type":"string","enum":["in_progress","synced","sync_failed"],"uniqueKey":"availability.ratings.oneOf.0.status","typeLabel":"enum\u003cstring>"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) of the most recent change to available data.","uniqueKey":"availability.ratings.oneOf.0.updated_at","typeLabel":"string\u003cdate-time>"},"available_count":{"type":"integer","description":"Number of gig events, paystubs available, or response form submissions.\n\nDuring initial data retrieval, the `available_count` will increase until all data has been retrieved and `availability.status` becomes `synced`.\n","uniqueKey":"availability.ratings.oneOf.0.available_count","typeLabel":"integer"},"files_count":{"type":"integer","description":"Total number of uploaded documents.","uniqueKey":"availability.ratings.oneOf.0.files_count","typeLabel":"integer"},"in_progress_count":{"type":"integer","description":"Total number of documents uploaded or response forms in progress but not submitted.","uniqueKey":"availability.ratings.oneOf.0.in_progress_count","typeLabel":"integer"},"available_from":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) of the earliest gig or paystub available.","uniqueKey":"availability.ratings.oneOf.0.available_from","typeLabel":"string\u003cdate-time>"},"available_to":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) of the latest gig or paystub available.","uniqueKey":"availability.ratings.oneOf.0.available_to","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"availability.ratings.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"availability.ratings.oneOf.1","typeLabel":"null"}],"uniqueKey":"availability.ratings","typeLabel":"object | null"},"vehicles":{"oneOf":[{"type":"object","description":"Status of the account's most recent data scan (initial data retrieval included) or [document upload](/api-reference/user-uploads) submission.\n\n- `in_progress` — A data scan is in progress, or a document was uploaded but not submitted.\n- `synced` — The most recent data scan of the account was successful, or an uploaded document was submitted.\n- `sync_failed` — Data retrieval during the most recent data scan failed, resulting in an [account connection error](/api-reference/account-connection-errors).\n","properties":{"status":{"type":"string","enum":["in_progress","synced","sync_failed"],"uniqueKey":"availability.vehicles.oneOf.0.status","typeLabel":"enum\u003cstring>"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) of the most recent change to available data.","uniqueKey":"availability.vehicles.oneOf.0.updated_at","typeLabel":"string\u003cdate-time>"},"available_count":{"type":"integer","description":"Number of gig events, paystubs available, or response form submissions.\n\nDuring initial data retrieval, the `available_count` will increase until all data has been retrieved and `availability.status` becomes `synced`.\n","uniqueKey":"availability.vehicles.oneOf.0.available_count","typeLabel":"integer"},"files_count":{"type":"integer","description":"Total number of uploaded documents.","uniqueKey":"availability.vehicles.oneOf.0.files_count","typeLabel":"integer"},"in_progress_count":{"type":"integer","description":"Total number of documents uploaded or response forms in progress but not submitted.","uniqueKey":"availability.vehicles.oneOf.0.in_progress_count","typeLabel":"integer"},"available_from":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) of the earliest gig or paystub available.","uniqueKey":"availability.vehicles.oneOf.0.available_from","typeLabel":"string\u003cdate-time>"},"available_to":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) of the latest gig or paystub available.","uniqueKey":"availability.vehicles.oneOf.0.available_to","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"availability.vehicles.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"availability.vehicles.oneOf.1","typeLabel":"null"}],"uniqueKey":"availability.vehicles","typeLabel":"object | null"},"deposit_destinations":{"oneOf":[{"type":"object","description":"Status of the account's most recent data scan (initial data retrieval included) or [document upload](/api-reference/user-uploads) submission.\n\n- `in_progress` — A data scan is in progress, or a document was uploaded but not submitted.\n- `synced` — The most recent data scan of the account was successful, or an uploaded document was submitted.\n- `sync_failed` — Data retrieval during the most recent data scan failed, resulting in an [account connection error](/api-reference/account-connection-errors).\n","properties":{"status":{"type":"string","enum":["in_progress","synced","sync_failed"],"uniqueKey":"availability.deposit_destinations.oneOf.0.status","typeLabel":"enum\u003cstring>"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) of the most recent change to available data.","uniqueKey":"availability.deposit_destinations.oneOf.0.updated_at","typeLabel":"string\u003cdate-time>"},"available_count":{"type":"integer","description":"Number of gig events, paystubs available, or response form submissions.\n\nDuring initial data retrieval, the `available_count` will increase until all data has been retrieved and `availability.status` becomes `synced`.\n","uniqueKey":"availability.deposit_destinations.oneOf.0.available_count","typeLabel":"integer"},"files_count":{"type":"integer","description":"Total number of uploaded documents.","uniqueKey":"availability.deposit_destinations.oneOf.0.files_count","typeLabel":"integer"},"in_progress_count":{"type":"integer","description":"Total number of documents uploaded or response forms in progress but not submitted.","uniqueKey":"availability.deposit_destinations.oneOf.0.in_progress_count","typeLabel":"integer"},"available_from":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) of the earliest gig or paystub available.","uniqueKey":"availability.deposit_destinations.oneOf.0.available_from","typeLabel":"string\u003cdate-time>"},"available_to":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) of the latest gig or paystub available.","uniqueKey":"availability.deposit_destinations.oneOf.0.available_to","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"availability.deposit_destinations.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"availability.deposit_destinations.oneOf.1","typeLabel":"null"}],"uniqueKey":"availability.deposit_destinations","typeLabel":"object | null"},"user_forms":{"oneOf":[{"type":"object","description":"Status of the account's most recent data scan (initial data retrieval included) or [document upload](/api-reference/user-uploads) submission.\n\n- `in_progress` — A data scan is in progress, or a document was uploaded but not submitted.\n- `synced` — The most recent data scan of the account was successful, or an uploaded document was submitted.\n- `sync_failed` — Data retrieval during the most recent data scan failed, resulting in an [account connection error](/api-reference/account-connection-errors).\n","properties":{"status":{"type":"string","enum":["in_progress","synced","sync_failed"],"uniqueKey":"availability.user_forms.oneOf.0.status","typeLabel":"enum\u003cstring>"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) of the most recent change to available data.","uniqueKey":"availability.user_forms.oneOf.0.updated_at","typeLabel":"string\u003cdate-time>"},"available_count":{"type":"integer","description":"Number of gig events, paystubs available, or response form submissions.\n\nDuring initial data retrieval, the `available_count` will increase until all data has been retrieved and `availability.status` becomes `synced`.\n","uniqueKey":"availability.user_forms.oneOf.0.available_count","typeLabel":"integer"},"files_count":{"type":"integer","description":"Total number of uploaded documents.","uniqueKey":"availability.user_forms.oneOf.0.files_count","typeLabel":"integer"},"in_progress_count":{"type":"integer","description":"Total number of documents uploaded or response forms in progress but not submitted.","uniqueKey":"availability.user_forms.oneOf.0.in_progress_count","typeLabel":"integer"},"available_from":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) of the earliest gig or paystub available.","uniqueKey":"availability.user_forms.oneOf.0.available_from","typeLabel":"string\u003cdate-time>"},"available_to":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) of the latest gig or paystub available.","uniqueKey":"availability.user_forms.oneOf.0.available_to","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"availability.user_forms.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"availability.user_forms.oneOf.1","typeLabel":"null"}],"uniqueKey":"availability.user_forms","typeLabel":"object | null"},"user_uploads":{"oneOf":[{"type":"object","description":"Status of the account's most recent data scan (initial data retrieval included) or [document upload](/api-reference/user-uploads) submission.\n\n- `in_progress` — A data scan is in progress, or a document was uploaded but not submitted.\n- `synced` — The most recent data scan of the account was successful, or an uploaded document was submitted.\n- `sync_failed` — Data retrieval during the most recent data scan failed, resulting in an [account connection error](/api-reference/account-connection-errors).\n","properties":{"status":{"type":"string","enum":["in_progress","synced","sync_failed"],"uniqueKey":"availability.user_uploads.oneOf.0.status","typeLabel":"enum\u003cstring>"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) of the most recent change to available data.","uniqueKey":"availability.user_uploads.oneOf.0.updated_at","typeLabel":"string\u003cdate-time>"},"available_count":{"type":"integer","description":"Number of gig events, paystubs available, or response form submissions.\n\nDuring initial data retrieval, the `available_count` will increase until all data has been retrieved and `availability.status` becomes `synced`.\n","uniqueKey":"availability.user_uploads.oneOf.0.available_count","typeLabel":"integer"},"files_count":{"type":"integer","description":"Total number of uploaded documents.","uniqueKey":"availability.user_uploads.oneOf.0.files_count","typeLabel":"integer"},"in_progress_count":{"type":"integer","description":"Total number of documents uploaded or response forms in progress but not submitted.","uniqueKey":"availability.user_uploads.oneOf.0.in_progress_count","typeLabel":"integer"},"available_from":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) of the earliest gig or paystub available.","uniqueKey":"availability.user_uploads.oneOf.0.available_from","typeLabel":"string\u003cdate-time>"},"available_to":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) of the latest gig or paystub available.","uniqueKey":"availability.user_uploads.oneOf.0.available_to","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"availability.user_uploads.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"availability.user_uploads.oneOf.1","typeLabel":"null"}],"uniqueKey":"availability.user_uploads","typeLabel":"object | null"}},"uniqueKey":"availability","typeLabel":"object"},"ongoing_refresh":{"type":"object","description":"Object containing the account's `ongoing_refresh` status (whether the account will be updated with new data after each [data refresh](/overview/ongoing-refresh#refresh-frequency)).","properties":{"status":{"type":"string","enum":["enabled","disabled","idle"],"description":"The account's `ongoing_refresh` status.\n\n- `idle` — This account never experienced a successful payroll connection — only uploading documents or only completing a \"can't find my income source\" response form is not considered a successful payroll connection.\n- `enabled` — Ongoing refresh is currently enabled for this connected payroll account.\n- `disabled` — Ongoing refresh is currently disabled for this connected payroll account.\n\nOngoing refresh can be [disabled manually](/api-reference/accounts#disable) via the API for individual accounts.\n","uniqueKey":"ongoing_refresh.status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"ongoing_refresh","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"id":"0187c66e-e7e5-811c-b006-2232f00f426a","user":"018051aa-f7a9-a0db-2f38-6cfa325e9d69","employers":["Whole Goods"],"item":"item_123456789","source":"thepayrollcompany","created_at":"2023-01-30T12:53:22.561Z","updated_at":"2023-01-30T12:55:04.478Z","scanned_at":"2023-01-30T12:55:04.016Z","connection":{"status":"connected","error_code":null,"error_message":null,"updated_at":"2023-01-30T12:53:25.561Z"},"direct_deposit_switch":{"status":"success","error_code":null,"error_message":null,"updated_at":"2023-01-30T12:55:03.478Z"},"availability":{"shifts":{"status":"synced","updated_at":"2023-01-30T12:55:03Z","available_count":94,"available_from":"2020-04-11T12:53:27Z","available_to":"2023-01-25T00:00:00Z"},"gigs":{"status":"synced","updated_at":"2023-01-30T12:55:03Z","available_count":217,"available_from":"2020-04-11T12:53:27Z","available_to":"2023-01-25T00:00:00Z"},"paystubs":{"status":"synced","updated_at":"2023-01-30T12:55:03Z","available_count":68,"available_from":"2020-05-11T12:53:27Z","available_to":"2023-01-29T23:59:59Z"},"payroll_documents":{"status":"synced","updated_at":"2023-01-30T12:53:44.308912Z"},"identities":{"status":"synced","updated_at":"2023-01-30T12:53:44.028552Z"},"ratings":{"status":"synced","updated_at":"2023-01-30T12:55:03.359356Z"},"vehicles":{"status":"synced","updated_at":"2023-01-30T12:53:44.321951Z"},"deposit_destinations":{"status":"synced","updated_at":"2023-01-30T12:53:42.586391Z"},"user_forms":{"status":"in_progress","updated_at":"2023-01-30T12:53:42.586391Z","available_count":0,"files_count":1,"in_progress_count":1,"user_uploads":{"status":"synced","updated_at":"2023-01-30T12:54:41.621Z","files_count":2,"in_progress_count":0}}},"ongoing_refresh":{"status":"enabled"}},"examples":{"Example":{"title":"Example","value":{"id":"0187c66e-e7e5-811c-b006-2232f00f426a","user":"018051aa-f7a9-a0db-2f38-6cfa325e9d69","employers":["Whole Goods"],"item":"item_123456789","source":"thepayrollcompany","created_at":"2023-01-30T12:53:22.561Z","updated_at":"2023-01-30T12:55:04.478Z","scanned_at":"2023-01-30T12:55:04.016Z","connection":{"status":"connected","error_code":null,"error_message":null,"updated_at":"2023-01-30T12:53:25.561Z"},"direct_deposit_switch":{"status":"success","error_code":null,"error_message":null,"updated_at":"2023-01-30T12:55:03.478Z"},"availability":{"shifts":{"status":"synced","updated_at":"2023-01-30T12:55:03Z","available_count":94,"available_from":"2020-04-11T12:53:27Z","available_to":"2023-01-25T00:00:00Z"},"gigs":{"status":"synced","updated_at":"2023-01-30T12:55:03Z","available_count":217,"available_from":"2020-04-11T12:53:27Z","available_to":"2023-01-25T00:00:00Z"},"paystubs":{"status":"synced","updated_at":"2023-01-30T12:55:03Z","available_count":68,"available_from":"2020-05-11T12:53:27Z","available_to":"2023-01-29T23:59:59Z"},"payroll_documents":{"status":"synced","updated_at":"2023-01-30T12:53:44.308912Z"},"identities":{"status":"synced","updated_at":"2023-01-30T12:53:44.028552Z"},"ratings":{"status":"synced","updated_at":"2023-01-30T12:55:03.359356Z"},"vehicles":{"status":"synced","updated_at":"2023-01-30T12:53:44.321951Z"},"deposit_destinations":{"status":"synced","updated_at":"2023-01-30T12:53:42.586391Z"},"user_forms":{"status":"in_progress","updated_at":"2023-01-30T12:53:42.586391Z","available_count":0,"files_count":1,"in_progress_count":1,"user_uploads":{"status":"synced","updated_at":"2023-01-30T12:54:41.621Z","files_count":2,"in_progress_count":0}}},"ongoing_refresh":{"status":"enabled"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"19988c29-c291-4676-9592-1c854cf5dc7f":{"basicAuth":{"type":"http","scheme":"basic","description":"Username = api_key_id, Password = api_key_secret","scopes":[]}}},"servers":{"76de092f-b2a2-4705-9150-5d74913f963f":{"url":"https://api-sandbox.argyle.com","description":"Sandbox"},"c740ec4b-7443-4350-824b-1b7b72d48d67":{"url":"https://api.argyle.com","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"basic","description":"Username = api_key_id, Password = api_key_secret","scopes":[]},"schema":{"title":"Basic Auth","type":"object","description":"Username = api_key_id, Password = api_key_secret","isRequired":true,"properties":{"username":{"type":"string","uniqueKey":"username","isRequired":true,"typeLabel":"string","deprecated":false},"password":{"type":"string","uniqueKey":"password","isRequired":true,"typeLabel":"string","deprecated":false}},"additionalProperties":false,"deprecated":false},"schemeName":"basicAuth","name":"Authorization"}],"title":"basicAuth"}]},"originalFileLocation":"openAPI/accounts.yaml"},"subdomain":"argyle","siteName":"Argyle Docs","title":"Retrieve An Account - Argyle Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-03-20T16:14:53.382Z","originalFileLocation":"api-reference/accounts/retrieve-an-account.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Retrieves an account object.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Argyle Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/argyle/cbIyejDMMl6E05gL/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/argyle/cbIyejDMMl6E05gL/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/argyle/cbIyejDMMl6E05gL/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/argyle/cbIyejDMMl6E05gL/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/argyle/cbIyejDMMl6E05gL/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/argyle/cbIyejDMMl6E05gL/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/argyle/cbIyejDMMl6E05gL/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/argyle/cbIyejDMMl6E05gL/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/argyle/cbIyejDMMl6E05gL/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Retrieve An Account - Argyle Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieves an account object.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Argyle Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.argyle.com/api-reference/accounts/retrieve-an-account\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://docs.argyle.com/images/social/argyle-docs.png\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Retrieve An Account - Argyle Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieves an account object.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://docs.argyle.com/images/social/argyle-docs.png\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/argyle/cbIyejDMMl6E05gL/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Argyle Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#214E48\">\u003cmeta data-mint-head name=\"og:image:alt\" content=\"Argyle\">\u003cmeta data-mint-head name=\"twitter:image:alt\" content=\"Argyle\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.argyle.com/api-reference/accounts/retrieve-an-account\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/accounts/retrieve-an-account.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.argyle.com/#organization\",\"name\":\"Argyle Docs\",\"url\":\"https://docs.argyle.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/argyle/HtlySCcYVcDJWXiY/logo/light.svg?fit=max\u0026auto=format\u0026n=HtlySCcYVcDJWXiY\u0026q=85\u0026s=3d77b5555b7fdd5185b855e858558376\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.argyle.com#website\",\"name\":\"Argyle Docs\",\"url\":\"https://docs.argyle.com\",\"publisher\":{\"@id\":\"https://docs.argyle.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.argyle.com/api-reference/accounts/retrieve-an-account#webpage\",\"url\":\"https://docs.argyle.com/api-reference/accounts/retrieve-an-account\",\"name\":\"Retrieve An Account\",\"description\":\"Retrieves an account object.\",\"dateModified\":\"2026-03-20T16:14:53.382Z\",\"isPartOf\":{\"@id\":\"https://docs.argyle.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.argyle.com/api-reference/accounts/retrieve-an-account#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.argyle.com/api-reference/accounts/retrieve-an-account#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Core Resources\",\"item\":\"https://docs.argyle.com/api-reference/users\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Accounts\",\"item\":\"https://docs.argyle.com/api-reference/accounts\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Retrieve An Account\",\"item\":\"https://docs.argyle.com/api-reference/accounts/retrieve-an-account\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.argyle.com/api-reference/accounts/retrieve-an-account#apireference\",\"headline\":\"Retrieve An Account\",\"name\":\"Retrieve An Account\",\"description\":\"Retrieves an account object.\",\"url\":\"https://docs.argyle.com/api-reference/accounts/retrieve-an-account\",\"mainEntityOfPage\":{\"@id\":\"https://docs.argyle.com/api-reference/accounts/retrieve-an-account#webpage\"},\"image\":\"https://docs.argyle.com/images/social/argyle-docs.png\",\"dateModified\":\"2026-03-20T16:14:53.382Z\",\"publisher\":{\"@id\":\"https://docs.argyle.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.argyle.com#website\"}}]}\u003c/script>","siteName":"Argyle Docs","nav":{"global":null,"products":[{"product":"Clients","icon":"building","description":"Build for your organization.","tabs":[{"tab":"Home","pages":[{"title":"Home","href":""}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/guides"}]},{"tab":"Verticals","pages":[{"title":"Verticals","href":"/verticals"}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"API Reference","href":"/api-reference/overview"}]},{"group":"Verifications","pages":[{"group":"Verifications","pages":[{"openapi":"openAPI/verifications.yaml post /v2/verifications","title":"Order a verification","sidebarTitle":"Order a verification","href":"/api-reference/verifications/order-a-verification"},{"openapi":"openAPI/verifications.yaml post /v2/sessions","title":"Create a session","sidebarTitle":"Create a session","href":"/api-reference/verifications/create-a-session"},{"openapi":"openAPI/verifications.yaml post /v2/verifications/refresh","title":"Refresh a verification","sidebarTitle":"Refresh a verification","href":"/api-reference/verifications/refresh-a-verification"},{"openapi":"openAPI/verifications.yaml get /v2/verifications/{id}","title":"Retrieve a verification","sidebarTitle":"Retrieve a verification","href":"/api-reference/verifications/retrieve-a-verification"},{"openapi":"openAPI/verifications.yaml patch /v2/verifications/{id}","title":"Update a verification","sidebarTitle":"Update a verification","href":"/api-reference/verifications/update-a-verification"},{"openapi":"openAPI/verifications.yaml post /v2/verifications/{id}/cancel","title":"Cancel a verification","sidebarTitle":"Cancel a verification","href":"/api-reference/verifications/cancel-a-verification"},{"openapi":"openAPI/verifications.yaml get /v2/verifications","title":"List all verifications","sidebarTitle":"List all verifications","href":"/api-reference/verifications/list-all-verifications"}]}]},{"group":"Core Resources","pages":[{"group":"Users","pages":[{"title":"Users","sidebarTitle":"Users","href":"/api-reference/users"},{"title":"Create A User","openapi":"post /v2/users","href":"/api-reference/users/create-a-user"},{"title":"Retrieve A User","openapi":"get /v2/users/{id}","href":"/api-reference/users/retrieve-a-user"},{"title":"Update A User","openapi":"patch /v2/users/{id}","href":"/api-reference/users/update-a-user"},{"title":"Delete A User","openapi":"delete /v2/users/{id}","href":"/api-reference/users/delete-a-user"},{"title":"List All Users","openapi":"get /v2/users","href":"/api-reference/users/list-all-users"}]},{"group":"User Tokens","pages":[{"title":"User Tokens","href":"/api-reference/user-tokens"},{"title":"Create A User Token","openapi":"post /v2/user-tokens","href":"/api-reference/user-tokens/create-a-user-token"}]},{"group":"Invites","pages":[{"title":"Invites","sidebarTitle":"Invites","href":"/api-reference/invites"},{"title":"Send An Invite","openapi":"post /v2/invites","href":"/api-reference/invites/send-an-invite"},{"title":"Retrieve An Invite","openapi":"get /v2/invites/{id}","href":"/api-reference/invites/retrieve-an-invite"},{"title":"Re-send an invite","openapi":"post /v2/invites/{id}","href":"/api-reference/invites/re-send-an-invite"},{"title":"Revoke An Invite","openapi":"post /v2/invites/{id}/revoke","href":"/api-reference/invites/revoke-an-invite"},{"title":"List All Invites","openapi":"get /v2/invites","href":"/api-reference/invites/list-all-invites"}]},{"group":"Accounts","pages":[{"description":"Accounts are payroll connections made through Link.","title":"Accounts","sidebarTitle":"Accounts","href":"/api-reference/accounts"},{"title":"Retrieve An Account","openapi":"openAPI/accounts.yaml get /v2/accounts/{id}","href":"/api-reference/accounts/retrieve-an-account"},{"title":"Delete An Account","description":"Deletes an account object.\n\n\u003cWarning>**Caution** - Deleting an account object will delete all resources associated with the account, such as paystubs or uploaded documents.\u003c/Warning>\n","openapi":"openAPI/accounts.yaml delete /v2/accounts/{id}","href":"/api-reference/accounts/delete-an-account"},{"title":"List All Accounts","openapi":"openAPI/accounts.yaml get /v2/accounts","href":"/api-reference/accounts/list-all-accounts"},{"title":"Disable Account Updates","openapi":"openAPI/accounts.yaml post /v2/accounts/{id}/disable-ongoing-refresh","href":"/api-reference/accounts/disable-account-updates"}]},{"group":"Employments","pages":[{"title":"Employments","sidebarTitle":"Employments","href":"/api-reference/employments"},{"title":"List All Employments","openapi":"get /v2/employments","href":"/api-reference/employments/list-all-employments"}]}]},{"group":"Coverage","pages":[{"group":"Items","pages":[{"title":"Items","sidebarTitle":"Items","href":"/api-reference/items"},{"title":"Retrieve An Item","openapi":"get /v2/items/{id}","href":"/api-reference/items/retrieve-an-item"},{"title":"List All Items","openapi":"get /v2/items","href":"/api-reference/items/list-all-items"},{"title":"Migrate a Link Item ID","openapi":"post /v2/item-migrations","href":"/api-reference/items/migrate-a-link-item-id"}]},{"group":"Item Filters","pages":[{"title":"Item Filters","sidebarTitle":"Item Filters","href":"/api-reference/item-filters"},{"title":"Create An Item Filter","openapi":"post /v2/item-filters","href":"/api-reference/item-filters/create-an-item-filter"},{"title":"Retrieve An Item Filter","openapi":"get /v2/item-filters/{id}","href":"/api-reference/item-filters/retrieve-an-item-filter"},{"title":"Replace An Item Filter","openapi":"put /v2/item-filters/{id}","href":"/api-reference/item-filters/replace-an-item-filter"},{"title":"Delete An Item Filter","openapi":"delete /v2/item-filters/{id}","href":"/api-reference/item-filters/delete-an-item-filter"},{"title":"List All Item Filters","openapi":"get /v2/item-filters","href":"/api-reference/item-filters/list-all-item-filters"}]},{"group":"Employer Search","pages":[{"title":"Employer Search","sidebarTitle":"Employer Search","href":"/api-reference/employer-search"},{"title":"List All Employers","openapi":"get /v2/employer-search","href":"/api-reference/employer-search/list-all-employers"}]}]},{"group":"Payroll Data Sets","pages":[{"group":"Identities","pages":[{"title":"Identities","sidebarTitle":"Identities","href":"/api-reference/identities"},{"title":"Retrieve An Identity","openapi":"get /v2/identities/{id}","href":"/api-reference/identities/retrieve-an-identity"},{"title":"List All Identities","openapi":"get /v2/identities","href":"/api-reference/identities/list-all-identities"}]},{"group":"Paystubs","pages":[{"title":"Paystubs","sidebarTitle":"Paystubs","href":"/api-reference/paystubs"},{"title":"Retrieve A Paystub","openapi":"get /v2/paystubs/{id}","href":"/api-reference/paystubs/retrieve-a-paystub"},{"title":"List All Paystubs","openapi":"get /v2/paystubs","href":"/api-reference/paystubs/list-all-paystubs"}]},{"group":"Payroll Documents","pages":[{"title":"Payroll Documents","sidebarTitle":"Payroll Documents","href":"/api-reference/payroll-documents"},{"title":"Retrieve A Payroll Document","openapi":"get /v2/payroll-documents/{id}","href":"/api-reference/payroll-documents/retrieve-a-payroll-document"},{"title":"List All Payroll Documents","openapi":"get /v2/payroll-documents","href":"/api-reference/payroll-documents/list-all-payroll-documents"}]},{"group":"Deposit Destinations","pages":[{"title":"Deposit Destinations","sidebarTitle":"Deposit Destinations","href":"/api-reference/deposit-destinations"},{"title":"Retrieve A Deposit Destination","openapi":"get /v2/deposit-destinations/{id}","href":"/api-reference/deposit-destinations/retrieve-a-deposit-destination"},{"title":"List All Deposit Destinations","openapi":"get /v2/deposit-destinations","href":"/api-reference/deposit-destinations/list-all-deposit-destinations"}]},{"group":"Shifts","pages":[{"title":"Shifts","sidebarTitle":"Shifts","href":"/api-reference/shifts"},{"title":"Retrieve A Shift","openapi":"get /v2/shifts/{id}","href":"/api-reference/shifts/retrieve-a-shift"},{"title":"List All Shifts","openapi":"get /v2/shifts","href":"/api-reference/shifts/list-all-shifts"}]},{"group":"Gigs","pages":[{"title":"Gigs","sidebarTitle":"Gigs","href":"/api-reference/gigs"},{"title":"Retrieve A Gig","openapi":"get /v2/gigs/{id}","href":"/api-reference/gigs/retrieve-a-gig"},{"title":"List All Gigs","openapi":"get /v2/gigs","href":"/api-reference/gigs/list-all-gigs"}]},{"group":"Vehicles","pages":[{"title":"Vehicles","sidebarTitle":"Vehicles","href":"/api-reference/vehicles"},{"title":"Retrieve A Vehicle","openapi":"get /v2/vehicles/{id}","href":"/api-reference/vehicles/retrieve-a-vehicle"},{"title":"List All Vehicles","openapi":"get /v2/vehicles","href":"/api-reference/vehicles/list-all-vehicles"}]},{"group":"Ratings","pages":[{"title":"Ratings","sidebarTitle":"Ratings","href":"/api-reference/ratings"},{"title":"Retrieve A Rating","openapi":"get /v2/ratings/{id}","href":"/api-reference/ratings/retrieve-a-rating"},{"title":"List All Ratings","openapi":"get /v2/ratings","href":"/api-reference/ratings/list-all-ratings"}]}]},{"group":"Banking","pages":[{"group":"Financial Institutions","pages":[{"title":"Financial Institutions","sidebarTitle":"Financial Institutions","href":"/api-reference/financial-institutions"},{"openapi":"get /v2/open-banking/institutions/{institution_id}","title":"Retrieve an institution","href":"/api-reference/financial-institutions/retrieve-an-institution"},{"openapi":"get /v2/open-banking/institutions","title":"List all institutions","href":"/api-reference/financial-institutions/list-all-institutions"}]},{"group":"Bank Accounts","pages":[{"title":"Bank Accounts","sidebarTitle":"Bank Accounts","href":"/api-reference/bank-accounts"},{"openapi":"get /v2/open-banking/bank-accounts/{bank_account_id}","title":"Retrieve a bank account","href":"/api-reference/bank-accounts/retrieve-a-bank-account"},{"openapi":"get /v2/open-banking/bank-accounts","title":"List all bank accounts","href":"/api-reference/bank-accounts/list-all-bank-accounts"}]}]},{"group":"Reports","pages":[{"group":"Reports","pages":[{"title":"Reports","sidebarTitle":"Reports","href":"/api-reference/reports"},{"title":"List All Reports","openapi":"get /v2/reports","href":"/api-reference/reports/list-all-reports"},{"title":"Generate A Report","openapi":"post /v2/reports/{type}","href":"/api-reference/reports/generate-a-report"},{"title":"Retrieve A Report","openapi":"get /v2/reports/{id}","href":"/api-reference/reports/retrieve-a-report"},{"title":"Delete A Report","openapi":"delete /v2/reports/{id}","href":"/api-reference/reports/delete-a-report"}]}]},{"group":"Workflows","pages":[{"group":"User Uploads","pages":[{"title":"User Uploads","sidebarTitle":"User Uploads","href":"/api-reference/user-uploads"},{"title":"Upload A Document","openapi":"post /v2/user-uploads","href":"/api-reference/user-uploads/upload-a-document"},{"title":"Retrieve A User Upload","openapi":"get /v2/user-uploads/{id}","href":"/api-reference/user-uploads/retrieve-a-user-upload"},{"title":"List All User Uploads","openapi":"get /v2/user-uploads","href":"/api-reference/user-uploads/list-all-user-uploads"}]},{"group":"User Forms","pages":[{"title":"User Forms","sidebarTitle":"User Forms","href":"/api-reference/user-forms"},{"title":"Retrieve A User Form","openapi":"get /v2/user-forms/{id}","href":"/api-reference/user-forms/retrieve-a-user-form"},{"title":"List All User Forms","openapi":"get /v2/user-forms","href":"/api-reference/user-forms/list-all-user-forms"}]},{"group":"Legacy Workflows","pages":[{"title":"Document Verifications","sidebarTitle":"Legacy Documents","href":"/api-reference/documents-overview"},{"group":"Legacy Banking","pages":[{"title":"Banking Overview Guide","sidebarTitle":"Overview Guide","href":"/api-reference/banking-overview"},{"group":"Connect URL","pages":[{"title":"Connect URL","openapi":"openAPI/open-banking.yaml post /v2/open-banking/connect","href":"/api-reference/connect-url"},{"openapi":"post /v2/open-banking/connect","title":"Create a Connect URL","href":"/api-reference/connect-url/create-a-connect-url"}]},{"group":"Banking Reports","pages":[{"title":"Banking Reports","href":"/api-reference/banking-reports"},{"openapi":"post /v2/open-banking/reports/{type}","title":"Generate a banking report","href":"/api-reference/banking-reports/generate-a-banking-report"}]}]}]}]},{"group":"Webhooks","pages":[{"group":"Users","pages":[{"title":"Users.fully_synced webhook","openapi":"openAPI/users-webhooks.yaml post /v2/webhooks","sidebarTitle":"Fully synced","href":"/api-reference/users-webhooks/fully-synced"}]},{"group":"Accounts","pages":[{"title":"Accounts.added webhook","openapi":"openAPI/account-webhooks-added.yaml post /v2/webhooks","sidebarTitle":"Added","href":"/api-reference/accounts-webhooks/added"},{"title":"Accounts.updated webhook","openapi":"openAPI/account-webhook-updated.yaml post /v2/webhooks","sidebarTitle":"Updated","href":"/api-reference/accounts-webhooks/updated"},{"title":"Accounts.removed webhook","openapi":"openAPI/accounts-webhooks-removed.yaml post /v2/webhooks","sidebarTitle":"Removed","href":"/api-reference/accounts-webhooks/removed"},{"title":"Accounts.connected webhook","openapi":"openAPI/accounts-webhooks-connected.yaml post /v2/webhooks","sidebarTitle":"Connected","href":"/api-reference/accounts-webhooks/connected"},{"title":"Accounts.failed webhook","openapi":"openAPI/accounts-webhooks-failed.yaml post /v2/webhooks","sidebarTitle":"Failed","href":"/api-reference/accounts-webhooks/failed"}]},{"group":"Items","pages":[{"title":"Items.updated webhook","openapi":"openAPI/items-webhooks-updated.yaml post /v2/webhooks","sidebarTitle":"Updated","href":"/api-reference/items-webhooks/updated"},{"title":"Items.removed webhook","openapi":"openAPI/items-webhooks-removed.yaml post /v2/webhooks","sidebarTitle":"Removed","href":"/api-reference/items-webhooks/removed"}]},{"group":"Identities","pages":[{"title":"Identities.added webhook","openapi":"openAPI/identities-webhooks-added.yaml post /v2/webhooks","sidebarTitle":"Added","href":"/api-reference/identities-webhooks/added"},{"title":"Identities.updated webhook","openapi":"openAPI/identities-webhooks-updated.yaml post /v2/webhooks","sidebarTitle":"Updated","href":"/api-reference/identities-webhooks/updated"}]},{"group":"Paystubs","pages":[{"title":"Paystubs.added webhook","openapi":"openAPI/paystubs-webhooks-added.yaml post /v2/webhooks","sidebarTitle":"Added","href":"/api-reference/paystubs-webhooks/added"},{"title":"Paystubs.updated webhook","openapi":"openAPI/paystubs-webhooks-updated.yaml post /v2/webhooks","sidebarTitle":"Updated","href":"/api-reference/paystubs-webhooks/updated"},{"title":"Paystubs.partially_synced webhook","openapi":"openAPI/paystubs-webhooks-partially-synced.yaml post /v2/webhooks","sidebarTitle":"Partially synced","href":"/api-reference/paystubs-webhooks/partially-synced"},{"title":"Paystubs.fully_synced webhook","openapi":"openAPI/paystubs-webhooks-fully-synced.yaml post /v2/webhooks","sidebarTitle":"Fully synced","href":"/api-reference/paystubs-webhooks/fully-synced"}]},{"group":"Payroll Documents","pages":[{"title":"Payroll Documents.added webhook","openapi":"openAPI/payroll-documents-webhooks-added.yaml post /v2/webhooks","sidebarTitle":"Added","href":"/api-reference/payroll-documents-webhooks/added"},{"title":"Payroll Documents.updated webhook","openapi":"openAPI/payroll-documents-webhooks-updated.yaml post /v2/webhooks","sidebarTitle":"Updated","href":"/api-reference/payroll-documents-webhooks/updated"},{"title":"Payroll Documents.removed webhook","openapi":"openAPI/payroll-documents-webhooks-removed.yaml post /v2/webhooks","sidebarTitle":"Removed","href":"/api-reference/payroll-documents-webhooks/removed"},{"title":"Payroll Documents.ocr_completed webhook","openapi":"openAPI/payroll-documents-webhooks-ocr-completed.yaml post /v2/webhooks","sidebarTitle":"OCR completed","href":"/api-reference/payroll-documents-webhooks/ocr-completed"},{"title":"Payroll Documents.ocr_failed webhook","openapi":"openAPI/payroll-documents-webhooks-ocr-failed.yaml post /v2/webhooks","sidebarTitle":"OCR failed","href":"/api-reference/payroll-documents-webhooks/ocr-failed"}]},{"group":"Shifts","pages":[{"title":"Shifts.added webhook","openapi":"openAPI/shifts-webhooks-added.yaml post /v2/webhooks","sidebarTitle":"Added","href":"/api-reference/shifts-webhooks/added"},{"title":"Shifts.updated webhook","openapi":"openAPI/shifts-webhooks-updated.yaml post /v2/webhooks","sidebarTitle":"Updated","href":"/api-reference/shifts-webhooks/updated"},{"title":"Shifts.removed webhook","openapi":"openAPI/shifts-webhooks-removed.yaml post /v2/webhooks","sidebarTitle":"Removed","href":"/api-reference/shifts-webhooks/removed"},{"title":"Shifts.partially_synced webhook","openapi":"openAPI/shifts-webhooks-partially-synced.yaml post /v2/webhooks","sidebarTitle":"Partially synced","href":"/api-reference/shifts-webhooks/partially-synced"},{"title":"Shifts.fully_synced webhook","openapi":"openAPI/shifts-webhooks-fully-synced.yaml post /v2/webhooks","sidebarTitle":"Fully synced","href":"/api-reference/shifts-webhooks/fully-synced"}]},{"group":"Gigs","pages":[{"openapi":"openAPI/gigs-webhooks-added.yaml post /v2/webhooks","title":"Gigs.added webhook","sidebarTitle":"Added","href":"/api-reference/gigs-webhooks/added"},{"openapi":"openAPI/gigs-webhooks-updated.yaml post /v2/webhooks","title":"Gigs.updated webhook","sidebarTitle":"Updated","href":"/api-reference/gigs-webhooks/updated"},{"openapi":"openAPI/gigs-webhooks-removed.yaml post /v2/webhooks","title":"Gigs.removed webhook","sidebarTitle":"Removed","href":"/api-reference/gigs-webhooks/removed"},{"openapi":"openAPI/gigs-webhooks-partially-synced.yaml post /v2/webhooks","title":"Gigs.partially_synced webhook","sidebarTitle":"Partially synced","href":"/api-reference/gigs-webhooks/partially-synced"},{"openapi":"openAPI/gigs-webhooks-fully-synced.yaml post /v2/webhooks","title":"Gigs.fully_synced webhook","sidebarTitle":"Fully synced","href":"/api-reference/gigs-webhooks/fully-synced"}]},{"group":"Vehicles","pages":[{"openapi":"openAPI/vehicles-webhooks-added.yaml post /v2/webhooks","title":"Vehicles.added webhook","sidebarTitle":"Added","href":"/api-reference/vehicles-webhooks/added"},{"openapi":"openAPI/vehicles-webhooks-updated.yaml post /v2/webhooks","title":"Vehicles.updated webhook","sidebarTitle":"Updated","href":"/api-reference/vehicles-webhooks/updated"},{"openapi":"openAPI/vehicles-webhooks-removed.yaml post /v2/webhooks","title":"Vehicles.removed webhook","sidebarTitle":"Removed","href":"/api-reference/vehicles-webhooks/removed"}]},{"group":"Ratings","pages":[{"openapi":"openAPI/ratings-webhooks-added.yaml post /v2/webhooks","title":"Ratings.added webhook","sidebarTitle":"Added","href":"/api-reference/ratings-webhooks/added"},{"openapi":"openAPI/ratings-webhooks-updated.yaml post /v2/webhooks","title":"Ratings.updated webhook","sidebarTitle":"Updated","href":"/api-reference/ratings-webhooks/updated"}]},{"group":"Reports","pages":[{"openapi":"openAPI/reports-webhooks-ready.yaml post /v2/webhooks","title":"Reports.ready webhook","sidebarTitle":"Ready","href":"/api-reference/reports-webhooks/ready"},{"openapi":"openAPI/reports-webhooks-generated.yaml post /v2/webhooks","title":"Reports.generated webhook","sidebarTitle":"Generated","href":"/api-reference/reports-webhooks/generated"}]},{"group":"User Uploads","pages":[{"openapi":"openAPI/user-uploads-webhooks-added.yaml post /v2/webhooks","title":"User Uploads.added webhook","sidebarTitle":"Added","href":"/api-reference/user-uploads-webhooks/added"},{"openapi":"openAPI/user-uploads-webhooks-removed.yaml post /v2/webhooks","title":"User Uploads.removed webhook","sidebarTitle":"Removed","href":"/api-reference/user-uploads-webhooks/removed"},{"openapi":"openAPI/user-uploads-webhooks-ocr-completed.yaml post /v2/webhooks","title":"User Uploads.ocr_completed webhook","sidebarTitle":"OCR Completed","href":"/api-reference/user-uploads-webhooks/ocr-completed"},{"openapi":"openAPI/user-uploads-webhooks-ocr-failed.yaml post /v2/webhooks","title":"User Uploads.ocr_failed webhook","sidebarTitle":"OCR Failed","href":"/api-reference/user-uploads-webhooks/ocr-failed"},{"openapi":"openAPI/user-uploads-webhooks-ocr-authenticity.yaml post /v2/webhooks","title":"User Uploads.ocr_authenticity webhook","sidebarTitle":"OCR Authenticity","href":"/api-reference/user-uploads-webhooks/ocr-authenticity"}]},{"group":"User Forms","pages":[{"title":"User Forms.submitted webhook","openapi":"openAPI/user-forms-webhooks.yaml post /v2/webhooks","sidebarTitle":"Submitted","href":"/api-reference/user-forms-webhooks/user-forms-submitted"},{"title":"User Forms.removed webhook","openapi":"openAPI/user-forms-webhooks-removed.yaml post /v2/webhooks","sidebarTitle":"Removed","href":"/api-reference/user-forms-webhooks/user-forms-removed"}]},{"group":"Verifications","pages":[{"title":"Verifications.updated webhook","openapi":"openAPI/verifications-webhooks-updated.yaml post /v2/webhooks","sidebarTitle":"Updated","href":"/api-reference/verifications-webhooks/updated"},{"title":"Verifications.creation_failed webhook","openapi":"openAPI/verifications-webhooks-creation-failed.yaml post /v2/webhooks","sidebarTitle":"Creation failed","href":"/api-reference/verifications-webhooks/creation-failed"},{"title":"Verifications.connection_added webhook","openapi":"openAPI/verifications-webhooks-connection-added.yaml post /v2/webhooks","sidebarTitle":"Connection added","href":"/api-reference/verifications-webhooks/connection-added"}]},{"group":"Webhook management","pages":[{"title":"Create a webhook","openapi":"openAPI/webhooks.yaml post /v2/webhooks","href":"/api-reference/webhooks/create-a-webhook"},{"title":"Retrieve a webhook","openapi":"openAPI/webhooks.yaml get /v2/webhooks/{id}","href":"/api-reference/webhooks/retrieve-a-webhook"},{"title":"Delete a webhook","openapi":"openAPI/webhooks.yaml delete /v2/webhooks/{id}","href":"/api-reference/webhooks/delete-a-webhook"},{"title":"List all webhooks","openapi":"openAPI/webhooks.yaml get /v2/webhooks","href":"/api-reference/webhooks/list-all-webhooks"}]}]},{"group":"Receipts","pages":[{"group":"Receipts","pages":[{"openapi":"post /v2/receipts","title":"Receipts","href":"/api-reference/receipts"}]}]},{"group":"Error Codes","pages":[{"title":"Account Connection Errors","sidebarTitle":"Account Connection Errors","href":"/api-reference/account-connection-errors"},{"title":"Bank Connection Errors","sidebarTitle":"Bank Connection Errors","href":"/api-reference/bank-connection-errors"}]}]}]},{"product":"Partners","icon":"puzzle-piece","description":"Build for your customers.","pages":[{"title":"Partners","href":"/partners"}]},{"product":"Changelog","description":"Product updates and announcements","pages":[{"title":"Changelog","href":"/changelog"}]}]},"title":"Retrieve An Account - Argyle Docs","buildId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","deploymentId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-26-lDe7V.js","utils-CWQmgYtH.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-4-Aw3rSD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C2zjXYA5.js","snippetPresets-DFmpFA7C.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-FJpQavWq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D_GvPF7k.js","shallow-Bs2ZB0NO.js","getApiPlaygroundDisplay-DCcqJJk-.js","CodeSnippet-DzDxawVe.js","CodeSnippets-aUr7fU-7.js","Page-CT9uE8Ip.js","getPastedJson-Y1fKsj_I.js","icon-DI4zTsDr.js","MethodPill-C0nDlmSQ.js","DuplicateIcon-NUXbx2nQ.js","createIcon-BdTHrPAi.js","DynamicMarkdown-CtpgKJwj.js","SectionHeading-B3x35tOt.js","axios-vUo_bRtp.js","Markdown-3OmurJMP.js","clsx-DMKzROTp.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-1ms6tsT-.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Ke9xIMFx.js"]}