Skip to main content
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
}
'
{
  "success": true,
  "recipient_email": "jsmith@example.com",
  "sent_at": "2023-11-07T05:31:56Z"
}
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. If you receive a 403 with request.organisations.module.not-enabled, contact your organisation admin to have it activated. Learn more.

​
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

  1. Check Expiration: Ensure the request has not already expired before attempting to resend.
  2. Customise the Message: Include a reason for resending (e.g., “Following up on our call…”) to encourage the recipient to complete the upload.
  3. Validate Email: Double-check the recipient’s email address if they reported not receiving the previous invitation.

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
id
string
required

Document request ID

Body

application/json
​
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,}$
​
email_message
string
Required string length: 1 - 1000
​
copy
boolean
default:false

Response

Document request email resent successfully

​
success
boolean
required
​
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,}$
​
sent_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))$