DOdotfile
Cases

Render a document template for a case

Changed on

Render a case_report document template for a case and get the PDF back in the response. The latest published version of the template is used. No request body is needed. Unlike POST /cases/{id}/generate-report, which queues the full case report and delivers it through the CaseReport.Generated webhook, this endpoint answers synchronously and renders the template configured in your workspace.

Rendering goes through a third party, so this endpoint can also answer CASE_REPORT_RENDER_FAILED: a 400 carrying the reason when the template itself cannot be rendered, or a 502 when the rendering service is unavailable. Retrying only helps the 502.

See also

Learn more about Cases

post/v1/cases/{id}/document-templates/{key}/render

Request

  • Base URL
    https://api.dotfile.com
  • Auth
    API key in header X-DOTFILE-API-KEY

Path parameters

idstring required
Example:bf05e8f6-f909-487b-bb49-d58354c2c45c

Render a report for a case by its Dotfile internal id.

keystring required
Example:kyc_checks_report

Key of the case_report document template to render, as configured in your workspace.

Response

The rendered report

ℹ️ Click to see full payload

Changes