v1

latestOpenAPI 3.0.12026-07-242682197.7 KB
Document

Completed PDF

Gets a completed document PDF or ZIP file. Supply the unique document ID from either a document creation request or document page URL.

get/api/v1/documents/{id}/completed_pdf

Path parameters

idstring uuid required

Unique identifier for a completed document.

Query parameters

url_onlyboolean

Whether to return the URL of the completed PDF or the actual PDF content. Defaults to false.

audit_pageboolean

Whether to include the audit page as part of the document. Defaults to true

file_format'pdf' | 'zip'

Format of the file to be downloaded. Supported formats are 'pdf' and 'zip'.

Response

successful, returns the final completed PDF, or if url_only is set to true, a JSON object is returned. When url_only=false (default), the response is the raw PDF or ZIP binary data.

OR
string binary required

Raw PDF binary data (default response when url_only=false)

OR
string binary required

ZIP file containing the completed PDF (returned when file_format=zip)