Resend document request email
curl --request POST \
--url https://api.uk.veridox.ai/document-requests/{id}/resend \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"recipient_email": "jsmith@example.com",
"email_message": "<string>",
"copy": false
}
'import requests
url = "https://api.uk.veridox.ai/document-requests/{id}/resend"
payload = {
"recipient_email": "jsmith@example.com",
"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({recipient_email: 'jsmith@example.com', email_message: '<string>', copy: false})
};
fetch('https://api.uk.veridox.ai/document-requests/{id}/resend', 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/{id}/resend",
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([
'recipient_email' => 'jsmith@example.com',
'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/{id}/resend"
payload := strings.NewReader("{\n \"recipient_email\": \"jsmith@example.com\",\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/{id}/resend")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"recipient_email\": \"jsmith@example.com\",\n \"email_message\": \"<string>\",\n \"copy\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.uk.veridox.ai/document-requests/{id}/resend")
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 \"recipient_email\": \"jsmith@example.com\",\n \"email_message\": \"<string>\",\n \"copy\": false\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"recipient_email": "jsmith@example.com",
"sent_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"
}
}{
"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
Resend Document Request
Resend an email invitation for an existing document request.
POST
/
document-requests
/
{id}
/
resend
Resend document request email
curl --request POST \
--url https://api.uk.veridox.ai/document-requests/{id}/resend \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"recipient_email": "jsmith@example.com",
"email_message": "<string>",
"copy": false
}
'import requests
url = "https://api.uk.veridox.ai/document-requests/{id}/resend"
payload = {
"recipient_email": "jsmith@example.com",
"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({recipient_email: 'jsmith@example.com', email_message: '<string>', copy: false})
};
fetch('https://api.uk.veridox.ai/document-requests/{id}/resend', 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/{id}/resend",
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([
'recipient_email' => 'jsmith@example.com',
'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/{id}/resend"
payload := strings.NewReader("{\n \"recipient_email\": \"jsmith@example.com\",\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/{id}/resend")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"recipient_email\": \"jsmith@example.com\",\n \"email_message\": \"<string>\",\n \"copy\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.uk.veridox.ai/document-requests/{id}/resend")
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 \"recipient_email\": \"jsmith@example.com\",\n \"email_message\": \"<string>\",\n \"copy\": false\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"recipient_email": "jsmith@example.com",
"sent_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"
}
}{
"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"
}
}Resend an email invitation for an existing document request. This is useful if the recipient missed the original email or if you want to provide an updated custom message.
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.Permission
Requiresorganisation_cases:write, which every role holds by default. A caller without it receives 403. To resend a document request you did not create, you also need organisation_cases:read, or your organisation must have shared cases enabled; otherwise the API returns 404. See Permissions and API Keys.
Features
- Update Recipient: You can specify a different recipient email address when resending, allowing you to redirect the request if needed.
- Updated Message: Provide a new custom email message to provide additional context to the recipient.
Best Practices
- Check Expiration: Ensure the request has not already expired before attempting to resend.
- Customise the Message: Include a reason for resending (e.g., “Following up on our call…”) to encourage the recipient to complete the upload.
- Validate Email: Double-check the recipient’s email address if they reported not receiving the previous invitation.
Authorizations
Path Parameters
Document request ID
Body
application/json
Response
Document request email resent successfully
Pattern:
^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$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))$Was this page helpful?
⌘I