{
"error_code": "request.cases.file.missing-risk-score",
"error_message": "User tried to perform an invalid operation on a file without a risk score.",
"error_details": {
"field": "email_address"
}
}
{
"error_code": "request.cases.file.missing-risk-score",
"error_message": "User tried to perform an invalid operation on a file without a risk score.",
"error_details": {
"field": "email_address"
}
}
{
"error_code": "request.cases.file.missing-risk-score",
"error_message": "User tried to perform an invalid operation on a file without a risk score.",
"error_details": {
"field": "email_address"
}
}
Document Requests
List Document Requests
Retrieve a paginated list of the document requests you can reach.
GET
/
document-requests
List document requests
curl --request GET \ --url https://api.uk.veridox.ai/document-requests \ --header 'x-api-key: <api-key>'
{
"error_code": "request.cases.file.missing-risk-score",
"error_message": "User tried to perform an invalid operation on a file without a risk score.",
"error_details": {
"field": "email_address"
}
}
{
"error_code": "request.cases.file.missing-risk-score",
"error_message": "User tried to perform an invalid operation on a file without a risk score.",
"error_details": {
"field": "email_address"
}
}
{
"error_code": "request.cases.file.missing-risk-score",
"error_message": "User tried to perform an invalid operation on a file without a risk score.",
"error_details": {
"field": "email_address"
}
}
Retrieve a paginated list of document requests. This endpoint supports filtering by status, searching by ID, and sorting options.
This endpoint requires the Document Requests feature to be enabled for your organisation. Without it, the API returns 403 with request.organisations.module.not-enabled. Learn more.
You see the document requests you created, or every document request in your organisation if you have organisation_cases:read. An API key without organisation_cases:read receives an empty list. See Permissions and API Keys.
Required range: -9007199254740991 <= x <= 9007199254740991
Was this page helpful?
⌘I
{"docsConfig":{"theme":"willow","$schema":"https://mintlify.com/docs.json","name":"Veridox","colors":{"primary":"#3B82F6","light":"#60A5FA","dark":"#2563EB"},"logo":{"light":"https://mintcdn.com/veridox/Rh_pg3SYjqVB3FW-/logo/light.svg?fit=max\u0026auto=format\u0026n=Rh_pg3SYjqVB3FW-\u0026q=85\u0026s=22962184728c15e374cfcc4d27f82dd9","dark":"https://mintcdn.com/veridox/Rh_pg3SYjqVB3FW-/logo/dark.svg?fit=max\u0026auto=format\u0026n=Rh_pg3SYjqVB3FW-\u0026q=85\u0026s=290f45e82b140e387526bd94c2ce4772"},"favicon":"https://mintcdn.com/veridox/Rh_pg3SYjqVB3FW-/favicon.svg?fit=max\u0026auto=format\u0026n=Rh_pg3SYjqVB3FW-\u0026q=85\u0026s=cd14f527153781ef4947543ac149cdf4","navbar":{"links":[{"href":"mailto:support@veridox.ai","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://veridox.ai"}},"footer":{"socials":{"linkedin":"https://linkedin.com/company/veridox-ai"}},"fonts":{"family":"Inter"},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"metadata":{"timestamp":false},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"veridox","hasAudioNarration":false,"actualSubdomain":"veridox","customDomains":["docs.veridox.ai"],"gitSource":{"type":"github","owner":"veridox-ai","repo":"neo-api-documentation","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6aecb73f64441d6863c96f62","collectionId":"9a2b92f6-e122-40c6-8c90-cdcf2fb4720e","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aecb73f64441d6863c96f62"},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{},"buildId":"6aecb73f64441d6863c96f62","clientVersion":"0.0.4074","searchFilterCounts":[{"language":"default","tag":"API Reference","count":31},{"language":"default","tag":"Guides","count":14},{"language":"default","tag":"Files","count":8},{"language":"default","tag":"Cases","count":7},{"language":"default","tag":"Organisation","count":7},{"language":"default","tag":"Document Requests","count":5},{"language":"default","tag":"Core Features","count":5},{"language":"default","tag":"Resources","count":5},{"language":"default","tag":"Getting Started","count":4},{"language":"default","tag":"Authentication","count":2}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"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":"styles.css","content":".changelog-impact{color:var(--gray-11, #6b7280);font-size:0.925em}"}],"page":{"pagePath":"api-reference/endpoints/document-requests-list","slug":"/api-reference/endpoints/document-requests-list","pageMetadata":{"title":"List Document Requests","description":"Retrieve a paginated list of the document requests you can reach.","openapi":"GET /document-requests","href":"/api-reference/endpoints/document-requests-list"},"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: \"Retrieve a paginated list of the document requests you can reach.\"\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`,code:`code`,li:`li`,ol:`ol`,p:`p`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{Heading,Note}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Retrieve a paginated list of document requests. This endpoint supports filtering by status, searching by ID, and sorting options.`}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`This endpoint requires the `,_jsx(_components.strong,{children:`Document Requests`}),` feature to be enabled for your organisation. Without it, the API returns `,_jsx(_components.code,{children:`403`}),` with `,_jsx(_components.code,{children:`request.organisations.module.not-enabled`}),`. `,_jsx(_components.a,{href:`/guides/feature-modules`,children:`Learn more`}),`.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`permission`,children:`Permission`}),`\n`,_jsxs(_components.p,{children:[`You see the document requests you created, or every document request in your organisation if you have `,_jsx(_components.code,{children:`organisation_cases:read`}),`. An API key without `,_jsx(_components.code,{children:`organisation_cases:read`}),` receives an empty list. See `,_jsx(_components.a,{href:`/guides/permissions`,children:`Permissions and API Keys`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`features`,children:`Features`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Filtering`}),`: Filter by request status (`,_jsx(_components.code,{children:`pending`}),`, `,_jsx(_components.code,{children:`completed`}),`, `,_jsx(_components.code,{children:`expired`}),`) or specific request ID.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Sorting`}),`: Order results by creation date to find newest requests first.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Pagination`}),`: Use `,_jsx(_components.code,{children:`limit`}),` and `,_jsx(_components.code,{children:`offset`}),` to manage large result sets.`]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`best-practices`,children:`Best Practices`}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Monitor Status`}),`: Regularly list `,_jsx(_components.code,{children:`pending`}),` requests to track completion rates and identify customers who may need a follow-up.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Expiration Tracking`}),`: Identify requests approaching their `,_jsx(_components.code,{children:`expires_at`}),` date to ensure document collection is completed in time.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Efficiency`}),`: Use a `,_jsx(_components.code,{children:`limit`}),` of 100 for background reporting and 20-50 for user-facing dashboards.`]}),`\n`]})]})}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":{"config":{},"pageMetadata":{"title":"List Document Requests","description":"Retrieve a paginated list of the document requests you can reach.","openapi":"GET /document-requests","href":"/api-reference/endpoints/document-requests-list"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Permission","slug":"permission","depth":2,"children":[]},{"title":"Features","slug":"features","depth":2,"children":[]},{"title":"Best Practices","slug":"best-practices","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Retrieve a paginated list of the document requests you can reach.","operationId":"DocumentRequestsController_listDocumentRequests","parameters":["7bf22a45-abfb-46b6-82e0-b92f41aa98b4","28e81148-fc80-4662-a4df-808579746759","daa2f7e2-6c80-4681-8ef3-6f2fe8827ac7","f16c7735-1b4a-4d7c-ba0c-a1ea2152c722","ac2110a4-3ca3-4062-b36b-af32a81c7280"],"responses":{"200":"c9bcb1f5-7cd5-4578-84bd-d855c58cc263","400":"9ca6f720-91f9-4e7b-8b99-6df71fc45ec3","401":"5c75a447-07e2-45be-95a9-4e5154e0b28c","429":"3de7d52e-aedb-4b94-ba93-9f716aa9b245"},"security":["cfe6599b-3eeb-41b0-9c3a-6652915e6837"],"summary":"List document requests","tags":["Document Requests"],"method":"get","type":"path","servers":["ba735795-38f0-4be6-a745-6d575650f271","2ccaa4cb-416d-43a5-bb15-9657213108ed","b5bfbc9b-2a7f-4105-b910-f3fda28e5c60"],"path":"/document-requests","baseUrlOptions":["https://api.uk.veridox.ai","https://api.ca.veridox.ai","https://api.eu.veridox.ai"],"title":"List document requests","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"7bf22a45-abfb-46b6-82e0-b92f41aa98b4":{"name":"id","required":false,"in":"query","x-nestjs_zod-parent-additional-properties":false,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cuuid>"}},"28e81148-fc80-4662-a4df-808579746759":{"name":"status","required":false,"in":"query","x-nestjs_zod-parent-additional-properties":false,"schema":{"type":"string","enum":["pending","completed","expired"],"isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring>"}},"daa2f7e2-6c80-4681-8ef3-6f2fe8827ac7":{"name":"limit","required":false,"in":"query","x-nestjs_zod-parent-additional-properties":false,"schema":{"default":"20","type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"}},"f16c7735-1b4a-4d7c-ba0c-a1ea2152c722":{"name":"offset","required":false,"in":"query","x-nestjs_zod-parent-additional-properties":false,"schema":{"default":"0","type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"}},"ac2110a4-3ca3-4062-b36b-af32a81c7280":{"name":"sort_order","required":false,"in":"query","x-nestjs_zod-parent-additional-properties":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"],"isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring>"}}},"responses":{"c9bcb1f5-7cd5-4578-84bd-d855c58cc263":{"description":"List of document requests retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"links":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$","isRequired":true,"uniqueKey":"links.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"case_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$","isRequired":true,"uniqueKey":"links.items.[INDEX].case_id","typeLabel":"string\u003cuuid>"},"recipient_email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$","isRequired":true,"uniqueKey":"links.items.[INDEX].recipient_email","typeLabel":"string\u003cemail>"},"recipient_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"links.items.[INDEX].recipient_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"links.items.[INDEX].recipient_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"links.items.[INDEX].recipient_name","typeLabel":"string | null"},"label":{"type":"string","isRequired":true,"uniqueKey":"links.items.[INDEX].label","typeLabel":"string"},"status":{"type":"string","enum":["pending","completed","expired"],"isRequired":true,"uniqueKey":"links.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"expires_at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","isRequired":true,"uniqueKey":"links.items.[INDEX].expires_at","typeLabel":"string\u003cdate-time>"},"max_files":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"links.items.[INDEX].max_files","typeLabel":"integer"},"created_at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","isRequired":true,"uniqueKey":"links.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","isRequired":true,"uniqueKey":"links.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"}},"required":["id","case_id","recipient_email","recipient_name","label","status","expires_at","max_files","created_at","updated_at"],"additionalProperties":false,"uniqueKey":"links.items.[INDEX]","typeLabel":"object"},"x-nestjs_zod-uses-3-point-1-syntax":true,"x-nestjs_zod-parent-additional-properties":false,"isRequired":true,"uniqueKey":"links","typeLabel":"object[]"},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"x-nestjs_zod-uses-3-point-1-syntax":true,"x-nestjs_zod-parent-additional-properties":false,"isRequired":true,"uniqueKey":"total","typeLabel":"integer"},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"x-nestjs_zod-uses-3-point-1-syntax":true,"x-nestjs_zod-parent-additional-properties":false,"isRequired":true,"uniqueKey":"limit","typeLabel":"integer"},"offset":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"x-nestjs_zod-uses-3-point-1-syntax":true,"x-nestjs_zod-parent-additional-properties":false,"isRequired":true,"uniqueKey":"offset","typeLabel":"integer"}},"required":["links","total","limit","offset"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"links":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","case_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","recipient_email":"jsmith@example.com","recipient_name":"\u003cstring>","label":"\u003cstring>","status":"pending","expires_at":"2023-11-07T05:31:56Z","max_files":0,"created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z"}],"total":0,"limit":0,"offset":0}}},"exampleType":"generated"}},"exampleType":"generated"},"9ca6f720-91f9-4e7b-8b99-6df71fc45ec3":{"description":"Invalid query parameters","content":{"application/json":{"schema":{"type":"object","properties":{"error_code":{"type":"string","description":"Machine-readable error code for programmatic handling","examples":["request.cases.file.missing-risk-score","request.authentication.invalid-token","request.forbidden","request.cases.case.not-found","request.cases.case.already-locked"],"isRequired":true,"uniqueKey":"error_code","typeLabel":"string"},"error_message":{"type":"string","description":"Human-readable error message explaining what went wrong","example":"User tried to perform an invalid operation on a file without a risk score.","isRequired":true,"uniqueKey":"error_message","typeLabel":"string"},"error_details":{"type":"object","example":{"field":"email_address"},"uniqueKey":"error_details","typeLabel":"object"}},"required":["error_code","error_message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error_code":"request.cases.file.missing-risk-score","error_message":"User tried to perform an invalid operation on a file without a risk score.","error_details":{"field":"email_address"}}}},"exampleType":"generated"}},"exampleType":"generated"},"5c75a447-07e2-45be-95a9-4e5154e0b28c":{"description":"Unauthorized (invalid or missing authentication token)","content":{"application/json":{"schema":{"type":"object","properties":{"error_code":{"type":"string","description":"Machine-readable error code for programmatic handling","examples":["request.cases.file.missing-risk-score","request.authentication.invalid-token","request.forbidden","request.cases.case.not-found","request.cases.case.already-locked"],"isRequired":true,"uniqueKey":"error_code","typeLabel":"string"},"error_message":{"type":"string","description":"Human-readable error message explaining what went wrong","example":"User tried to perform an invalid operation on a file without a risk score.","isRequired":true,"uniqueKey":"error_message","typeLabel":"string"},"error_details":{"type":"object","example":{"field":"email_address"},"uniqueKey":"error_details","typeLabel":"object"}},"required":["error_code","error_message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error_code":"request.cases.file.missing-risk-score","error_message":"User tried to perform an invalid operation on a file without a risk score.","error_details":{"field":"email_address"}}}},"exampleType":"generated"}},"exampleType":"generated"},"3de7d52e-aedb-4b94-ba93-9f716aa9b245":{"description":"Too many requests (rate limit exceeded)","content":{"application/json":{"schema":{"type":"object","properties":{"error_code":{"type":"string","description":"Machine-readable error code for programmatic handling","examples":["request.cases.file.missing-risk-score","request.authentication.invalid-token","request.forbidden","request.cases.case.not-found","request.cases.case.already-locked"],"isRequired":true,"uniqueKey":"error_code","typeLabel":"string"},"error_message":{"type":"string","description":"Human-readable error message explaining what went wrong","example":"User tried to perform an invalid operation on a file without a risk score.","isRequired":true,"uniqueKey":"error_message","typeLabel":"string"},"error_details":{"type":"object","example":{"field":"email_address"},"uniqueKey":"error_details","typeLabel":"object"}},"required":["error_code","error_message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error_code":"request.cases.file.missing-risk-score","error_message":"User tried to perform an invalid operation on a file without a risk score.","error_details":{"field":"email_address"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"cfe6599b-3eeb-41b0-9c3a-6652915e6837":{"api-key":{"type":"apiKey","in":"header","name":"x-api-key","scopes":[],"schemeName":"api-key"}}},"servers":{"ba735795-38f0-4be6-a745-6d575650f271":{"url":"https://api.uk.veridox.ai","description":"Live (UK)"},"2ccaa4cb-416d-43a5-bb15-9657213108ed":{"url":"https://api.ca.veridox.ai","description":"Live (CA)"},"b5bfbc9b-2a7f-4105-b910-f3fda28e5c60":{"url":"https://api.eu.veridox.ai","description":"Live (EU)"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","scopes":[],"schemeName":"api-key"},"schema":{"title":"x-api-key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"api-key","name":"x-api-key"}],"title":"api-key"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"veridox","siteName":"Veridox","title":"List Document Requests - Veridox","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-21T11:09:05.835Z","originalFileLocation":"api-reference/endpoints/document-requests-list.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=\"system\"}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=\"Retrieve a paginated list of the document requests you can reach.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Veridox\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/veridox/4VX28dNRRfj3OGVD/_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/veridox/4VX28dNRRfj3OGVD/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/veridox/4VX28dNRRfj3OGVD/_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/veridox/4VX28dNRRfj3OGVD/_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/veridox/4VX28dNRRfj3OGVD/_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/veridox/4VX28dNRRfj3OGVD/_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/veridox/4VX28dNRRfj3OGVD/_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/veridox/4VX28dNRRfj3OGVD/_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/veridox/4VX28dNRRfj3OGVD/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List Document Requests - Veridox\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve a paginated list of the document requests you can reach.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Veridox\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.veridox.ai/api-reference/endpoints/document-requests-list\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://veridox.mintlify.site/_mintlify/api/og/v2?division=Document+Requests\u0026amp;title=List+Document+Requests\u0026amp;description=Retrieve+a+paginated+list+of+the+document+requests+you+can+reach.\u0026amp;theme=ff4b3ec14ee2f65d1cf716c9\u0026amp;signature=a88bb0879ebb15d43d587da4ed48e914ed655c1bdf2a26a10e7507f1ed472d2a\">\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=\"List Document Requests - Veridox\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve a paginated list of the document requests you can reach.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://veridox.mintlify.site/_mintlify/api/og/v2?division=Document+Requests\u0026amp;title=List+Document+Requests\u0026amp;description=Retrieve+a+paginated+list+of+the+document+requests+you+can+reach.\u0026amp;theme=ff4b3ec14ee2f65d1cf716c9\u0026amp;signature=a88bb0879ebb15d43d587da4ed48e914ed655c1bdf2a26a10e7507f1ed472d2a\">\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/veridox/4VX28dNRRfj3OGVD/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Veridox\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3B82F6\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.veridox.ai/api-reference/endpoints/document-requests-list\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoints/document-requests-list.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.veridox.ai/#organization\",\"name\":\"Veridox\",\"url\":\"https://docs.veridox.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/veridox/Rh_pg3SYjqVB3FW-/logo/light.svg?fit=max\u0026auto=format\u0026n=Rh_pg3SYjqVB3FW-\u0026q=85\u0026s=22962184728c15e374cfcc4d27f82dd9\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.veridox.ai#website\",\"name\":\"Veridox\",\"url\":\"https://docs.veridox.ai\",\"publisher\":{\"@id\":\"https://docs.veridox.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.veridox.ai/api-reference/endpoints/document-requests-list#webpage\",\"url\":\"https://docs.veridox.ai/api-reference/endpoints/document-requests-list\",\"name\":\"List Document Requests\",\"description\":\"Retrieve a paginated list of the document requests you can reach.\",\"dateModified\":\"2026-10-21T11:09:05.835Z\",\"isPartOf\":{\"@id\":\"https://docs.veridox.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.veridox.ai/api-reference/endpoints/document-requests-list#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.veridox.ai/api-reference/endpoints/document-requests-list#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Document Requests\",\"item\":\"https://docs.veridox.ai/api-reference/endpoints/document-requests-create\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List Document Requests\",\"item\":\"https://docs.veridox.ai/api-reference/endpoints/document-requests-list\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.veridox.ai/api-reference/endpoints/document-requests-list#apireference\",\"headline\":\"List Document Requests\",\"name\":\"List Document Requests\",\"description\":\"Retrieve a paginated list of the document requests you can reach.\",\"url\":\"https://docs.veridox.ai/api-reference/endpoints/document-requests-list\",\"mainEntityOfPage\":{\"@id\":\"https://docs.veridox.ai/api-reference/endpoints/document-requests-list#webpage\"},\"dateModified\":\"2026-10-21T11:09:05.835Z\",\"publisher\":{\"@id\":\"https://docs.veridox.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.veridox.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Veridox\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Veridox","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API Reference","groups":[{"group":"Authentication","pages":[{"title":"Authentication Status","openapi":"GET /authentication/status","href":"/api-reference/endpoints/auth-status"},{"title":"Get Current User","openapi":"GET /users/me","href":"/api-reference/endpoints/users-me"}]},{"group":"Cases","pages":[{"title":"Create Case","openapi":"POST /cases","href":"/api-reference/endpoints/cases-create"},{"title":"List Cases","openapi":"GET /cases","href":"/api-reference/endpoints/cases-list"},{"title":"Get Case","openapi":"GET /cases/{id}","href":"/api-reference/endpoints/cases-get"},{"title":"Update Case Label","openapi":"PUT /cases/{id}","href":"/api-reference/endpoints/cases-update-label"},{"title":"Upload Files to Case","openapi":"POST /cases/{caseId}/files","href":"/api-reference/endpoints/cases-files-upload"},{"title":"Stream Case Analysis Progress","openapi":"GET /cases/{id}/progress/stream","href":"/api-reference/endpoints/cases-progress-stream"},{"title":"Poll Case Analysis Progress","openapi":"GET /cases/{id}/progress/poll","href":"/api-reference/endpoints/cases-progress-poll"}]},{"group":"Files","pages":[{"title":"List Files","openapi":"GET /files","href":"/api-reference/endpoints/files-list"},{"title":"Get File Analysis","openapi":"GET /files/{fileId}/analysis","href":"/api-reference/endpoints/files-analysis-get"},{"title":"Get Asset URL","openapi":"GET /files/asset-url","href":"/api-reference/endpoints/files-asset-url-get"},{"title":"Confirm or Override Risk Score","openapi":"POST /files/{fileId}/risk-score/confirm","href":"/api-reference/endpoints/files-risk-confirm"},{"title":"Generate Bulk File Download URLs","openapi":"POST /files/download","href":"/api-reference/endpoints/files-download-bulk"},{"title":"Reassign File","openapi":"PATCH /cases/{caseId}/files/{fileId}/reassign","href":"/api-reference/endpoints/files-reassign"},{"title":"Archive File","openapi":"PATCH /cases/{caseId}/files/{fileId}/archive","href":"/api-reference/endpoints/files-archive"},{"title":"Delete File","openapi":"DELETE /cases/{caseId}/files/{fileId}","href":"/api-reference/endpoints/files-delete"}]},{"group":"Document Requests","pages":[{"title":"Create Document Request","description":"Create a document request and send an email invitation to collect files from an external party.","openapi":"POST /document-requests/create","href":"/api-reference/endpoints/document-requests-create"},{"title":"List Document Requests","openapi":"GET /document-requests","href":"/api-reference/endpoints/document-requests-list"},{"title":"Get Document Request","description":"Retrieve detailed information about a specific document request.","openapi":"GET /document-requests/{id}","href":"/api-reference/endpoints/document-requests-get"},{"title":"Resend Document Request","openapi":"POST /document-requests/{id}/resend","href":"/api-reference/endpoints/document-requests-resend"},{"title":"Void Document Request","openapi":"DELETE /document-requests/{id}","href":"/api-reference/endpoints/document-requests-delete"}]},{"group":"Search","pages":[{"title":"Search Cases and Files","openapi":"GET /search","href":"/api-reference/endpoints/search"}]},{"group":"Organisation","pages":[{"title":"Get Branding Logo","openapi":"GET /organisations/branding-logo","href":"/api-reference/endpoints/org-branding-get"},{"title":"Get Verification Setting","openapi":"GET /organisations/features/verification","href":"/api-reference/endpoints/org-verification-get"},{"title":"Update Verification Setting","openapi":"PUT /organisations/features/verification","href":"/api-reference/endpoints/org-verification-update"},{"title":"Get Finding Locations Setting","openapi":"GET /organisations/features/finding-locations","href":"/api-reference/endpoints/org-finding-locations-get"},{"title":"Update Finding Locations Setting","openapi":"PUT /organisations/features/finding-locations","href":"/api-reference/endpoints/org-finding-locations-update"},{"title":"Get Role Permissions","openapi":"GET /organisations/role-permissions","href":"/api-reference/endpoints/org-role-permissions-get"},{"title":"Get Audit Log","openapi":"GET /organisations/audit-log","href":"/api-reference/endpoints/org-audit-log-get"}]},{"group":"System","pages":[{"title":"Get Server Status","openapi":"GET /status","href":"/api-reference/endpoints/status"}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"List Document Requests - Veridox","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"]}