Sign in
documentv2

previewDocument

Internal documentv2/previewDocument operation. Authentication requirements are derived from the active route allowlist.

post/documentv2/previewDocument

Request body

file_htmlstring
file_pdfstring
idinteger
requested_previewstring
include_detailsboolean

Example request

{
  "file_html": "example_file_html",
  "file_pdf": "example_file_pdf",
  "id": 825,
  "requested_preview": "example_requested_preview",
  "include_details": true
}

Response

Standard successful response envelope.

status'success' required
statusCodeinteger required
messagestring required
dataobject required
{"stackTrail":"components:schemas:SuccessEnvelope:properties:error","oasType":"schema","type":"unknown","example":null,"nullable":true}

Example response

{
  "statusCode": 200,
  "message": "OK"
}

Changes

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