Search
K
Illustration

Illustration Generation

3.2.17OAS 3.0

Create and manage illustration requests

API Base URL
  • Server 1:https://dev.api.zinnia.io

    Development

Security
Auth0 (openIdConnect)

Illustration Engine

API Endpoints for use by the internal illustration engines

Create an illustration

Start an asynchronous illustration calculation

post
https://dev.api.zinnia.io/illustration/v3/illustration-request

Query Parameters

formatsarray[string]required

identifier for an output format

Allowed values:RAW_ILLUSTRATION_VALUESFORMATTED_ILLUSTRATION_PDF

Body

application/json

contains all the input data needed for processing the request

Core Calculation - Single Illustration

Describes the payload required for calculation of a single transaction

$schemastring
illustrationTypestringrequired

Allowed values:NEW_BUSINESSINFORCE

calculationTypestringrequired

Type of calculation

Allowed values:QUICK_QUOTESINGLE_ILLUSTRATIONAGGREGATE_ILLUSTRATIONCOMPOSITE_ILLUSTRATIONPOLICY_PAGE_PROJECTION

Example:QUICK_QUOTE

policyDetail

Represents the state of a policy at an instant in time. Describes the payload Zahara transmits when requesting calculations for a single transaction.

Show Child Parameters
projection
Show Child Parameters

Response

application/json

The request was created, the identifier for the request is returned.

object
post/illustration/v3/illustration-request

Body

{ "illustrationType": "NEW_BUSINESS", "calculationType": "QUICK_QUOTE" }
 
application/json