For new report implementations, use the Verifications API. This endpoint is documented for existing payroll integrations. If you need individual payroll records instead of a report, see Verifications vs. Data APIs.
There is a daily limit of 10 reports per user to prevent excessive report generation due to accidental client-side errors.
If the daily report limit is reached, deleting a previously generated report from the same 24 hour period will allow another report to be generated.
voie-mortgage - Verification of Income and Employment, integrated with Fannie Mae's Desktop Underwriter (DU) validation service and Freddie Mac's asset and income modeler (AIM)
voe-mortgage - Verification of Employment, integrated with Fannie Mae's Desktop Underwriter (DU) validation service and Freddie Mac's asset and income modeler (AIM)
voie-mortgage - Verification of Income and Employment, integrated with Fannie Mae's Desktop Underwriter (DU) validation service and Freddie Mac's asset and income modeler (AIM)
voe-mortgage - Verification of Employment, integrated with Fannie Mae's Desktop Underwriter (DU) validation service and Freddie Mac's asset and income modeler (AIM)
Timestamp (ISO 8601) when the account used to generate the report was last scanned for new data before the report was generated. If multiple accounts were used, the more recent timestamp.
Used to populate the "Data as of" date on the report PDF.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Argyle Docs","colors":{"primary":"#214E48","light":"#7FB2A8","dark":"#1D1D1D"},"logo":{"light":"https://mintcdn.com/argyle/HtlySCcYVcDJWXiY/logo/light.svg?fit=max\u0026auto=format\u0026n=HtlySCcYVcDJWXiY\u0026q=85\u0026s=3d77b5555b7fdd5185b855e858558376","dark":"https://mintcdn.com/argyle/HtlySCcYVcDJWXiY/logo/dark.svg?fit=max\u0026auto=format\u0026n=HtlySCcYVcDJWXiY\u0026q=85\u0026s=9fd2f436065a41825b9839fb81c76467","href":"/"},"favicon":"https://mintcdn.com/argyle/xZQDezYDpb8d7zmN/favicon.png?fit=max\u0026auto=format\u0026n=xZQDezYDpb8d7zmN\u0026q=85\u0026s=046e800dc429a2f398d20a345dd7350a","api":{"openapi":["openAPI/account-webhook-updated.yaml","openAPI/account-webhooks-added.yaml","openAPI/accounts-webhooks-connected.yaml","openAPI/accounts-webhooks-failed.yaml","openAPI/accounts-webhooks-removed.yaml","openAPI/accounts.yaml","openAPI/deposit-destinations.yaml","openAPI/employer-search.yaml","openAPI/employments.yaml","openAPI/gigs-webhooks-added.yaml","openAPI/gigs-webhooks-fully-synced.yaml","openAPI/gigs-webhooks-partially-synced.yaml","openAPI/gigs-webhooks-removed.yaml","openAPI/gigs-webhooks-updated.yaml","openAPI/gigs.yaml","openAPI/identities-webhooks-added.yaml","openAPI/identities-webhooks-updated.yaml","openAPI/identities.yaml","openAPI/invites.yaml","openAPI/item-filters.yaml","openAPI/items-webhooks-removed.yaml","openAPI/items-webhooks-updated.yaml","openAPI/items.yaml","openAPI/open-banking.yaml","openAPI/payroll-documents-webhooks-added.yaml","openAPI/payroll-documents-webhooks-ocr-completed.yaml","openAPI/payroll-documents-webhooks-ocr-failed.yaml","openAPI/payroll-documents-webhooks-removed.yaml","openAPI/payroll-documents-webhooks-updated.yaml","openAPI/payroll-documents.yaml","openAPI/paystubs-webhooks-added.yaml","openAPI/paystubs-webhooks-fully-synced.yaml","openAPI/paystubs-webhooks-partially-synced.yaml","openAPI/paystubs-webhooks-updated.yaml","openAPI/paystubs.yaml","openAPI/ratings-webhooks-added.yaml","openAPI/ratings-webhooks-updated.yaml","openAPI/ratings.yaml","openAPI/receipts.yaml","openAPI/reports-webhooks-generated.yaml","openAPI/reports-webhooks-ready.yaml","openAPI/reports.yaml","openAPI/shifts-webhooks-added.yaml","openAPI/shifts-webhooks-fully-synced.yaml","openAPI/shifts-webhooks-partially-synced.yaml","openAPI/shifts-webhooks-removed.yaml","openAPI/shifts-webhooks-updated.yaml","openAPI/shifts.yaml","openAPI/user-forms-webhooks-removed.yaml","openAPI/user-forms-webhooks.yaml","openAPI/user-forms.yaml","openAPI/user-tokens.yaml","openAPI/user-uploads-webhooks-added.yaml","openAPI/user-uploads-webhooks-ocr-authenticity.yaml","openAPI/user-uploads-webhooks-ocr-completed.yaml","openAPI/user-uploads-webhooks-ocr-failed.yaml","openAPI/user-uploads-webhooks-removed.yaml","openAPI/user-uploads.yaml","openAPI/users-webhooks.yaml","openAPI/users.yaml","openAPI/verifications-partners-webhooks-creation-failed.yaml","openAPI/verifications-partners-webhooks-connection-added.yaml","openAPI/verifications-partners-webhooks-updated.yaml","openAPI/verifications-partners.yaml","openAPI/verifications-webhooks-creation-failed.yaml","openAPI/verifications-webhooks-connection-added.yaml","openAPI/verifications-webhooks-updated.yaml","openAPI/vehicles-webhooks-added.yaml","openAPI/vehicles-webhooks-removed.yaml","openAPI/vehicles-webhooks-updated.yaml","openAPI/vehicles.yaml","openAPI/verifications.yaml","openAPI/webhooks.yaml"],"mdx":{"server":["https://api-sandbox.argyle.com","https://api.argyle.com"]}},"appearance":{"default":"light"},"navbar":{"links":[{"href":"/changelog","label":"Changelog"},{"href":"https://console.argyle.com/sign-in","label":"Sign in"}],"primary":{"type":"button","label":"Contact sales","href":"https://argyle.com/contact-sales/"}},"footer":{"socials":{}},"seo":{"metatags":{"og:image":"https://docs.argyle.com/images/social/argyle-docs.png","og:image:alt":"Argyle","twitter:image":"https://docs.argyle.com/images/social/argyle-docs.png","twitter:image:alt":"Argyle"}},"fonts":{"heading":{"family":"Plain","source":"fonts/Plain-Regular.woff2","format":"woff2"},"body":{"family":"Plain","source":"fonts/Plain-Regular.woff2","format":"woff2"}},"styling":{"codeblocks":{},"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"argyle","hasAudioNarration":false,"actualSubdomain":"argyle","customDomains":["docs.argyle.com"],"gitSource":{"type":"github","owner":"argyle-systems","repo":"argyle-mintlify","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae245fb51449a9936dc6c30","collectionId":"c89435dc-da28-4211-aa0b-919b1afef5e9","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae245fb51449a9936dc6c30"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae3663ffa8478333aab6a5a","clientVersion":"0.0.4021","searchFilterCounts":[{"language":"default","tag":"Clients","count":215},{"language":"default","tag":"API Reference","count":169},{"language":"default","tag":"Guides","count":76},{"language":"default","tag":"Webhooks","count":50},{"language":"default","tag":"Partners","count":40},{"language":"default","tag":"Verifications","count":38},{"language":"default","tag":"Payroll Data Sets","count":24},{"language":"default","tag":"Core Resources","count":21},{"language":"default","tag":"Workflows","count":16},{"language":"default","tag":"Verticals","count":16}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","href":"/_mintlify/custom/argyle/c71dc7693384de52/style.css"},{"filePath":"changelog.css","href":"/_mintlify/custom/argyle/81c93b48daa6fd82/changelog.css"}],"page":{"pagePath":"api-reference/reports/generate-a-report","slug":"/api-reference/reports/generate-a-report","pageMetadata":{"title":"Generate A Report","description":"Generates a new report and returns a report object.","openapi":"post /v2/reports/{type}","badge":"POST","href":"/api-reference/reports/generate-a-report"},"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: \"Generates a new report and returns a report 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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,p:`p`,..._provideComponents(),...props.components},{Info,Warning}=_components;if(!Info)_missingMdxReference(`Info`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(Info,{children:_jsxs(_components.p,{children:[`For new report implementations, use the `,_jsx(_components.a,{href:`/api-reference/verifications/order-a-verification`,children:`Verifications API`}),`. This endpoint is documented for existing payroll integrations. If you need individual payroll records instead of a report, see `,_jsx(_components.a,{href:`/overview/verifications-vs-data-apis`,children:`Verifications vs. Data APIs`}),`.`]})}),`\n`,_jsx(Warning,{children:`There is a daily limit of 10 reports per user to prevent excessive report generation due to accidental client-side errors.`}),`\n`,_jsx(_components.p,{children:`If the daily report limit is reached, deleting a previously generated report from the same 24 hour period will allow another report to be generated.`})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"codeStyling":{},"config":{},"pageMetadata":{"title":"Generate A Report","description":"Generates a new report and returns a report object.","openapi":"post /v2/reports/{type}","badge":"POST","href":"/api-reference/reports/generate-a-report"}}},"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":"Generate a report","description":"Generates a new report and returns a report object.","parameters":["b30e8269-5064-4837-bdf7-3f44286591c5"],"requestBody":"68c3b550-b43a-4797-9049-c49ac5b948b3","responses":{"200":"390f3717-8a02-49e5-80d8-3b99e7d25b2f"},"method":"post","type":"path","servers":["72353e34-fa91-4304-be99-8478306fff20","cefcce05-493c-4f02-8fd0-fadd64398098"],"security":["3eb02bef-414c-46a5-8e0a-69c4c6f189fe"],"path":"/v2/reports/{type}","baseUrlOptions":["https://api-sandbox.argyle.com","https://api.argyle.com"],"title":"Generate a report","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"b30e8269-5064-4837-bdf7-3f44286591c5":{"name":"type","in":"path","required":true,"schema":{"type":"string","enum":["voe","voie","voe-mortgage","voie-mortgage"],"isRequired":true,"description":"The type of report to generate.\n\n- `voie` - Verification of Income and Employment\n- `voe` - Verification of Employment\n- `voie-mortgage` - Verification of Income and Employment, integrated with Fannie Mae's Desktop Underwriter (DU) validation service and Freddie Mac's asset and income modeler (AIM)\n- `voe-mortgage` - Verification of Employment, integrated with Fannie Mae's Desktop Underwriter (DU) validation service and Freddie Mac's asset and income modeler (AIM)\n\nVisit our [Day 1 Certainty and AIM guide](/integrations/d1c-aim/verifications#requesting-verification-reports) for more information on mortgage reports.\n","uniqueKey":"","typeLabel":"enum\u003cstring>"},"description":"The type of report to generate.\n\n- `voie` - Verification of Income and Employment\n- `voe` - Verification of Employment\n- `voie-mortgage` - Verification of Income and Employment, integrated with Fannie Mae's Desktop Underwriter (DU) validation service and Freddie Mac's asset and income modeler (AIM)\n- `voe-mortgage` - Verification of Employment, integrated with Fannie Mae's Desktop Underwriter (DU) validation service and Freddie Mac's asset and income modeler (AIM)\n\nVisit our [Day 1 Certainty and AIM guide](/integrations/d1c-aim/verifications#requesting-verification-reports) for more information on mortgage reports.\n"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"user":{"type":"string","format":"uuid","description":"ID of the user.","isRequired":true,"uniqueKey":"user","typeLabel":"string\u003cuuid>"},"metadata":{"type":"object","description":"Information for internal use, structured as a JSON object.","uniqueKey":"metadata","typeLabel":"object"}},"required":["user"],"uniqueKey":"","typeLabel":"object"},"example":{"user":"018051aa-f7a9-a0db-2f38-6cfa325e9d69"},"examples":{"Example":{"title":"Example","value":{"user":"018051aa-f7a9-a0db-2f38-6cfa325e9d69"}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"390f3717-8a02-49e5-80d8-3b99e7d25b2f":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"id":"43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b","user":"018051aa-f7a9-a0db-2f38-6cfa325e9d69","reference_id":"43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b","generated_at":"2023-03-09T16:22:06.081Z","created_at":"2023-03-09T16:22:06.081Z","type":"voie","status":"generated","file_url":"www.argyle.com/storagename/pdf","json_url":"www.argyle.com/storagename/json","last_synced_at":"2023-03-09T14:08:25.069Z","accounts":[{"id":"0187c66e-e7e5-811c-b006-2232f00f426a","item":"item_123456789","last_synced_at":"2023-03-09T14:08:25.069105Z"},{"id":"0185a8b8-60eb-80ca-7482-5f24504573f7","item":"item_000000001","last_synced_at":"2023-03-01T05:10:59.558295Z"}],"metadata":{},"external_id":"July_Connection"},"properties":{"id":{"type":"string","format":"uuid","description":"Unique ID of the report object.\n\nAlso the \"**Reference #**\" on the report PDF.\n","uniqueKey":"id","typeLabel":"string\u003cuuid>"},"user":{"type":"string","format":"uuid","description":"ID of the user associated with the report.","uniqueKey":"user","typeLabel":"string\u003cuuid>"},"reference_id":{"type":"string","format":"uuid","description":"Report PDF identifier.","deprecated":true,"uniqueKey":"reference_id","typeLabel":"string\u003cuuid>"},"generated_at":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when the report was requested.","deprecated":true,"uniqueKey":"generated_at","typeLabel":"string\u003cdate-time>"},"created_at":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when the report was requested.","uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"type":{"type":"string","enum":["voe","voie","voe-mortgage","voie-mortgage"],"description":"The type of report.\n\n- `voie` - Verification of Income and Employment\n- `voe` - Verification of Employment\n- `voie-mortgage` - Verification of Income and Employment, integrated with Fannie Mae's Desktop Underwriter (DU) validation service and Freddie Mac's asset and income modeler (AIM)\n- `voe-mortgage` - Verification of Employment, integrated with Fannie Mae's Desktop Underwriter (DU) validation service and Freddie Mac's asset and income modeler (AIM)\n","uniqueKey":"type","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["waiting_for_sync","generating","generated","failed"],"description":"Progress of report generation.\n\n- `waiting_for_sync`: Data from the connected payroll account is still being retrieved.\n- `generating`: The report is being generated.\n- `generated`: The report is ready to download.\n- `failed`: A system error occurred, preventing report generation.\n","uniqueKey":"status","typeLabel":"enum\u003cstring>"},"file_url":{"type":"string","description":"Download link to the report PDF.\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\nImplementation requirements for client-side applications:\n","uniqueKey":"file_url","typeLabel":"string"},"json_url":{"type":"string","description":"Download link to the report in JSON.\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","uniqueKey":"json_url","typeLabel":"string"},"last_synced_at":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when the account used to generate the report was last scanned for new data before the report was generated. If multiple accounts were used, the more recent timestamp.\n\nUsed to populate the \"Data as of\" date on the report PDF.\n","uniqueKey":"last_synced_at","typeLabel":"string\u003cdate-time>"},"accounts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the account.","uniqueKey":"accounts.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"item":{"type":"string","description":"ID of the Item in Link through which the account was connected.","uniqueKey":"accounts.items.[INDEX].item","typeLabel":"string"},"last_synced_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 before the report was generated.","uniqueKey":"accounts.items.[INDEX].last_synced_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"accounts.items.[INDEX]","typeLabel":"object"},"description":"The accounts used to generate the report.","uniqueKey":"accounts","typeLabel":"object[]"},"metadata":{"type":"object","description":"Any metadata for internal use added when generating the report.","uniqueKey":"metadata","typeLabel":"object"},"external_id":{"type":"string","description":"The [external_id](/api-reference/users#object-external_id) of the user, otherwise `null`.","uniqueKey":"external_id","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"id":"43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b","user":"018051aa-f7a9-a0db-2f38-6cfa325e9d69","reference_id":"43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b","generated_at":"2023-03-09T16:22:06.081Z","created_at":"2023-03-09T16:22:06.081Z","type":"voie","status":"generating","file_url":"www.argyle.com/storagename/pdf","json_url":"www.argyle.com/storagename/json","accounts":[{"id":"0187c66e-e7e5-811c-b006-2232f00f426a","item":"item_123456789","last_synced_at":"2023-03-09T14:08:25.069Z"},{"id":"0185a8b8-60eb-80ca-7482-5f24504573f7","item":"item_000000001","last_synced_at":"2023-03-01T05:10:59.558Z"}],"metadata":{},"last_synced_at":"2023-03-09T14:08:25.069Z","external_id":"July_Connection"},"examples":{"Example":{"title":"Example","value":{"id":"43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b","user":"018051aa-f7a9-a0db-2f38-6cfa325e9d69","reference_id":"43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b","generated_at":"2023-03-09T16:22:06.081Z","created_at":"2023-03-09T16:22:06.081Z","type":"voie","status":"generating","file_url":"www.argyle.com/storagename/pdf","json_url":"www.argyle.com/storagename/json","accounts":[{"id":"0187c66e-e7e5-811c-b006-2232f00f426a","item":"item_123456789","last_synced_at":"2023-03-09T14:08:25.069Z"},{"id":"0185a8b8-60eb-80ca-7482-5f24504573f7","item":"item_000000001","last_synced_at":"2023-03-01T05:10:59.558Z"}],"metadata":{},"last_synced_at":"2023-03-09T14:08:25.069Z","external_id":"July_Connection"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"3eb02bef-414c-46a5-8e0a-69c4c6f189fe":{"basicAuth":{"type":"http","scheme":"basic","description":"Username = api_key_id, Password = api_key_secret","scopes":[]}}},"servers":{"72353e34-fa91-4304-be99-8478306fff20":{"url":"https://api-sandbox.argyle.com","description":"Sandbox"},"cefcce05-493c-4f02-8fd0-fadd64398098":{"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/reports.yaml"},"subdomain":"argyle","siteName":"Argyle Docs","title":"Generate A Report - Argyle Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-02T18:29:05.420Z","originalFileLocation":"api-reference/reports/generate-a-report.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=\"Generates a new report and returns a report 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=\"Generate A Report - Argyle Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Generates a new report and returns a report 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/reports/generate-a-report\">\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=\"Generate A Report - Argyle Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Generates a new report and returns a report 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/reports/generate-a-report\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/reports/generate-a-report.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/reports/generate-a-report#webpage\",\"url\":\"https://docs.argyle.com/api-reference/reports/generate-a-report\",\"name\":\"Generate A Report\",\"description\":\"Generates a new report and returns a report object.\",\"dateModified\":\"2026-10-02T18:29:05.420Z\",\"isPartOf\":{\"@id\":\"https://docs.argyle.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.argyle.com/api-reference/reports/generate-a-report#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.argyle.com/api-reference/reports/generate-a-report#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Reports\",\"item\":\"https://docs.argyle.com/api-reference/reports\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Reports\",\"item\":\"https://docs.argyle.com/api-reference/reports\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Generate A Report\",\"item\":\"https://docs.argyle.com/api-reference/reports/generate-a-report\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.argyle.com/api-reference/reports/generate-a-report#apireference\",\"headline\":\"Generate A Report\",\"name\":\"Generate A Report\",\"description\":\"Generates a new report and returns a report object.\",\"url\":\"https://docs.argyle.com/api-reference/reports/generate-a-report\",\"mainEntityOfPage\":{\"@id\":\"https://docs.argyle.com/api-reference/reports/generate-a-report#webpage\"},\"image\":\"https://docs.argyle.com/images/social/argyle-docs.png\",\"dateModified\":\"2026-10-02T18:29:05.420Z\",\"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":[{"title":"Payroll Documents","sidebarTitle":"Payroll Documents","href":"/api-reference/payroll-documents"},{"title":"Retrieve A Payroll Document","openapi":"get /v2/payroll-documents/{id}","href":"/api-reference/payroll-documents/retrieve-a-payroll-document"},{"title":"List All Payroll Documents","openapi":"get /v2/payroll-documents","href":"/api-reference/payroll-documents/list-all-payroll-documents"}]},{"group":"Deposit Destinations","pages":[{"title":"Deposit Destinations","sidebarTitle":"Deposit Destinations","href":"/api-reference/deposit-destinations"},{"title":"Retrieve A Deposit Destination","openapi":"get /v2/deposit-destinations/{id}","href":"/api-reference/deposit-destinations/retrieve-a-deposit-destination"},{"title":"List All Deposit Destinations","openapi":"get /v2/deposit-destinations","href":"/api-reference/deposit-destinations/list-all-deposit-destinations"}]},{"group":"Shifts","pages":[{"title":"Shifts","sidebarTitle":"Shifts","href":"/api-reference/shifts"},{"title":"Retrieve A Shift","openapi":"get /v2/shifts/{id}","href":"/api-reference/shifts/retrieve-a-shift"},{"title":"List All Shifts","openapi":"get /v2/shifts","href":"/api-reference/shifts/list-all-shifts"}]},{"group":"Gigs","pages":[{"title":"Gigs","sidebarTitle":"Gigs","href":"/api-reference/gigs"},{"title":"Retrieve A Gig","openapi":"get /v2/gigs/{id}","href":"/api-reference/gigs/retrieve-a-gig"},{"title":"List All Gigs","openapi":"get /v2/gigs","href":"/api-reference/gigs/list-all-gigs"}]},{"group":"Vehicles","pages":[{"title":"Vehicles","sidebarTitle":"Vehicles","href":"/api-reference/vehicles"},{"title":"Retrieve A Vehicle","openapi":"get /v2/vehicles/{id}","href":"/api-reference/vehicles/retrieve-a-vehicle"},{"title":"List All Vehicles","openapi":"get /v2/vehicles","href":"/api-reference/vehicles/list-all-vehicles"}]},{"group":"Ratings","pages":[{"title":"Ratings","sidebarTitle":"Ratings","href":"/api-reference/ratings"},{"title":"Retrieve A Rating","openapi":"get /v2/ratings/{id}","href":"/api-reference/ratings/retrieve-a-rating"},{"title":"List All Ratings","openapi":"get /v2/ratings","href":"/api-reference/ratings/list-all-ratings"}]}]},{"group":"Banking","pages":[{"group":"Financial Institutions","pages":[{"title":"Financial Institutions","sidebarTitle":"Financial Institutions","href":"/api-reference/financial-institutions"},{"openapi":"get /v2/open-banking/institutions/{institution_id}","title":"Retrieve an institution","href":"/api-reference/financial-institutions/retrieve-an-institution"},{"openapi":"get /v2/open-banking/institutions","title":"List all institutions","href":"/api-reference/financial-institutions/list-all-institutions"}]},{"group":"Bank Accounts","pages":[{"title":"Bank Accounts","sidebarTitle":"Bank Accounts","href":"/api-reference/bank-accounts"},{"openapi":"get /v2/open-banking/bank-accounts/{bank_account_id}","title":"Retrieve a bank account","href":"/api-reference/bank-accounts/retrieve-a-bank-account"},{"openapi":"get /v2/open-banking/bank-accounts","title":"List all bank accounts","href":"/api-reference/bank-accounts/list-all-bank-accounts"}]}]},{"group":"Reports","pages":[{"group":"Reports","pages":[{"title":"Reports","sidebarTitle":"Reports","href":"/api-reference/reports"},{"title":"List All Reports","description":"Returns a paginated list of all report objects.\n","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","description":"Retrieves a report object.\n","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":"Generate A Report - 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"]}