Dynamic Document API
The following endpoints are for use in rendering dynamic documents.
The following endpoints are for use in rendering dynamic documents.
The following endpoints are for use in rendering dynamic documents.
The following endpoints are for use in rendering dynamic documents.
Endpoint Index
Action | Endpoint |
---|---|
Render a document for an existing policy, given a liquid template | POST /document/renderPolicyDocument |
Render a document for an existing policy, given a liquid template filename | POST /document/renderPolicyDocumentFromConfig |
Details
POST /document/renderPolicyDocument
Name | Position | Type | Required |
---|---|---|---|
PolicyDocumentRenderRequest | body | PolicyDocumentRenderRequest | required |
DocumentRenderResponse
requiredpolicyDisplayId stringtemplate string
Renders a document for a policy, given the
policyDisplayId
and thetemplate
(liquid template content (not filename), passed in as a string) in the PolicyDocumentRenderRequest request body).Returns urls for the rendered document in pdf and html format.
Does not attach the document to the policy.
POST /document/renderPolicyDocumentFromConfig
Name | Position | Type | Required |
---|---|---|---|
PolicyDocumentRenderRequest2 | body | PolicyDocumentRenderRequestWithTemplate | required |
DocumentRenderResponse
requiredconfigProductTemplate stringpolicyDisplayId string
Renders a document for a policy, given the
configProductTemplate
liquid template filename from the configuration and the thepolicyDisplayId
, as specified in the PolicyDocumentRenderRequestWithTemplate request body.Returns urls for the rendered document in pdf and html format.
Does not attach the document to the policy.
requiredassignedVariables map<string,object>optionalrenderedHtmlUrl stringrenderedPdfUrl string
Note
This API is for use in rendering dynamic documents. For configuring static documents, see the Static Documents API topic for for information about the static documents configuration API.