Skip to navigation

Read Document Download Url

Available by Request

Issue a short-lived signed URL for a household document. expiresInSeconds defaults to 300 (5 minutes); values are clamped to 60–900, so a larger request is capped at 900 and a smaller one raised to 60 — never rejected. Every issued URL is access-logged; if logging fails the request fails. Fetch the URL directly with a plain GET and no auth header; tolerate Content-Encoding: gzip. The URL sets Content-Disposition: attachment with the document’s file name and the contentType returned here. Only PDFs and images are served; any other type is a 415.

This endpoint is part of the document-review agent surface. To explore availability for your integration, please contact our team.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

documentIdstringRequiredformat: "uuid"
The id of the document

Query parameters

requirementIdstringOptionalformat: "uuid"

The requirement slot the document is being fetched for; written to the access log

expiresInSecondsintegerOptionalDefaults to 300

Link lifetime in seconds. Clamped to 60–900 by the server; out-of-range values are coerced, not rejected

Response

Expected response to a valid request
urlstringformat: "uri"

Fetch directly with a plain GET, no auth header. Tolerate Content-Encoding gzip.

expiresAtdatetime
documentIdstringformat: "uuid"
fileNamestring
contentTypestring

Derived from the file name, or from stored metadata: application/pdf, image/jpeg, image/png or image/gif. Any other type is refused with 415, so no link is issued.

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
415
Unsupported Media Type Error
502
Bad Gateway Error