Skip to main content
POST
/
document-requests
/
create
Create a new document request
curl --request POST \
  --url https://api.uk.veridox.ai/document-requests/create \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "label": "<string>",
  "expires_at": "2023-11-07T05:31:56Z",
  "recipient_email": "jsmith@example.com",
  "max_files": 19,
  "recipient_name": "<string>",
  "email_message": "<string>",
  "copy": false
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "case_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "recipient_email": "jsmith@example.com",
  "recipient_name": "<string>",
  "label": "<string>",
  "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"
}
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. If you receive a 403 with request.organisations.module.not-enabled, contact your organisation admin to have it activated. Learn more.

​
Invitation Workflow

  1. Email Sent: An automated email is sent to the recipient containing a unique link.
  2. Guest Access: The recipient can click the link to upload documents directly to Veridox without needing an account.
  3. Automatic Association: All uploaded files are automatically associated with a case in your organisation.

​
Best Practices

  1. Clear Instructions: Use the email_message field to provide context to your customers about why they are being asked to upload documents.
  2. Expiration: Set reasonable expiration dates (e.g., 7-14 days) to maintain security while giving users enough time to gather their files.
  3. Follow-ups: Monitor the status of requests and use the Resend endpoint if a user hasn’t completed their upload before expiry.

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
label
string
required
Required string length: 1 - 200
​
expires_at
string<date-time>
required
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))$
​
recipient_email
string<email>
required
Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
​
max_files
integer
required
Required range: x <= 20
​
recipient_name
string
Required string length: 1 - 200
​
email_message
string
Required string length: 1 - 1000
​
copy
boolean
default:false

Response

Document request created successfully

​
id
string<uuid>
required
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})$
​
case_id
string<uuid>
required
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})$
​
recipient_email
string<email>
required
Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
​
recipient_name
string | null
required
​
label
string
required
​
status
enum<string>
required
Available options:
pending,
completed,
expired
​
expires_at
string<date-time>
required
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))$
​
max_files
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
​
created_at
string<date-time>
required
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))$
​
updated_at
string<date-time>
required
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))$