{
"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
Create Document Request
Create a document request and send an email invitation to collect files from an external party.
{
"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"
}
}
Create a new document request to collect files from an external party (guest). This endpoint creates the request record and automatically sends an email invitation with a secure, time-limited upload link.
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.
{"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-create","slug":"/api-reference/endpoints/document-requests-create","pageMetadata":{"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"},"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: \"Create a document request and send an email invitation to collect files from an external party.\"\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`,..._provideComponents(),...props.components},{Heading,Note}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Create a new document request to collect files from an external party (guest). This endpoint creates the request record and automatically sends an email invitation with a secure, time-limited upload link.`}),`\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:[`Requires `,_jsx(_components.code,{children:`organisation_cases:write`}),`, which every role holds by default. A caller without it receives `,_jsx(_components.code,{children:`403`}),`. See `,_jsx(_components.a,{href:`/guides/permissions`,children:`Permissions and API Keys`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`invitation-workflow`,children:`Invitation Workflow`}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Email Sent`}),`: An automated email is sent to the recipient containing a unique link.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Guest Access`}),`: The recipient can click the link to upload documents directly to Veridox without needing an account.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Automatic Association`}),`: All uploaded files are automatically associated with a case in your organisation.`]}),`\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:`Clear Instructions`}),`: Use the `,_jsx(_components.code,{children:`email_message`}),` field to provide context to your customers about why they are being asked to upload documents.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Expiration`}),`: Set reasonable expiration dates (e.g., 7-14 days) to maintain security while giving users enough time to gather their files.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Follow-ups`}),`: Monitor the status of requests and use the `,_jsx(_components.a,{href:`/api-reference/endpoints/document-requests-resend`,children:`Resend`}),` endpoint if a user hasn’t completed their upload before expiry.`]}),`\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":"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"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Permission","slug":"permission","depth":2,"children":[]},{"title":"Invitation Workflow","slug":"invitation-workflow","depth":2,"children":[]},{"title":"Best Practices","slug":"best-practices","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Create a document request and send an email invitation to collect files from an external party.","operationId":"DocumentRequestsController_createDocumentRequest","parameters":[],"requestBody":"f4741b90-500b-491a-b624-0514261f40f4","responses":{"201":"8412a715-de40-4a1d-925b-3e2d5ad4de9f","400":"bc7713f7-745c-4184-bd0b-a0bc27e3ad8c","401":"7de9e3b4-9672-45d3-8a60-0ab1938769ed","429":"809aa88d-1b27-44eb-ad1a-bfc2444ff76a"},"security":["55232e7c-90b1-4c7a-bcc7-01d5be8e62d7"],"summary":"Create a new document request","tags":["Document Requests"],"method":"post","type":"path","servers":["ba735795-38f0-4be6-a745-6d575650f271","2ccaa4cb-416d-43a5-bb15-9657213108ed","b5bfbc9b-2a7f-4105-b910-f3fda28e5c60"],"path":"/document-requests/create","baseUrlOptions":["https://api.uk.veridox.ai","https://api.ca.veridox.ai","https://api.eu.veridox.ai"],"title":"Create a new document request","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":200,"x-nestjs_zod-uses-3-point-1-syntax":true,"x-nestjs_zod-parent-additional-properties":false,"isRequired":true,"uniqueKey":"label","typeLabel":"string"},"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))$","x-nestjs_zod-uses-3-point-1-syntax":true,"x-nestjs_zod-parent-additional-properties":false,"isRequired":true,"uniqueKey":"expires_at","typeLabel":"string\u003cdate-time>"},"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,}$","x-nestjs_zod-uses-3-point-1-syntax":true,"x-nestjs_zod-parent-additional-properties":false,"isRequired":true,"uniqueKey":"recipient_email","typeLabel":"string\u003cemail>"},"max_files":{"type":"integer","exclusiveMinimum":0,"maximum":20,"x-nestjs_zod-uses-3-point-1-syntax":true,"x-nestjs_zod-parent-additional-properties":false,"isRequired":true,"uniqueKey":"max_files","typeLabel":"integer"},"recipient_name":{"type":"string","minLength":1,"maxLength":200,"x-nestjs_zod-uses-3-point-1-syntax":true,"x-nestjs_zod-parent-additional-properties":false,"uniqueKey":"recipient_name","typeLabel":"string"},"email_message":{"type":"string","minLength":1,"maxLength":1000,"x-nestjs_zod-uses-3-point-1-syntax":true,"x-nestjs_zod-parent-additional-properties":false,"uniqueKey":"email_message","typeLabel":"string"},"copy":{"default":false,"type":"boolean","x-nestjs_zod-uses-3-point-1-syntax":true,"x-nestjs_zod-parent-additional-properties":false,"uniqueKey":"copy","typeLabel":"boolean"}},"required":["label","expires_at","recipient_email","max_files"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"label":"\u003cstring>","expires_at":"2023-11-07T05:31:56Z","recipient_email":"jsmith@example.com","max_files":19,"recipient_name":"\u003cstring>","email_message":"\u003cstring>","copy":false}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"8412a715-de40-4a1d-925b-3e2d5ad4de9f":{"description":"Document request created successfully","content":{"application/json":{"schema":{"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})$","x-nestjs_zod-uses-3-point-1-syntax":true,"x-nestjs_zod-parent-additional-properties":false,"isRequired":true,"uniqueKey":"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})$","x-nestjs_zod-uses-3-point-1-syntax":true,"x-nestjs_zod-parent-additional-properties":false,"isRequired":true,"uniqueKey":"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,}$","x-nestjs_zod-uses-3-point-1-syntax":true,"x-nestjs_zod-parent-additional-properties":false,"isRequired":true,"uniqueKey":"recipient_email","typeLabel":"string\u003cemail>"},"recipient_name":{"oneOf":[{"type":"string","x-nestjs_zod-uses-3-point-1-syntax":true,"x-nestjs_zod-empty-type":true,"x-nestjs_zod-parent-additional-properties":false,"isRequired":true,"uniqueKey":"recipient_name.oneOf.0","typeLabel":"string"},{"type":"null","x-nestjs_zod-uses-3-point-1-syntax":true,"x-nestjs_zod-empty-type":true,"x-nestjs_zod-parent-additional-properties":false,"isRequired":true,"uniqueKey":"recipient_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"recipient_name","typeLabel":"string | null"},"label":{"type":"string","x-nestjs_zod-uses-3-point-1-syntax":true,"x-nestjs_zod-parent-additional-properties":false,"isRequired":true,"uniqueKey":"label","typeLabel":"string"},"status":{"type":"string","enum":["pending","completed","expired"],"x-nestjs_zod-uses-3-point-1-syntax":true,"x-nestjs_zod-parent-additional-properties":false,"isRequired":true,"uniqueKey":"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))$","x-nestjs_zod-uses-3-point-1-syntax":true,"x-nestjs_zod-parent-additional-properties":false,"isRequired":true,"uniqueKey":"expires_at","typeLabel":"string\u003cdate-time>"},"max_files":{"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":"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))$","x-nestjs_zod-uses-3-point-1-syntax":true,"x-nestjs_zod-parent-additional-properties":false,"isRequired":true,"uniqueKey":"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))$","x-nestjs_zod-uses-3-point-1-syntax":true,"x-nestjs_zod-parent-additional-properties":false,"isRequired":true,"uniqueKey":"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":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"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"}}},"exampleType":"generated"}},"exampleType":"generated"},"bc7713f7-745c-4184-bd0b-a0bc27e3ad8c":{"description":"Invalid input provided (e.g. past expiry date)","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"},"7de9e3b4-9672-45d3-8a60-0ab1938769ed":{"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"},"809aa88d-1b27-44eb-ad1a-bfc2444ff76a":{"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":{"55232e7c-90b1-4c7a-bcc7-01d5be8e62d7":{"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":"Create Document Request - Veridox","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-13T17:41:29.186Z","originalFileLocation":"api-reference/endpoints/document-requests-create.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=\"Create a document request and send an email invitation to collect files from an external party.\">\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=\"Create Document Request - Veridox\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a document request and send an email invitation to collect files from an external party.\">\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-create\">\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=Create+Document+Request\u0026amp;description=Create+a+document+request+and+send+an+email+invitation+to+collect+files+from+an+external+party.\u0026amp;theme=ff4b3ec14ee2f65d1cf716c9\u0026amp;signature=67bce2851a8deba70e54ba8803081fcf0712975d14f5a6308056664d7b7b42b7\">\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=\"Create Document Request - Veridox\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a document request and send an email invitation to collect files from an external party.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://veridox.mintlify.site/_mintlify/api/og/v2?division=Document+Requests\u0026amp;title=Create+Document+Request\u0026amp;description=Create+a+document+request+and+send+an+email+invitation+to+collect+files+from+an+external+party.\u0026amp;theme=ff4b3ec14ee2f65d1cf716c9\u0026amp;signature=67bce2851a8deba70e54ba8803081fcf0712975d14f5a6308056664d7b7b42b7\">\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-create\">\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-create.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-create#webpage\",\"url\":\"https://docs.veridox.ai/api-reference/endpoints/document-requests-create\",\"name\":\"Create Document Request\",\"description\":\"Create a document request and send an email invitation to collect files from an external party.\",\"dateModified\":\"2026-10-13T17:41:29.186Z\",\"isPartOf\":{\"@id\":\"https://docs.veridox.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.veridox.ai/api-reference/endpoints/document-requests-create#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.veridox.ai/api-reference/endpoints/document-requests-create#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Veridox\",\"item\":\"https://docs.veridox.ai\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create Document Request\",\"item\":\"https://docs.veridox.ai/api-reference/endpoints/document-requests-create\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.veridox.ai/api-reference/endpoints/document-requests-create#apireference\",\"headline\":\"Create Document Request\",\"name\":\"Create Document Request\",\"description\":\"Create a document request and send an email invitation to collect files from an external party.\",\"url\":\"https://docs.veridox.ai/api-reference/endpoints/document-requests-create\",\"mainEntityOfPage\":{\"@id\":\"https://docs.veridox.ai/api-reference/endpoints/document-requests-create#webpage\"},\"dateModified\":\"2026-10-13T17:41:29.186Z\",\"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","description":"Permanently erase a file and everything produced from it.","openapi":"DELETE /cases/{caseId}/files/{fileId}","href":"/api-reference/endpoints/files-delete"}]},{"group":"Document Requests","pages":[{"title":"Create Document Request","openapi":"POST /document-requests/create","href":"/api-reference/endpoints/document-requests-create"},{"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"},{"title":"Get 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":"Create Document Request - 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"]}