Timestamp (ISO 8601) when the user upload object was last updated.
{"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":"6aeb64b0ba408fcd18af2c77","collectionId":"205159fb-6418-4bc7-975a-657471e000ba","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aeb64b0ba408fcd18af2c77"},"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":"6aecbda870f423ccd3d123a6","clientVersion":"0.0.4074","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":"rbac-expansion","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":"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":"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":"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":"full-page-search","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":"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":"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":"turbopuffer-dual-write","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},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","href":"/_mintlify/custom/argyle/225e00a80fa65353/style.css"},{"filePath":"changelog.css","href":"/_mintlify/custom/argyle/43713bf2b359289f/changelog.css"}],"page":{"pagePath":"api-reference/partners-verifications/upload-a-document","slug":"/api-reference/partners-verifications/upload-a-document","pageMetadata":{"title":"Upload a document","sidebarTitle":"Upload a document","openapi":"openAPI/verifications-partners.yaml post /partners/v2/user-uploads","badge":"POST","description":"Upload a document via the API.","href":"/api-reference/partners-verifications/upload-a-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: \"Upload a document via the API.\"\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},{Note}=_components;if(!Note)_missingMdxReference(`Note`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Upload a document via the API.`}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`Can be used in combination with `,_jsx(_components.a,{href:`/integrations/ocr/ocrolus`,children:`OCR processing`}),`.`]})})]})}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":"Upload a document","sidebarTitle":"Upload a document","openapi":"openAPI/verifications-partners.yaml post /partners/v2/user-uploads","badge":"POST","description":"Upload a document via the API.","href":"/api-reference/partners-verifications/upload-a-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":"Upload a document","description":"Upload a document via the API.","requestBody":"e5dafee2-34e0-4cb8-a607-5e10455122ae","responses":{"200":"7a4b1b9d-bf30-4008-807e-1417242be630"},"method":"post","type":"path","servers":["bf993614-d3b0-4e6a-bd2f-7820b61e62fd","15365ab4-1148-4a7b-9d35-5a986d9704da"],"security":["c699f647-5734-4bbf-9409-6b3b66121944"],"path":"/partners/v2/user-uploads","baseUrlOptions":["https://api-sandbox.argyle.com","https://api.argyle.com"],"title":"Upload a document","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","required":["user","document_type","upload"],"properties":{"user":{"type":"string","format":"uuid","description":"ID of the user object.","isRequired":true,"uniqueKey":"user","typeLabel":"string\u003cuuid>"},"document_type":{"type":"string","enum":["paystubs","W-2",1099,"proof-of-identity","proof-of-address","miscellaneous"],"description":"The type of document.","isRequired":true,"uniqueKey":"document_type","typeLabel":"enum\u003cstring>"},"upload":{"type":"string","format":"binary","description":"Link to the document to be uploaded.\n\nMax of 1 file per POST request.\n","isRequired":true,"uniqueKey":"upload","typeLabel":"file"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"user":"3c90c3cc-0d44-4b50-8888-8dd25736052a","upload":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"7a4b1b9d-bf30-4008-807e-1417242be630":{"description":"A user upload object.","content":{"application/json":{"schema":{"type":"object","example":{"id":"01320596-2c3d-189c-53e7-a8ce6d625b33","account":"01856c65-43b6-8b5d-b32a-56b8fbda5c28","document_type":"paystubs","file_url":"www.argyle.com/storagename","file_name":"combined_paystubs.pdf","metadata":{"employment":{},"ocr_documents":[{"ocr_data":{},"ocr_authenticity":{},"ocr_authenticity_score":null},{"ocr_data":{},"ocr_authenticity":{},"ocr_authenticity_score":null}],"ocr_data":{},"ocr_authenticity":{},"ocr_authenticity_score":null},"processing":{"classification":"completed","ocr":"completed","authenticity":"completed"},"created_at":"2024-07-08T13:43:49.864Z","updated_at":"2024-07-08T13:43:51.868Z"},"properties":{"id":{"type":"string","format":"uuid","description":"Unique ID of the uploaded document.","uniqueKey":"id","typeLabel":"string\u003cuuid>"},"account":{"type":"string","format":"uuid","description":"ID of the account associated with the uploaded document.","uniqueKey":"account","typeLabel":"string\u003cuuid>"},"document_type":{"type":"string","description":"The document [category](/workflows/document-processing#enabling-document-uploads) in Link the user selected, or the `document_type` provided when [uploading via the API](/api-reference/user-uploads#upload).\n\nIf [OCR processing](/integrations/ocr/ocrolus) is enabled, this value is overwritten when the document is found to be a different type.\n\nPossible values:\n- `paystubs`\n- `W-2`\n- `1099`\n- `proof-of-identity`\n- `proof-of-address`\n- `miscellaneous`\n","uniqueKey":"document_type","typeLabel":"string"},"file_url":{"type":"string","description":"URL linking to the original uploaded document file.\n\nThis static URL redirects to a download page that requires [Argyle authentication headers](/api-guide/overview#authentication).\n\n**Implementation requirements for client-side applications**\n\n1. Ensure your HTTP client or library (for example, Axios or Python requests) is configured to follow redirects.\n2. Append [Basic authentication headers](/api-guide/overview#authentication) for Argyle to the file download request.\n","uniqueKey":"file_url","typeLabel":"string"},"file_name":{"type":"string","description":"File name of the uploaded document on the user's computer or phone.","uniqueKey":"file_name","typeLabel":"string"},"metadata":{"type":"object","description":"Contains document OCR and authenticity information.","properties":{"employment":{"type":"object","description":"Contains document verification data.","uniqueKey":"metadata.employment","typeLabel":"object"},"ocr_documents":{"type":"array","description":"Always included. Contains one OCR and authenticity result for each document detected within the uploaded file.","items":{"type":"object","description":"Contains OCR and authenticity results for one document detected within an uploaded file.","properties":{"ocr_data":{"type":"object","description":"Contains [Ocrolus OCR](/integrations/ocr/ocrolus#api) data for the detected document.\n\nAvailable for paystubs, W-2s, and 1099s when Ocrolus is enabled.\n","uniqueKey":"metadata.ocr_documents.items.[INDEX].ocr_data","typeLabel":"object"},"ocr_authenticity":{"type":"object","description":"Contains [Ocrolus authenticity](/integrations/ocr/ocrolus#api) data for the detected document.\n\nIncludes individual instances of tampering or other authenticity-related edits detected in the document.\n\nAvailable for paystubs, W-2s, and 1099s when Ocrolus is enabled.\n","uniqueKey":"metadata.ocr_documents.items.[INDEX].ocr_authenticity","typeLabel":"object"},"ocr_authenticity_score":{"oneOf":[{"type":"integer","description":"[Ocrolus authenticity score](/integrations/ocr/ocrolus#authenticity-scores) for the detected document.\n\nSingle score that captures the likelihood the detected document is authentic, as determined by Ocrolus.\n\nAvailable for paystubs, W-2s, and 1099s when Ocrolus is enabled.\n","uniqueKey":"metadata.ocr_documents.items.[INDEX].ocr_authenticity_score.oneOf.0","typeLabel":"integer"},{"type":"null","description":"[Ocrolus authenticity score](/integrations/ocr/ocrolus#authenticity-scores) for the detected document.\n\nSingle score that captures the likelihood the detected document is authentic, as determined by Ocrolus.\n\nAvailable for paystubs, W-2s, and 1099s when Ocrolus is enabled.\n","uniqueKey":"metadata.ocr_documents.items.[INDEX].ocr_authenticity_score.oneOf.1","typeLabel":"null"}],"uniqueKey":"metadata.ocr_documents.items.[INDEX].ocr_authenticity_score","typeLabel":"integer | null"}},"uniqueKey":"metadata.ocr_documents.items.[INDEX]","typeLabel":"object"},"uniqueKey":"metadata.ocr_documents","typeLabel":"object[]"},"ocr_data":{"type":"object","deprecated":true,"description":"Deprecated. Use `ocr_documents[].ocr_data`.","uniqueKey":"metadata.ocr_data","typeLabel":"object"},"ocr_authenticity":{"type":"object","deprecated":true,"description":"Deprecated. Use `ocr_documents[].ocr_authenticity`.","uniqueKey":"metadata.ocr_authenticity","typeLabel":"object"},"ocr_authenticity_score":{"oneOf":[{"type":"integer","deprecated":true,"description":"Deprecated. Use `ocr_documents[].ocr_authenticity_score`.","uniqueKey":"metadata.ocr_authenticity_score.oneOf.0","typeLabel":"integer"},{"type":"null","deprecated":true,"description":"Deprecated. Use `ocr_documents[].ocr_authenticity_score`.","uniqueKey":"metadata.ocr_authenticity_score.oneOf.1","typeLabel":"null"}],"uniqueKey":"metadata.ocr_authenticity_score","typeLabel":"integer | null"}},"uniqueKey":"metadata","typeLabel":"object"},"processing":{"type":"object","description":"Contains OCR processing statuses.","properties":{"classification":{"type":"string","enum":["unauthorized","idle","in_progress","completed","failed"],"description":"OCR classification processing status.\n\n- `unauthorized`: Classification permissions are not enabled.\n- `idle`: Processing has not started.\n- `in_progress`: Processing is in progress.\n- `completed`: Processing successfully completed.\n- `failed`: Processing failed.\n","uniqueKey":"processing.classification","typeLabel":"enum\u003cstring>"},"ocr":{"type":"string","enum":["unauthorized","idle","in_progress","completed","failed"],"description":"Full OCR processing status.\n\n- `unauthorized`: Full OCR permissions are not enabled.\n- `idle`: Processing has not started.\n- `in_progress`: Processing is in progress.\n- `completed`: Processing successfully completed.\n- `failed`: Processing failed.\n","uniqueKey":"processing.ocr","typeLabel":"enum\u003cstring>"},"authenticity":{"type":"string","enum":["unauthorized","idle","in_progress","completed","failed"],"description":"OCR authenticity processing status.\n\n- `unauthorized`: Full OCR permissions are not enabled.\nFull OCR permissions are required for authenticity.\n- `idle`: Processing has not started.\n- `in_progress`: Processing is in progress.\n- `completed`: Processing successfully completed.\n- `failed`: Processing failed.\n","uniqueKey":"processing.authenticity","typeLabel":"enum\u003cstring>"}},"uniqueKey":"processing","typeLabel":"object"},"created_at":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when the uploaded document was submitted.","uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when the user upload object was last updated.","uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"01320596-2c3d-189c-53e7-a8ce6d625b33","account":"01856c65-43b6-8b5d-b32a-56b8fbda5c28","document_type":"paystubs","file_url":"www.argyle.com/storagename","file_name":"combined_paystubs.pdf","metadata":{"employment":{},"ocr_documents":[{"ocr_data":{},"ocr_authenticity":{},"ocr_authenticity_score":null},{"ocr_data":{},"ocr_authenticity":{},"ocr_authenticity_score":null}],"ocr_data":{},"ocr_authenticity":{},"ocr_authenticity_score":null},"processing":{"classification":"completed","ocr":"completed","authenticity":"completed"},"created_at":"2024-07-08T13:43:49.864Z","updated_at":"2024-07-08T13:43:51.868Z"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"c699f647-5734-4bbf-9409-6b3b66121944":{"basicAuth":{"type":"http","scheme":"basic","description":"Username = api_key_id, Password = api_key_secret","scopes":[],"schemeName":"basicAuth"}}},"servers":{"bf993614-d3b0-4e6a-bd2f-7820b61e62fd":{"url":"https://api-sandbox.argyle.com","description":"Sandbox"},"15365ab4-1148-4a7b-9d35-5a986d9704da":{"url":"https://api.argyle.com","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"basic","description":"Username = api_key_id, Password = api_key_secret","scopes":[],"schemeName":"basicAuth"},"schema":{"title":"Basic Auth","type":"object","description":"Username = api_key_id, Password = api_key_secret","isRequired":true,"properties":{"username":{"type":"string","uniqueKey":"username","isRequired":true,"typeLabel":"string","deprecated":false},"password":{"type":"string","uniqueKey":"password","isRequired":true,"typeLabel":"string","deprecated":false}},"additionalProperties":false,"deprecated":false},"schemeName":"basicAuth","name":"Authorization"}],"title":"basicAuth"}]},"originalFileLocation":"openAPI/verifications-partners.yaml"},"subdomain":"argyle","siteName":"Argyle Docs","title":"Upload a document - Argyle Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-05-28T16:25:21.399Z","originalFileLocation":"api-reference/partners-verifications/upload-a-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=\"Upload a document via the API.\">\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=\"Upload a document - Argyle Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Upload a document via the API.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Argyle Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.argyle.com/api-reference/partners-verifications/upload-a-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=\"Upload a document - Argyle Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Upload a document via the API.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://docs.argyle.com/images/social/argyle-docs.png\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/argyle/cbIyejDMMl6E05gL/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Argyle Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#214E48\">\u003cmeta data-mint-head name=\"og:image:alt\" content=\"Argyle\">\u003cmeta data-mint-head name=\"twitter:image:alt\" content=\"Argyle\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.argyle.com/api-reference/partners-verifications/upload-a-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/partners-verifications/upload-a-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/partners-verifications/upload-a-document#webpage\",\"url\":\"https://docs.argyle.com/api-reference/partners-verifications/upload-a-document\",\"name\":\"Upload a document\",\"description\":\"Upload a document via the API.\",\"dateModified\":\"2026-05-28T16:25:21.399Z\",\"isPartOf\":{\"@id\":\"https://docs.argyle.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.argyle.com/api-reference/partners-verifications/upload-a-document#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.argyle.com/api-reference/partners-verifications/upload-a-document#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Partner Verifications\",\"item\":\"https://docs.argyle.com/api-reference/partners-verifications/order-a-verification\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Upload a document\",\"item\":\"https://docs.argyle.com/api-reference/partners-verifications/upload-a-document\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.argyle.com/api-reference/partners-verifications/upload-a-document#apireference\",\"headline\":\"Upload a document\",\"name\":\"Upload a document\",\"description\":\"Upload a document via the API.\",\"url\":\"https://docs.argyle.com/api-reference/partners-verifications/upload-a-document\",\"mainEntityOfPage\":{\"@id\":\"https://docs.argyle.com/api-reference/partners-verifications/upload-a-document#webpage\"},\"image\":\"https://docs.argyle.com/images/social/argyle-docs.png\",\"dateModified\":\"2026-05-28T16:25:21.399Z\",\"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.","pages":[{"title":"Clients","href":""}]},{"product":"Partners","icon":"puzzle-piece","description":"Build for your customers.","tabs":[{"tab":"Home","pages":[{"title":"Home","href":"/partners"}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/verifications/platform-partners"}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"Partner API Reference","href":"/partners/api-reference"}]},{"group":"Users","pages":[{"openapi":"openAPI/verifications-partners.yaml post /partners/v2/users","title":"Create a user","sidebarTitle":"Create a user","href":"/api-reference/partners-verifications/create-a-user"},{"openapi":"openAPI/verifications-partners.yaml patch /partners/v2/users/{id}","title":"Update a user","sidebarTitle":"Update a user","href":"/api-reference/partners-verifications/update-a-user"}]},{"group":"Partner Verifications","pages":[{"openapi":"openAPI/verifications-partners.yaml post /partners/v2/verifications","title":"Order a verification","sidebarTitle":"Order a verification","href":"/api-reference/partners-verifications/order-a-verification"},{"openapi":"openAPI/verifications-partners.yaml post /partners/v2/sessions","title":"Create a session","sidebarTitle":"Create a session","href":"/api-reference/partners-verifications/create-a-session"},{"openapi":"openAPI/verifications-partners.yaml post /partners/v2/verifications/refresh","title":"Refresh a verification","sidebarTitle":"Refresh a verification","href":"/api-reference/partners-verifications/refresh-a-verification"},{"openapi":"openAPI/verifications-partners.yaml get /partners/v2/verifications/{id}","title":"Retrieve a verification","sidebarTitle":"Retrieve a verification","href":"/api-reference/partners-verifications/retrieve-a-verification"},{"openapi":"openAPI/verifications-partners.yaml patch /partners/v2/verifications/{id}","title":"Update a verification","sidebarTitle":"Update a verification","href":"/api-reference/partners-verifications/update-a-verification"},{"openapi":"openAPI/verifications-partners.yaml post /partners/v2/verifications/{id}/cancel","title":"Cancel a verification","sidebarTitle":"Cancel a verification","href":"/api-reference/partners-verifications/cancel-a-verification"},{"openapi":"openAPI/verifications-partners.yaml get /partners/v2/verifications","title":"List all verifications","sidebarTitle":"List all verifications","description":"Returns a paginated list of all verification objects.","href":"/api-reference/partners-verifications/list-all-verifications"},{"title":"Upload a document","sidebarTitle":"Upload a document","openapi":"openAPI/verifications-partners.yaml post /partners/v2/user-uploads","href":"/api-reference/partners-verifications/upload-a-document"}]},{"group":"Partner Webhooks","pages":[{"title":"Verifications.updated webhook","description":"The verifications.updated webhook is sent when a verification's status changes.","openapi":"openAPI/verifications-partners-webhooks-updated.yaml post /partners/v2/webhooks","sidebarTitle":"Updated","href":"/api-reference/partners-webhooks/updated"},{"title":"Verifications.creation_failed webhook","openapi":"openAPI/verifications-partners-webhooks-creation-failed.yaml post /partners/v2/webhooks","sidebarTitle":"Creation failed","href":"/api-reference/partners-webhooks/creation-failed"},{"title":"Verifications.connection_added webhook","openapi":"openAPI/verifications-partners-webhooks-connection-added.yaml post /partners/v2/webhooks","sidebarTitle":"Connection added","href":"/api-reference/partners-webhooks/connection-added"},{"group":"Webhook management","pages":[{"title":"Create a webhook","openapi":"openAPI/webhooks.yaml post /partners/v2/webhooks","href":"/api-reference/partners-webhooks/create-a-webhook"},{"title":"Retrieve a webhook","openapi":"openAPI/webhooks.yaml get /partners/v2/webhooks/{id}","href":"/api-reference/partners-webhooks/retrieve-a-webhook"},{"title":"Delete a webhook","openapi":"openAPI/webhooks.yaml delete /partners/v2/webhooks/{id}","href":"/api-reference/partners-webhooks/delete-a-webhook"},{"title":"List all webhooks","openapi":"openAPI/webhooks.yaml get /partners/v2/webhooks","href":"/api-reference/partners-webhooks/list-all-webhooks"}]}]},{"group":"Partner Data Sets","pages":[{"title":"Retrieve An Account","openapi":"openAPI/verifications-partners.yaml get /partners/v2/accounts/{id}","sidebarTitle":"Retrieve an account","href":"/api-reference/partners-data-sets/retrieve-an-account"},{"title":"List All Accounts","openapi":"openAPI/verifications-partners.yaml get /partners/v2/accounts","sidebarTitle":"List all accounts","href":"/api-reference/partners-data-sets/list-all-accounts"},{"title":"Retrieve a bank account","openapi":"openAPI/verifications-partners.yaml get /partners/v2/bank-accounts/{bank_account_id}","sidebarTitle":"Retrieve a bank account","href":"/api-reference/partners-data-sets/retrieve-a-bank-account"},{"title":"List all bank accounts","openapi":"openAPI/verifications-partners.yaml get /partners/v2/bank-accounts","sidebarTitle":"List all bank accounts","href":"/api-reference/partners-data-sets/list-all-bank-accounts"},{"openapi":"openAPI/verifications-partners.yaml get /partners/v2/payroll-documents/{id}","title":"Retrieve a payroll document","sidebarTitle":"Retrieve a payroll document","href":"/api-reference/partners-data-sets/retrieve-a-payroll-document"},{"openapi":"openAPI/verifications-partners.yaml get /partners/v2/payroll-documents","title":"List all payroll documents","sidebarTitle":"List all payroll documents","href":"/api-reference/partners-data-sets/list-all-payroll-documents"},{"openapi":"openAPI/verifications-partners.yaml get /partners/v2/paystubs/{id}","title":"Retrieve a paystub","sidebarTitle":"Retrieve a paystub","href":"/api-reference/partners-data-sets/retrieve-a-paystub"},{"openapi":"openAPI/verifications-partners.yaml get /partners/v2/paystubs","title":"List all paystubs","sidebarTitle":"List all paystubs","href":"/api-reference/partners-data-sets/list-all-paystubs"}]},{"group":"Partner Receipts","pages":[{"openapi":"openAPI/verifications-partners.yaml post /partners/v2/receipts","title":"Receipts","sidebarTitle":"Receipts","href":"/api-reference/partners-receipts"}]}]}]},{"product":"Changelog","description":"Product updates and announcements","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Upload a document - Argyle Docs","buildId":"dpl_BLQvU86QFwq3AhPofSTw6q8dGWKm","deploymentId":"dpl_BLQvU86QFwq3AhPofSTw6q8dGWKm","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Myd8dsju.js","utils-C2HkQgW0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-8rSppmTv.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B6MjiCFm.js","snippetPresets-DwrSAONL.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-1-a5UQKQ.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C541m7wZ.js","shallow-CWELCZ77.js","getApiPlaygroundDisplay-CTo5Zn03.js","CodeSnippet-D--dzvnl.js","CodeSnippets-DM3cXEDh.js","Page-CxAy5y67.js","getPastedJson-C-VECgcL.js","icon-BPq2-Mg3.js","MethodPill-D9J5cUHd.js","DuplicateIcon-BqHaxUnD.js","createIcon-CIbcZHp9.js","DynamicMarkdown-BKiHAm_d.js","SectionHeading-DstQXt3H.js","axios-vUo_bRtp.js","Markdown-CpxgzsKA.js","clsx-C5EfhVm0.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CJ9Oly2E.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Mk6P3qvh.js"]}