Client - Document Requests

Manage document requests for clients. Create requests asking clients to provide specific documents, track submissions and review responses. Supports the full lifecycle: Draft → Open → Submitted → Accepted/Rejected/Cancelled. Documents can be uploaded by staff or portal clients, and submissions include comments and review workflows.

OpenAPI Spec

Guides Operations Schemas

GET List Document Requests for Client
Lists all Document Requests for the specified client. Requires: ViewAll on DocumentRequests.
/tenants/{tenant}/clients/{client}/documentrequest
POST Create Document Request
Creates a new document request in Draft status for the specified client. Requires: Create on DocumentRequests.
/tenants/{tenant}/clients/{client}/documentrequest
GET Get Document Request for Client
Gets a Document Request for the specified client. Requires: ViewAll on DocumentRequests.
/tenants/{tenant}/clients/{client}/documentrequest/{code}
PUT Update Document Request for Client
Updates the specified Document Request for the specified client. Requires: Update on DocumentRequests.
/tenants/{tenant}/clients/{client}/documentrequest/{code}
DELETE Delete Document Request for Client
Deletes a Document Request for the specified client. Requires: Delete on DocumentRequests.
/tenants/{tenant}/clients/{client}/documentrequest/{code}
GET Get Document Request Detail
Gets a document request with its associated documents and submission responses. Requires: ViewAll on DocumentRequests.
/tenants/{tenant}/clients/{client}/documentrequest/{code}/detail
PUT Open Document Request
Transitions a document request from Draft to Open, making it visible to the client. When scheduledAt is set, the request stays Draft: a scheduled send...
/tenants/{tenant}/clients/{client}/documentrequest/{code}/open
PUT Resend Document Request
Emails an open document request to the given addresses again, each with a fresh link. Everyone the request already went to keeps their link and keeps ...
/tenants/{tenant}/clients/{client}/documentrequest/{code}/resend
PUT Cancel Document Request
Cancels a Draft or Open document request. It stops being chased, leaves the client's outstanding requests, its links stop working and any scheduled se...
/tenants/{tenant}/clients/{client}/documentrequest/{code}/cancel
GET Get Document Request Recipients
Returns the email addresses a document request currently counts as its recipients: everyone it was sent to and has not since been withdrawn from. Thes...
/tenants/{tenant}/clients/{client}/documentrequest/{code}/recipients
POST Upload Documents to Request
Uploads one or more documents and attaches them to the specified document request. Each file is uploaded independently — the response reports success ...
/tenants/{tenant}/clients/{client}/documentrequest/{code}/documents
DELETE Remove Document from Request
Removes a document from the specified document request. Requires: Update on DocumentRequests.
/tenants/{tenant}/clients/{client}/documentrequest/{code}/documents/{documentCode}
POST Submit Document Request
Submits a response to a document request. Comments are required if no documents are attached. Requires: Update on DocumentRequests.
/tenants/{tenant}/clients/{client}/documentrequest/{code}/submit
PUT Review Document Request Response
Accepts or rejects a submitted response. On rejection, specify the next action: reopen or reopen and clear documents. Requires: Update on DocumentReq...
/tenants/{tenant}/clients/{client}/documentrequest/{code}/responses/{responseCode}/review