Create Document Request

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
}
'

import requests

url = "https://api.uk.veridox.ai/document-requests/create"

payload = {
    "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
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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
  })
};

fetch('https://api.uk.veridox.ai/document-requests/create', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.uk.veridox.ai/document-requests/create",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.uk.veridox.ai/document-requests/create"

	payload := strings.NewReader("{\n  \"label\": \"<string>\",\n  \"expires_at\": \"2023-11-07T05:31:56Z\",\n  \"recipient_email\": \"jsmith@example.com\",\n  \"max_files\": 19,\n  \"recipient_name\": \"<string>\",\n  \"email_message\": \"<string>\",\n  \"copy\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.uk.veridox.ai/document-requests/create")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"label\": \"<string>\",\n  \"expires_at\": \"2023-11-07T05:31:56Z\",\n  \"recipient_email\": \"jsmith@example.com\",\n  \"max_files\": 19,\n  \"recipient_name\": \"<string>\",\n  \"email_message\": \"<string>\",\n  \"copy\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.uk.veridox.ai/document-requests/create")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"label\": \"<string>\",\n  \"expires_at\": \"2023-11-07T05:31:56Z\",\n  \"recipient_email\": \"jsmith@example.com\",\n  \"max_files\": 19,\n  \"recipient_name\": \"<string>\",\n  \"email_message\": \"<string>\",\n  \"copy\": false\n}"

response = http.request(request)
puts response.read_body

{
  "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"
}

{
  "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"
  }
}

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
}
'

import requests

url = "https://api.uk.veridox.ai/document-requests/create"

payload = {
    "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
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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
  })
};

fetch('https://api.uk.veridox.ai/document-requests/create', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.uk.veridox.ai/document-requests/create",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.uk.veridox.ai/document-requests/create"

	payload := strings.NewReader("{\n  \"label\": \"<string>\",\n  \"expires_at\": \"2023-11-07T05:31:56Z\",\n  \"recipient_email\": \"jsmith@example.com\",\n  \"max_files\": 19,\n  \"recipient_name\": \"<string>\",\n  \"email_message\": \"<string>\",\n  \"copy\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.uk.veridox.ai/document-requests/create")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"label\": \"<string>\",\n  \"expires_at\": \"2023-11-07T05:31:56Z\",\n  \"recipient_email\": \"jsmith@example.com\",\n  \"max_files\": 19,\n  \"recipient_name\": \"<string>\",\n  \"email_message\": \"<string>\",\n  \"copy\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.uk.veridox.ai/document-requests/create")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"label\": \"<string>\",\n  \"expires_at\": \"2023-11-07T05:31:56Z\",\n  \"recipient_email\": \"jsmith@example.com\",\n  \"max_files\": 19,\n  \"recipient_name\": \"<string>\",\n  \"email_message\": \"<string>\",\n  \"copy\": false\n}"

response = http.request(request)
puts response.read_body

{
  "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"
}

{
  "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. If you receive a 403 with request.organisations.module.not-enabled, contact your organisation admin to have it activated. Learn more.

Invitation Workflow

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

Best Practices

Clear Instructions: Use the email_message field to provide context to your customers about why they are being asked to upload documents.
Expiration: Set reasonable expiration dates (e.g., 7-14 days) to maintain security while giving users enough time to gather their files.
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

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))$

Authentication

Cases

Files

Document Requests

Search

Organisation

System

Create Document Request

Invitation Workflow

Best Practices

Authorizations

Body

Response

​Invitation Workflow

​Best Practices

Authorizations

Body

Response

Invitation Workflow

Best Practices