The type of payroll document, as returned by the payroll system. The following values are the most common, but document_type is not restricted to these values.
URL linking to the original payroll document file.
This static URL redirects to a download page that requires Argyle authentication headers. See the dropdown below for more information.
Implementation requirements for client-side applications
Ensure your HTTP client or library (e.g. Axios, Python requests, etc.) or similar tool is configured to pursue redirects. Most tools support this functionality.
{"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":[],"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/payroll-documents/retrieve-a-payroll-document","slug":"/api-reference/payroll-documents/retrieve-a-payroll-document","pageMetadata":{"title":"Retrieve A Payroll Document","description":"Retrieves a payroll document object.\n","openapi":"get /v2/payroll-documents/{id}","badge":"GET","href":"/api-reference/payroll-documents/retrieve-a-payroll-document"},"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 document 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 A Payroll Document","description":"Retrieves a payroll document object.\n","openapi":"get /v2/payroll-documents/{id}","badge":"GET","href":"/api-reference/payroll-documents/retrieve-a-payroll-document"}}},"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 a payroll document","description":"Retrieves a payroll document object.\n","parameters":["a64efdfc-0f9a-4722-81e1-346261ee39c0"],"responses":{"200":"52fae51d-8972-4a93-88e5-d1e0a2aca977"},"method":"get","type":"path","servers":["7419b79d-7a5a-4884-ad20-f896db60e440","98b683b2-eae6-4e7c-a2bc-2d02a6c359fd"],"security":["850ed991-5c7c-4dd6-acd8-11312cc9dd23"],"path":"/v2/payroll-documents/{id}","baseUrlOptions":["https://api-sandbox.argyle.com","https://api.argyle.com"],"title":"Retrieve a payroll document","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"a64efdfc-0f9a-4722-81e1-346261ee39c0":{"in":"path","name":"id","schema":{"type":"string","format":"uuid","isRequired":true,"description":"ID of the payroll document object to be retrieved.","uniqueKey":"","typeLabel":"string\u003cuuid>"},"required":true,"description":"ID of the payroll document object to be retrieved."}},"responses":{"52fae51d-8972-4a93-88e5-d1e0a2aca977":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"id":"0176dc14-bb37-402a-7be1-f5261759fae7","account":"0187c66e-e7e5-811c-b006-2232f00f426a","document_number":"ced46eb3-7586-3cd7-2418-8eb9482bc3ec","available_date":"2021-03-14T17:46:25Z","expiration_date":null,"employer":"GigAndGo","employment":"42d6531c-520a-26b9-35c3-b7137a6d205a","document_type":"1099","document_type_description":"1099 Form 2020","file_url":"api.argyle.com/v2/payroll-documents/{id}/file","created_at":"2023-03-13T17:46:28.240Z","updated_at":"2023-03-13T17:46:28.240Z","ocr_data":{"form_type":"1099-MISC","omb_no":"1545-0115","year":"2020","form":{"recipient":{"name":"BOB JONES","address":{"city":null,"country":null,"line1":"759 VICTORIA PLAZA","line2":null,"postal_code":"10014","state":"NY"}},"recipient_tin":"111-11-1112","payer":{"name":"WAREHOUSE SERVICES INC","address":{"city":"SEATTLE","country":null,"line1":"202 WESTLAKE AVE N (55","line2":null,"postal_code":"98109","state":"WA"}},"payer_tin":"11-1111112","account_no":"000110CHIC/NHO","rent_1":null,"royalties_2":null,"other_inc_3":null,"fed_inc_4":null,"fishing_5":null,"med_care_6":null,"comp_7":null,"crop_insurance_10":null,"golden_parachute_13":null,"gross_attorney_14":null,"sec_409a_defer_15a":null,"sec_409a_inc_15b":null,"state_tax_16":null,"state_no_17":null,"state_inc":null},"warnings":[{"field_name":"rent_1","message":"rent_1 value empty/bad format","severity":0},{"field_name":"royalties_2","message":"royalties_2 value empty/bad format","severity":0},{"field_name":"other_inc_3","message":"other_inc_3 value empty/bad format","severity":0},{"field_name":"fed_inc_4","message":"fed_inc_4 value empty/bad format","severity":0},{"field_name":"fishing_5","message":"fishing_5 value empty/bad format","severity":0},{"field_name":"med_care_6","message":"med_care_6 value empty/bad format","severity":0},{"field_name":"comp_7","message":"comp_7 not found","severity":0},{"field_name":"crop_insurance_10","message":"crop_insurance_10 value empty/bad format","severity":0},{"field_name":"golden_parachute_13","message":"golden_parachute_13 value empty/bad format","severity":0},{"field_name":"gross_attorney_14","message":"gross_attorney_14 value empty/bad format","severity":0},{"field_name":"sec_409a_defer_15a","message":"sec_409a_defer_15a value empty/bad format","severity":0},{"field_name":"sec_409a_inc_15b","message":"sec_409a_inc_15b not found","severity":0},{"field_name":"state_tax_16","message":"state_tax_16 value empty/bad format","severity":0},{"field_name":"state_no_17","message":"state_no_17 value empty/bad format","severity":0},{"field_name":"state_inc","message":"state_inc value empty/bad format","severity":0}],"confidence":"EXACT_MATCH","ocr_page_count":1},"metadata":null},"properties":{"id":{"type":"string","format":"uuid","description":"Unique ID of the payroll document object.\n\nAlso the `payroll_document` ID value of the [paystub object](/api-reference/paystubs#object).\n","uniqueKey":"id","typeLabel":"string\u003cuuid>"},"account":{"type":"string","format":"uuid","description":"ID of the account where the payroll document was sourced.","uniqueKey":"account","typeLabel":"string\u003cuuid>"},"document_number":{"type":"string","description":"Identification number that appears on the payroll document.","uniqueKey":"document_number","typeLabel":"string"},"available_date":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when the payroll document was made available to the user on the underlying payroll system.","uniqueKey":"available_date","typeLabel":"string\u003cdate-time>"},"expiration_date":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when payroll document (such as a driver's license) expires.","uniqueKey":"expiration_date","typeLabel":"string\u003cdate-time>"},"employer":{"type":"string","description":"Employer name.","uniqueKey":"employer","typeLabel":"string"},"employment":{"type":"string","description":"[Employment](/api-reference/employments) ID. Can be used as a filter when [listing payroll documents](/api-reference/payroll-documents#list).\n","uniqueKey":"employment","typeLabel":"string"},"document_type":{"type":"string","description":"The type of payroll document, as returned by the payroll system. The following values are the most common, but document_type is not restricted to these values.","enum":["payout-statement","W-2","W-4","W-9",1095,"1095-C",1099,"profile-picture","drivers-license","vehicle-insurance","vehicle-registration","vehicle-inspection","other"],"uniqueKey":"document_type","typeLabel":"enum\u003cstring>"},"document_type_description":{"type":"string","description":"Description of the payroll document type.","uniqueKey":"document_type_description","typeLabel":"string"},"file_url":{"type":"string","description":"URL linking to the original payroll document file.\n\nThis static URL redirects to a download page that requires [Argyle authentication headers](/api-guide/overview#authentication). See the dropdown below for more information.\n\n**Implementation requirements for client-side applications**\n 1. Ensure your HTTP client or library (e.g. Axios, Python requests, etc.) or similar tool is configured to pursue redirects. Most tools support this functionality.\n\n 2. [Basic authentication headers](https://docs.argyle.com/api-guide/overview#authentication) for Argyle must be appended to the file download request.\n","uniqueKey":"file_url","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when the payroll document object was created.","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 a property value of the payroll document object most recently changed.","uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"},"ocr_data":{"type":"object","description":"Argyle scans and provides additional information for 1099 and W-2 documents retrieved from connected payroll accounts.\n","properties":{"form_type":{"type":"string","description":"The specific type of 1099 or W-2 document.\n\n **W-2 and W-2c**\n W-2: Wage and Tax Statement\n W-2c: Corrected Wage and Tax Statement\n\n - **`control_no_d`**: Identifies the W-2 in the payer's records. \n - **`comp_1`**: The amount of wages, tips, and other compensation. \n - **`fed_income_tax_2`**: The amount of federal income tax withheld. \n - **`ss_wages_3`**: The amount of social security wages. \n - **`ss_tax_4`**: The amount of social security tax withheld. \n - **`med_wages_5`**: The amount of Medicare wages and tips. \n - **`med_tax_6`**: The amount of Medicare tax withheld. \n - **`ss_tips_7`**: The amount of social security tips. \n - **`tips_8`**: The amount of allocated tips. \n - **`verification_9`**: Code used to identify the accuracy of the form's contents for electronic tax returns. \n - **`benefits_10`**: The amount of dependent care benefits. \n - **`nonqualified_11`**: The amount of contributions made to a non-qualified savings plan. \n - **`uncollected_ss_RRTA_12a`**: The amount of uncollected social security or RRTA tax on tips. \n - **`uncollected_med_tax_12b`**: The amount of uncollected Medicare tax on tips. \n - **`insurance_12c`**: The amount of taxable costs of group-term life insurance over $50,000. \n - **`plan_401k_12d`**: The amount of elective deferrals related to contributions to 401-k plans. \n - **`other_14`**: Used to report additional tax information. \n - **`employers_state_15`**: Lists the states for which the employer withheld the taxes and to which state the employer remitted the taxes, indicated by the employer's state ID number. \n - **`state_wages_16`**: The amount of state wages, tips, etc. \n - **`state_income_tax_17`**: The amount of state income tax. \n - **`local_wages_18`**: The amount of local wages, tips, etc. \n - **`local_income_tax_19`**: The amount of local income tax. \n - **`locality_name_20`**: The name of the locality where taxes indicated in the `local_income_tax_19` field are paid. \n\n **1099-NEC**\n 1099-NEC: Non-Employee Compensation\n\n - **`account_no`**: A code that is unique to the recipient and the form, for example, a bank account number, employee ID, etc. \n - **`comp_1`**: The amount of non-employee compensation. \n - **`fed_inc_tax_4`**: The amount of federal income tax withheld. \n - **`state_tax_5`**: The amount of state tax withheld. \n - **`state_no_6`**: The abbreviated name of the state and the payer's state tax identification number. \n - **`state_inc_7`**: The amount of state income. \n\n **1099-SSA**\n 1099-SSA: Social Security Benefits\n\n - **`recipient_name_1`**: The name of the recipient. \n - **`benefits_3`**: The amount of benefits paid. \n - **`benefits_ssa_4`**: The amount of benefits repaid to the Social Security Administration (SSA). \n - **`net_benefits_5`**: The amount of net benefits. \n - **`fed_inc_tax_6`**: The amount of voluntary federal income tax withholding. \n - **`claim_no`**: The social security number under which a claim is filed or benefits are paid. \n\n **1099-MISC**\n 1099-MISC: Miscellaneous Income\n\n - **`account_no`**: A code that is unique to the recipient and the form, for example, a bank account number, employee ID, etc. \n - **`rent_1`**: The amount of rental income. \n - **`royalties_2`**: The amount of royalty income. \n - **`other_inc_3`**: Other income. \n - **`fed_inc_4`**: The amount of federal income tax withheld. \n - **`fishing_5`**: The amount of fishing boat proceeds. \n - **`med_care_6`**: The amount of medical and health care payment. \n - **`comp_7`**: The amount of non-employee compensation. \n - **`crop_insurance_10`**: The amount of crop insurance proceeds. \n - **`golden_parachute_13`**: The amount of excess golden parachute payments. \n - **`gross_attorney_14`**: The amount of gross proceeds paid to an attorney. \n - **`sec_409a_defer_15a`**: The amount of section 409A deferrals. \n - **`sec_409a_inc_15b`**: The amount of section 409A income. \n - **`state_tax_16`**: The amount of state tax withheld. \n - **`state_no_17`**: The abbreviated name of the state and the payer's state tax identification number. \n - **`state_inc`**: The amount of state income. \n\n **1099-INT**\n 1099-INT: Interest Income\n\n - **`payer_rtn`**: The payer's RTN (Routing and Transit Number). \n - **`account_no`**: A code that is unique to the recipient and the form, for example, a bank account number, employee ID, etc. \n - **`interest_1`**: The amount of interest income. \n - **`withdraw_penalty_2`**: The amount of early withdrawal penalty. \n - **`interest_obligations_3`**: The amount of interest earned on U.S. savings bonds or Treasury notes, bills, or bonds. \n - **`fed_inc_tax_4`**: The amount of federal income tax withheld. \n - **`investment_5`**: The amount of investment expenses. \n - **`foreign_tax_6`**: The amount of foreign tax paid. \n - **`foreign_possession_7`**: Shows the country or U.S. possession to which the foreign tax was paid. \n\n **1099-R**\n 1099-R: Distributions from Pensions and Annuities\n\n - **`control_no`**: The code that uniquely identifies a particular 1099-R document in the employer's records. \n - **`gross_1`**: The amount of gross distribution. \n - **`tax_amount_2a`**: The amount of distribution that is taxable. \n - **`fed_inc_tax_4`**: The amount of federal income tax withheld. \n - **`distribution_code_7`**: A code that identifies the type of distribution received. \n - **`distribution_percent_9`**: The percentage of total distribution received. \n - **`state_tax_14`**: The amount of state tax withheld. \n - **`state_no_15`**: The abbreviated name of the state and the payer's state tax identification number. \n\n **1099-G**\n 1099-G: Certain Government Payments\n\n - **`a_unemployment_comp_1`**: The amount of unemployment compensation. \n - **`a_state_inc_tax_2`**: The amount of state or local income tax refunds, credits, or offsets. \n - **`a_benefits_this_year_3`**: The amount of benefits repaid for the current year. \n - **`a_benefits_prev_year_3`**: The amount of benefits repaid for the previous year. \n - **`a_fed_inc_tax_4`**: The amount of federal income tax withheld. \n - **`b_unemployment_comp_1`**: The amount of unemployment compensation, paid family leave. \n - **`b_state_inc_tax_2`**: The amount of state or local income tax refunds, credits, or offsets. \n - **`b_benefits_this_year_3`**: The amount of benefits repaid for the current year. \n - **`b_benefits_prev_year_3`**: The amount of benefits repaid for the previous year. \n - **`b_fed_inc_tax_4`**: The amount of federal income tax withheld. \n\n **1099-K**\n 1099-K: Payment Card and Third Party Network Transactions\n\n - **`pse_name_phone`**: Payment settlement entity's name and telephone number. \n - **`account_no`**: A code that is unique to the recipient and the form, for example, a bank account number, employee ID, etc. \n - **`gross_1a`**: Gross amount of payment card/third-party network transactions. \n - **`gross_1b`**: The amount of Card Not Present transactions. \n - **`category_code_2`**: Merchant category code. \n - **`no_transactions_3`**: Number of payment transactions. \n - **`fed_inc_tax_4`**: The amount of federal income tax withheld. \n - **`january_5a`**: The total reportable payment transactions for this month. \n - **`february_5b`**: The total reportable payment transactions for this month. \n - **`march_5c`**: The total reportable payment transactions for this month. \n - **`april_5d`**: The total reportable payment transactions for this month. \n - **`may_5e`**: The total reportable payment transactions for this month. \n - **`june_5f`**: The total reportable payment transactions for this month. \n - **`july_5g`**: The total reportable payment transactions for this month. \n - **`august_5h`**: The total reportable payment transactions for this month. \n - **`september_5i`**: The total reportable payment transactions for this month. \n - **`october_5j`**: The total reportable payment transactions for this month. \n - **`november_5k`**: The total reportable payment transactions for this month. \n - **`december_5l`**: The total reportable payment transactions for this month. \n - **`state_6`**: State. \n - **`state_id_7`**: State identification number. \n - **`state_income_8`**: The amount of state income tax withheld. \n","enum":["W-2","W-2c","1099-NEC","1099-SSA","1099-MISC","1099-INT","1099-R","1099-G","1099-K"],"uniqueKey":"ocr_data.form_type","typeLabel":"enum\u003cstring>"},"omb_no":{"type":"string","description":"OMB reference number.","uniqueKey":"ocr_data.omb_no","typeLabel":"string"},"year":{"type":"string","description":"Calendar year.","uniqueKey":"ocr_data.year","typeLabel":"string"},"form":{"type":"object","description":"Information scanned from the payroll document.","properties":{"recipient":{"type":"object","properties":{"name":{"type":"string","description":"Recipient name, as it appears on the form.","uniqueKey":"ocr_data.form.recipient.name","typeLabel":"string"},"address":{"type":"object","description":"Recipient address, as it appears on the form.","properties":{"city":{"type":"string","description":"Name of the city, town, district, or similar regional entity.","uniqueKey":"ocr_data.form.recipient.address.city","typeLabel":"string"},"country":{"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format).","uniqueKey":"ocr_data.form.recipient.address.country","typeLabel":"string"},"line1":{"type":"string","description":"Address-Line 1, usually street address or P.O. Box information.","uniqueKey":"ocr_data.form.recipient.address.line1","typeLabel":"string"},"line2":{"type":"string","description":"Address-Line 2, usually the apartment or unit number.","uniqueKey":"ocr_data.form.recipient.address.line2","typeLabel":"string"},"postal_code":{"type":"string","description":"Zip code, or equivalent.","uniqueKey":"ocr_data.form.recipient.address.postal_code","typeLabel":"string"},"state":{"type":"string","description":"State, county, province, region, or equivalent.","uniqueKey":"ocr_data.form.recipient.address.state","typeLabel":"string"}},"uniqueKey":"ocr_data.form.recipient.address","typeLabel":"object"}},"uniqueKey":"ocr_data.form.recipient","typeLabel":"object"},"recipient_tin":{"type":"string","description":"Recipient's tax identification number.","uniqueKey":"ocr_data.form.recipient_tin","typeLabel":"string"},"payer":{"type":"object","properties":{"name":{"type":"string","description":"Payer name, as it appears on the form.","uniqueKey":"ocr_data.form.payer.name","typeLabel":"string"},"address":{"type":"object","description":"Payer address, as it appears on the form.","properties":{"city":{"type":"string","description":"Name of the city, town, district, or similar regional entity.","uniqueKey":"ocr_data.form.payer.address.city","typeLabel":"string"},"country":{"type":"string","description":"Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format).","uniqueKey":"ocr_data.form.payer.address.country","typeLabel":"string"},"line1":{"type":"string","description":"Address-Line 1, usually street address or P.O. Box information.","uniqueKey":"ocr_data.form.payer.address.line1","typeLabel":"string"},"line2":{"type":"string","description":"Address-Line 2, usually the apartment or unit number.","uniqueKey":"ocr_data.form.payer.address.line2","typeLabel":"string"},"postal_code":{"type":"string","description":"Zip code, or equivalent.","uniqueKey":"ocr_data.form.payer.address.postal_code","typeLabel":"string"},"state":{"type":"string","description":"State, county, province, region, or equivalent.","uniqueKey":"ocr_data.form.payer.address.state","typeLabel":"string"}},"uniqueKey":"ocr_data.form.payer.address","typeLabel":"object"}},"uniqueKey":"ocr_data.form.payer","typeLabel":"object"},"payer_tin":{"type":"string","description":"Payer's tax identification number.","uniqueKey":"ocr_data.form.payer_tin","typeLabel":"string"}},"uniqueKey":"ocr_data.form","typeLabel":"object"},"warnings":{"type":"array","description":"Information on scan quality and missing fields.","items":{"type":"object","properties":{"field_name":{"type":"string","description":"Which field encountered the error.","uniqueKey":"ocr_data.warnings.items.[INDEX].field_name","typeLabel":"string"},"message":{"type":"string","description":"The `field_name` and warning message.","enum":["not found","value empty/bad format","obfuscated","obfuscated last two digits given","obfuscated last four digits given","field_name had non numeric chars removed, original value: \u003cvalue>","field_name invalid - non numeric value, original value: \u003cvalue>"],"uniqueKey":"ocr_data.warnings.items.[INDEX].message","typeLabel":"enum\u003cstring>"},"severity":{"type":"number","format":"float","description":"The severity of the encountered issue.\n\n- `0.0`: The field was found, but its value was unclear or obfuscated.\n- `0.5`: A field or value was not found, but unclear if it needed to be present.\n- `1.0`: A field or value was not found.\n","enum":[0,0.5,1],"uniqueKey":"ocr_data.warnings.items.[INDEX].severity","typeLabel":"enum\u003cnumber>"}},"uniqueKey":"ocr_data.warnings.items.[INDEX]","typeLabel":"object"},"uniqueKey":"ocr_data.warnings","typeLabel":"object[]"},"confidence":{"type":"string","description":"Indicator of how successful the scanning process went.\n\n- **`EXACT_MATCH`**: No errors found. \n- **`HIGH`**: 1 error was found. \n- **`MEDIUM`**: 2 errors were found. \n- **`LOW`**: 3 errors were found. \n- **`NO_MATCH`**: 4 or more errors were found. This typically indicates the document's `form_type` did not match the scanned document. \n","enum":["EXACT_MATCH","HIGH","MEDIUM","LOW","NO_MATCH"],"uniqueKey":"ocr_data.confidence","typeLabel":"enum\u003cstring>"},"ocr_page_count":{"type":"integer","description":"Number of pages scanned.","uniqueKey":"ocr_data.ocr_page_count","typeLabel":"integer"},"error":{"oneOf":[{"type":"string","description":"An error was encountered during document retrieval.\n\n- **`invalid_document`**: The document was empty, cropped, missing required fields, or otherwise incomplete. \n- **`type_mismatch`**: The document does not match the classified type. \n- **`unrecognized_document_type`**: The document could not be classified. \n- **`unsupported_document_type`**: The document type is not supported. \n- **`unsupported_document_subtype`**: The document sub-type (e.g., 1099-C) is not supported. \n- **`unknown`**: An unknown issue occurred. The Argyle team will automatically be notified and will investigate. \n","enum":["invalid_document","type_mismatch","unrecognized_document_type","unsupported_document_type","unsupported_document_subtype","unknown"],"uniqueKey":"ocr_data.error.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"An error was encountered during document retrieval.\n\n- **`invalid_document`**: The document was empty, cropped, missing required fields, or otherwise incomplete. \n- **`type_mismatch`**: The document does not match the classified type. \n- **`unrecognized_document_type`**: The document could not be classified. \n- **`unsupported_document_type`**: The document type is not supported. \n- **`unsupported_document_subtype`**: The document sub-type (e.g., 1099-C) is not supported. \n- **`unknown`**: An unknown issue occurred. The Argyle team will automatically be notified and will investigate. \n","enum":["invalid_document","type_mismatch","unrecognized_document_type","unsupported_document_type","unsupported_document_subtype","unknown"],"uniqueKey":"ocr_data.error.oneOf.1","typeLabel":"null"}],"uniqueKey":"ocr_data.error","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"ocr_data","typeLabel":"object"},"metadata":{"type":"object","description":"Additional, non-categorized information.","uniqueKey":"metadata","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"id":"0183b2c1-02e5-a5e5-38f2-ecd51a5cf3d6","account":"0187c66e-e7e5-811c-b006-2232f00f426a","document_number":"ced46eb3-7586-3cd7-2418-8eb9482bc3ec","available_date":"2019-03-14T17:46:25Z","expiration_date":"2027-03-12T17:46:25Z","employer":"GigAndGo","employment":"42d6531c-520a-26b9-35c3-b7137a6d205a","document_type":"drivers-licence","document_type_description":"Driver's license","file_url":"api.argyle.com/v2/payroll-documents/{id}/file","created_at":"2023-03-13T17:46:28.240Z","updated_at":"2023-03-13T17:46:28.240Z","ocr_data":{},"metadata":{}},"examples":{"Example":{"title":"Example","value":{"id":"0183b2c1-02e5-a5e5-38f2-ecd51a5cf3d6","account":"0187c66e-e7e5-811c-b006-2232f00f426a","document_number":"ced46eb3-7586-3cd7-2418-8eb9482bc3ec","available_date":"2019-03-14T17:46:25Z","expiration_date":"2027-03-12T17:46:25Z","employer":"GigAndGo","employment":"42d6531c-520a-26b9-35c3-b7137a6d205a","document_type":"drivers-licence","document_type_description":"Driver's license","file_url":"api.argyle.com/v2/payroll-documents/{id}/file","created_at":"2023-03-13T17:46:28.240Z","updated_at":"2023-03-13T17:46:28.240Z","ocr_data":{},"metadata":{}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"850ed991-5c7c-4dd6-acd8-11312cc9dd23":{"basicAuth":{"type":"http","scheme":"basic","description":"Username = api_key_id, Password = api_key_secret","scopes":[]}}},"servers":{"7419b79d-7a5a-4884-ad20-f896db60e440":{"url":"https://api-sandbox.argyle.com","description":"Sandbox"},"98b683b2-eae6-4e7c-a2bc-2d02a6c359fd":{"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/payroll-documents.yaml"},"subdomain":"argyle","siteName":"Argyle Docs","title":"Retrieve A Payroll Document - Argyle Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-03-20T16:14:53.517Z","originalFileLocation":"api-reference/payroll-documents/retrieve-a-payroll-document.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 document 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 A Payroll Document - Argyle Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieves a payroll document 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/payroll-documents/retrieve-a-payroll-document\">\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 A Payroll Document - Argyle Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieves a payroll document 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/payroll-documents/retrieve-a-payroll-document\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/payroll-documents/retrieve-a-payroll-document.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/payroll-documents/retrieve-a-payroll-document#webpage\",\"url\":\"https://docs.argyle.com/api-reference/payroll-documents/retrieve-a-payroll-document\",\"name\":\"Retrieve A Payroll Document\",\"description\":\"Retrieves a payroll document object.\",\"dateModified\":\"2026-03-20T16:14:53.517Z\",\"isPartOf\":{\"@id\":\"https://docs.argyle.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.argyle.com/api-reference/payroll-documents/retrieve-a-payroll-document#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.argyle.com/api-reference/payroll-documents/retrieve-a-payroll-document#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Payroll Data Sets\",\"item\":\"https://docs.argyle.com/api-reference/identities\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Payroll Documents\",\"item\":\"https://docs.argyle.com/api-reference/payroll-documents\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Retrieve A Payroll Document\",\"item\":\"https://docs.argyle.com/api-reference/payroll-documents/retrieve-a-payroll-document\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.argyle.com/api-reference/payroll-documents/retrieve-a-payroll-document#apireference\",\"headline\":\"Retrieve A Payroll Document\",\"name\":\"Retrieve A Payroll Document\",\"description\":\"Retrieves a payroll document object.\",\"url\":\"https://docs.argyle.com/api-reference/payroll-documents/retrieve-a-payroll-document\",\"mainEntityOfPage\":{\"@id\":\"https://docs.argyle.com/api-reference/payroll-documents/retrieve-a-payroll-document#webpage\"},\"image\":\"https://docs.argyle.com/images/social/argyle-docs.png\",\"dateModified\":\"2026-03-20T16:14:53.517Z\",\"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":[{"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","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":[{"description":"Retrieve metadata and PDF's of paystubs, tax forms, and other payroll documents.","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","description":"Returns a paginated list of all payroll document objects.\n","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 A Payroll Document - 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"]}