A single employer is usually returned per account. Exceptions can occur when an LLC and Co. version of the same employer is returned.
item
string
ID of the Item in Link through which the account was connected.
source
string
Payroll data source. Typically a third-party payroll system unless the employer uses an in-house system.
created_at
string<date-time>
Timestamp (ISO 8601) when the user connected the account.
updated_at
string<date-time>
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).
scanned_at
string<date-time>
Timestamp (ISO 8601) when the account was last scanned for new data. A null value indicates the account was never connected.
connection
object
Object containing information about the account's connection status.
Show child attributes
direct_deposit_switch
object
Object containing deposit switch status information.
Show child attributes
availability
object
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.
Show child attributes
ongoing_refresh
object
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-connection-removed.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-connection-removed.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":""},"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":"6af73bf607e6a796f0fe6fd5","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"Clients","count":216},{"language":"default","tag":"API Reference","count":171},{"language":"default","tag":"Guides","count":76},{"language":"default","tag":"Webhooks","count":51},{"language":"default","tag":"Partners","count":41},{"language":"default","tag":"Verifications","count":39},{"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":[],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","href":"/_mintlify/custom/argyle/225e00a80fa65353/style.css"},{"filePath":"changelog.css","href":"/_mintlify/custom/argyle/43713bf2b359289f/changelog.css"}],"page":{"pagePath":"api-reference/partners-data-sets/retrieve-an-account","slug":"/api-reference/partners-data-sets/retrieve-an-account","pageMetadata":{"title":"Retrieve An Account","description":"Retrieves a payroll account object.\n","openapi":"openAPI/verifications-partners.yaml get /partners/v2/accounts/{id}","sidebarTitle":"Retrieve an account","badge":"GET","href":"/api-reference/partners-data-sets/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 a payroll 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 a payroll account object.\n","openapi":"openAPI/verifications-partners.yaml get /partners/v2/accounts/{id}","sidebarTitle":"Retrieve an account","badge":"GET","href":"/api-reference/partners-data-sets/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/74858b35daa8e825/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 a payroll account object.\n","parameters":["f3593404-28f1-4d60-86ca-28256332b8c9"],"responses":{"200":"7b97076e-f574-40e2-8be4-2f4942681726"},"method":"get","type":"path","servers":["94806158-5ada-4df3-91f7-3d86682ef5bf","0834b735-5f1a-4687-8add-7c4329fb1c93"],"security":["697c9dff-2ef2-4c3e-a03b-eba8960acfb7"],"path":"/partners/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":{"f3593404-28f1-4d60-86ca-28256332b8c9":{"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":{"7b97076e-f574-40e2-8be4-2f4942681726":{"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":{"697c9dff-2ef2-4c3e-a03b-eba8960acfb7":{"basicAuth":{"type":"http","scheme":"basic","description":"Username = api_key_id, Password = api_key_secret","scopes":[],"schemeName":"basicAuth"}}},"servers":{"94806158-5ada-4df3-91f7-3d86682ef5bf":{"url":"https://api-sandbox.argyle.com","description":"Sandbox"},"0834b735-5f1a-4687-8add-7c4329fb1c93":{"url":"https://api.argyle.com","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"basic","description":"Username = api_key_id, Password = api_key_secret","scopes":[],"schemeName":"basicAuth"},"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/verifications-partners.yaml"},"subdomain":"argyle","siteName":"Argyle Docs","title":"Retrieve An Account - Argyle Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-05T17:39:51.510Z","originalFileLocation":"api-reference/partners-data-sets/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 a payroll 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 a payroll 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/partners-data-sets/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 a payroll 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/partners-data-sets/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/partners-data-sets/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/partners-data-sets/retrieve-an-account#webpage\",\"url\":\"https://docs.argyle.com/api-reference/partners-data-sets/retrieve-an-account\",\"name\":\"Retrieve An Account\",\"description\":\"Retrieves a payroll account object.\",\"dateModified\":\"2026-10-05T17:39:51.510Z\",\"isPartOf\":{\"@id\":\"https://docs.argyle.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.argyle.com/api-reference/partners-data-sets/retrieve-an-account#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.argyle.com/api-reference/partners-data-sets/retrieve-an-account#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Argyle Docs\",\"item\":\"https://docs.argyle.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Retrieve An Account\",\"item\":\"https://docs.argyle.com/api-reference/partners-data-sets/retrieve-an-account\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.argyle.com/api-reference/partners-data-sets/retrieve-an-account#apireference\",\"headline\":\"Retrieve An Account\",\"name\":\"Retrieve An Account\",\"description\":\"Retrieves a payroll account object.\",\"url\":\"https://docs.argyle.com/api-reference/partners-data-sets/retrieve-an-account\",\"mainEntityOfPage\":{\"@id\":\"https://docs.argyle.com/api-reference/partners-data-sets/retrieve-an-account#webpage\"},\"image\":\"https://docs.argyle.com/images/social/argyle-docs.png\",\"dateModified\":\"2026-10-05T17:39:51.510Z\",\"publisher\":{\"@id\":\"https://docs.argyle.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.argyle.com#website\"}}]}\u003c/script>","agentPointerHref":"/api-reference/partners-data-sets/retrieve-an-account.md","siteName":"Argyle Docs","nav":{"global":null,"products":[{"product":"Clients","icon":"building","description":"Build for your organization.","pages":[{"title":"Clients","href":""}]},{"product":"Partners","icon":"puzzle-piece","description":"Build for your customers.","tabs":[{"tab":"Home","pages":[{"title":"Home","href":"/partners"}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/verifications/platform-partners"}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"Partner API Reference","href":"/partners/api-reference"}]},{"group":"Users","pages":[{"openapi":"openAPI/verifications-partners.yaml post /partners/v2/users","title":"Create a user","sidebarTitle":"Create a user","href":"/api-reference/partners-verifications/create-a-user"},{"openapi":"openAPI/verifications-partners.yaml patch /partners/v2/users/{id}","title":"Update a user","sidebarTitle":"Update a user","href":"/api-reference/partners-verifications/update-a-user"}]},{"group":"Partner Verifications","pages":[{"openapi":"openAPI/verifications-partners.yaml post /partners/v2/verifications","title":"Order a verification","sidebarTitle":"Order a verification","href":"/api-reference/partners-verifications/order-a-verification"},{"openapi":"openAPI/verifications-partners.yaml post /partners/v2/sessions","title":"Create a session","sidebarTitle":"Create a session","href":"/api-reference/partners-verifications/create-a-session"},{"openapi":"openAPI/verifications-partners.yaml post /partners/v2/verifications/refresh","title":"Refresh a verification","sidebarTitle":"Refresh a verification","href":"/api-reference/partners-verifications/refresh-a-verification"},{"openapi":"openAPI/verifications-partners.yaml get /partners/v2/verifications/{id}","title":"Retrieve a verification","sidebarTitle":"Retrieve a verification","href":"/api-reference/partners-verifications/retrieve-a-verification"},{"openapi":"openAPI/verifications-partners.yaml patch /partners/v2/verifications/{id}","title":"Update a verification","sidebarTitle":"Update a verification","href":"/api-reference/partners-verifications/update-a-verification"},{"openapi":"openAPI/verifications-partners.yaml post /partners/v2/verifications/{id}/cancel","title":"Cancel a verification","sidebarTitle":"Cancel a verification","href":"/api-reference/partners-verifications/cancel-a-verification"},{"openapi":"openAPI/verifications-partners.yaml get /partners/v2/verifications","title":"List all verifications","sidebarTitle":"List all verifications","href":"/api-reference/partners-verifications/list-all-verifications"},{"title":"Upload a document","sidebarTitle":"Upload a document","openapi":"openAPI/verifications-partners.yaml post /partners/v2/user-uploads","href":"/api-reference/partners-verifications/upload-a-document"}]},{"group":"Partner Webhooks","pages":[{"title":"Verifications.updated webhook","openapi":"openAPI/verifications-partners-webhooks-updated.yaml post /partners/v2/webhooks","sidebarTitle":"Updated","href":"/api-reference/partners-webhooks/updated"},{"title":"Verifications.creation_failed webhook","openapi":"openAPI/verifications-partners-webhooks-creation-failed.yaml post /partners/v2/webhooks","sidebarTitle":"Creation failed","href":"/api-reference/partners-webhooks/creation-failed"},{"title":"Verifications.connection_added webhook","openapi":"openAPI/verifications-partners-webhooks-connection-added.yaml post /partners/v2/webhooks","sidebarTitle":"Connection added","href":"/api-reference/partners-webhooks/connection-added"},{"title":"Verifications.connection_removed webhook","openapi":"openAPI/verifications-partners-webhooks-connection-removed.yaml post /partners/v2/webhooks","sidebarTitle":"Connection removed","href":"/api-reference/partners-webhooks/connection-removed"},{"group":"Webhook management","pages":[{"title":"Create a webhook","openapi":"openAPI/webhooks.yaml post /partners/v2/webhooks","href":"/api-reference/partners-webhooks/create-a-webhook"},{"title":"Retrieve a webhook","openapi":"openAPI/webhooks.yaml get /partners/v2/webhooks/{id}","href":"/api-reference/partners-webhooks/retrieve-a-webhook"},{"title":"Delete a webhook","openapi":"openAPI/webhooks.yaml delete /partners/v2/webhooks/{id}","href":"/api-reference/partners-webhooks/delete-a-webhook"},{"title":"List all webhooks","description":"Returns a paginated list of webhook subscriptions.\n","openapi":"openAPI/webhooks.yaml get /partners/v2/webhooks","href":"/api-reference/partners-webhooks/list-all-webhooks"}]}]},{"group":"Partner Data Sets","pages":[{"title":"Retrieve An Account","openapi":"openAPI/verifications-partners.yaml get /partners/v2/accounts/{id}","sidebarTitle":"Retrieve an account","href":"/api-reference/partners-data-sets/retrieve-an-account"},{"title":"List All Accounts","description":"Returns a paginated list of all payroll account objects.\n","openapi":"openAPI/verifications-partners.yaml get /partners/v2/accounts","sidebarTitle":"List all accounts","href":"/api-reference/partners-data-sets/list-all-accounts"},{"title":"Retrieve a bank account","openapi":"openAPI/verifications-partners.yaml get /partners/v2/bank-accounts/{bank_account_id}","sidebarTitle":"Retrieve a bank account","href":"/api-reference/partners-data-sets/retrieve-a-bank-account"},{"title":"List all bank accounts","openapi":"openAPI/verifications-partners.yaml get /partners/v2/bank-accounts","sidebarTitle":"List all bank accounts","href":"/api-reference/partners-data-sets/list-all-bank-accounts"},{"openapi":"openAPI/verifications-partners.yaml get /partners/v2/payroll-documents/{id}","title":"Retrieve a payroll document","sidebarTitle":"Retrieve a payroll document","href":"/api-reference/partners-data-sets/retrieve-a-payroll-document"},{"openapi":"openAPI/verifications-partners.yaml get /partners/v2/payroll-documents","title":"List all payroll documents","sidebarTitle":"List all payroll documents","href":"/api-reference/partners-data-sets/list-all-payroll-documents"},{"openapi":"openAPI/verifications-partners.yaml get /partners/v2/paystubs/{id}","title":"Retrieve a paystub","sidebarTitle":"Retrieve a paystub","href":"/api-reference/partners-data-sets/retrieve-a-paystub"},{"openapi":"openAPI/verifications-partners.yaml get /partners/v2/paystubs","title":"List all paystubs","sidebarTitle":"List all paystubs","href":"/api-reference/partners-data-sets/list-all-paystubs"}]},{"group":"Partner Receipts","pages":[{"openapi":"openAPI/verifications-partners.yaml post /partners/v2/receipts","title":"Receipts","sidebarTitle":"Receipts","href":"/api-reference/partners-receipts"}]}]}]},{"product":"Changelog","description":"Product updates and announcements","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Retrieve An Account - Argyle Docs","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DdEMm2kG.js","utils-BMo572L7.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C-4m9KAx.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DPLK2Oq9.js","snippetPresets-BKjfJMC9.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DTsgtCEj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C8vmhyQM.js","shallow-r9w8LQGS.js","getApiPlaygroundDisplay-DjPI64HQ.js","CodeSnippet-C8Bvhl16.js","CodeSnippets-BtWUwcMy.js","Page-BIYvYBgk.js","getPastedJson-Dcm_3Pgl.js","icon-BXwrTpjc.js","MethodPill-CcjfVmmy.js","DuplicateIcon-BuKIbXAQ.js","createIcon-DaL9yXsO.js","DynamicMarkdown-Co5nikxh.js","SectionHeading-P4UNTsMZ.js","axios-vUo_bRtp.js","Markdown-CEfymfIH.js","clsx-Dq9TQuNi.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-D2J8knkn.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BgZ2ThuU.js"]}