Skip to main content
GET
/
document-requests
List document requests
curl --request GET \
  --url https://api.uk.veridox.ai/document-requests \
  --header 'x-api-key: <api-key>'
{
  "links": [
    {
      "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"
    }
  ],
  "total": 0,
  "limit": 0,
  "offset": 0
}
Retrieve a paginated list of all document requests created by your organisation. This endpoint supports filtering by status, searching by ID, and sorting options.
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

  • Filtering: Filter by request status (pending, completed, expired) or specific request ID.
  • Sorting: Order results by creation date to find newest requests first.
  • Pagination: Use limit and offset to manage large result sets.

​
Best Practices

  1. Monitor Status: Regularly list pending requests to track completion rates and identify customers who may need a follow-up.
  2. Expiration Tracking: Identify requests approaching their expires_at date to ensure document collection is completed in time.
  3. Efficiency: Use a limit of 100 for background reporting and 20-50 for user-facing dashboards.

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
id
string<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})$
​
status
enum<string>
Available options:
pending,
completed,
expired
​
limit
string
default:20
​
offset
string
default:0
​
sort_order
enum<string>
default:desc
Available options:
asc,
desc

Response

List of document requests retrieved successfully

​
links
object[]
required
​
total
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
​
limit
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
​
offset
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991