Documents

Download the normalized PDF

Streams the normalized PDF: the converted document the editor lays fields on and the signing pipeline renders. This is how a client verifies what it is about to send before spending anything.

This response is not JSON. The body is the PDF itself, with Content-Type: application/pdf, Content-Disposition derived from the original filename, Cache-Control: private, no-store, and Accept-Ranges: bytes. There is no presigned storage URL to hand out: the bytes move only while the credential is live and still bound to this workspace, so revoking a credential takes effect on the next read.

Range is supported for a single byte range, which lets a large document be fetched in slices; a multipart or malformed Range answers 416. Every read that actually released bytes is written to the audit trail.

The document must be ready and must have a normalized PDF. processing, failed, and the (unexpected) ready-without-a-PDF state each answer 409 under their own error code, because "wait" and "this conversion failed" call for different behavior.

get/documents/{documentId}/file

Request

  • Base URL: https://inkseal.net/api/v1
  • URL: https://inkseal.net/api/v1/documents/{documentId}/file
  • Auth: HTTP bearer

Query parameters

disposition'inline' | 'attachment'

attachment by default: a client asking for the file usually wants the file. Pass inline to have it rendered in place.

Response

The whole normalized PDF.

Changes

No recorded changes to this operation across all 1 revision of this API.