Introduction

Introduction

The Illustrata API is a middleware service for generating insurance illustrations. You send input data, and the API returns calculated outputs — as JSON, a PDF document, or both.

How It Works

1. Your application sends a POST request with the required input fields
2. The API processes the inputs and returns the illustration results
3. You receive JSON outputs, a PDF illustration, or both — depending on your configuration

What You Need

Your administrator will provide you with:

• Base URL — the API server you’ll be calling
• Product slug — the identifier for your specific product (e.g., my-annuity)
• API key — your unique authentication credential

The input fields required for each product are also defined by your administrator and will vary between products.

Endpoints

Method	Endpoint	Description
GET	/health	Check API availability
POST	/api/{productSlug}	Submit inputs and receive illustration results

Response Formats

The API supports three output modes, controlled via the ?format query parameter:

Format	Description
json	Returns calculated outputs as JSON
pdf	Returns the illustration as a downloadable PDF file
both	Returns JSON outputs with a base64-encoded PDF embedded in the response

Your product has a default format configured by your administrator. Use the ?format parameter to override it per request.

Next Steps

• Authentication — How to include your API key
• Quick Start — Make your first API call in minutes
• API Reference — Full endpoint documentation