Downloads & Documents
Endpoints for downloading quote worksheets, retrieving rating data, downloading files from storage, and generating PDF documents.
Download Excel Worksheet#
Downloads the Excel rating worksheet for a given quote as a binary file (application/octet-stream).
Endpoint#
GET https://api.{ENV}.dais.com/ioi/v3/download/excel/worksheet/{quoteId}
Path Parameters#
| Parameter | Type | Required | Description |
|---|---|---|---|
quoteId | UUID | Yes | UUID of the quote whose worksheet you want to download. |
curl --location --request GET 'https://api.{ENV}.dais.com/ioi/v3/download/excel/worksheet/<UUID of the quote request ID>' \
--header 'Authorization: Basic <Base64-encoded API key and secret>' \
--output worksheet.xlsx
Response#
Returns the Excel file as a binary stream (application/octet-stream). Save the response body directly to a .xlsx file.
Get Advanced Rating Worksheet#
Returns the advanced (algorithm-based) rating worksheet data for a given quote as a JSON object. Used to inspect the detailed rating inputs and calculated outputs from an algorithmic rating engine.
Endpoint#
GET https://api.{ENV}.dais.com/ioi/v3/download/advanced/worksheet/{quoteId}
Path Parameters#
| Parameter | Type | Required | Description |
|---|---|---|---|
quoteId | UUID | Yes | UUID of the quote whose advanced worksheet to retrieve. |
curl --location --request GET 'https://api.{ENV}.dais.com/ioi/v3/download/advanced/worksheet/<UUID of the quote request ID>' \
--header 'Authorization: Basic <Base64-encoded API key and secret>'
Response#
Returns a JSON object whose keys and nested values depend on the configured rating algorithm. The public API forwards the worksheet data without converting it to a fixed response schema. Use a worksheet from the relevant product when implementing a consumer.
Download Advanced Rating Worksheet PDF#
Downloads the advanced rating worksheet as a PDF for a quote rated through the advanced algorithm worksheet flow.
Endpoint#
GET https://api.{ENV}.dais.com/ioi/v3/download/advanced/worksheet/{quoteId}/pdf
| Parameter | Location | Type | Required | Description |
|---|---|---|---|---|
quoteId | path | UUID | Yes | Quote whose worksheet to download. |
verbose | query | boolean | No | Defaults to false for the coverage worksheet with rating values. Set to true for the full algorithm worksheet. |
curl --location --request GET 'https://api.{ENV}.dais.com/ioi/v3/download/advanced/worksheet/<UUID of the quote request ID>/pdf?verbose=false' \
--header 'Authorization: Basic <Base64-encoded API key and secret>' \
--output advanced-rating-worksheet.pdf
Response#
Returns 200 OK with a binary PDF body (application/pdf). Save the body directly to a file. See also the quote worksheet guide.
Download a File#
Downloads a stored file using a file URL returned by Dais.
Endpoint#
GET https://api.{ENV}.dais.com/ioi/v3/download/file
| Parameter | Location | Type | Required | Description |
|---|---|---|---|---|
path | query | string | Yes | Full file URL returned by Dais. URL-encode it when adding it to the query string. |
curl --location --get 'https://api.{ENV}.dais.com/ioi/v3/download/file' \
--header 'Authorization: Basic <Base64-encoded API key and secret>' \
--data-urlencode 'path=<File URL returned by Dais>' \
--output document.pdf
Response#
Returns 200 OK with a binary file body. The endpoint declares application/pdf and supplies a Content-Disposition attachment filename derived from the file URL. Use a file URL from the same Dais environment.
Generate a PDF Document#
Generates a PDF using a configured form and the specified client, with optional policy and quote context.
Endpoint#
POST https://api.{ENV}.dais.com/ioi/v3/generate/document
Headers#
| Header | Value | Required |
|---|---|---|
Content-Type | application/json | Yes |
Authorization | Bearer <Access token> or Basic <Base64-encoded API key and secret> | Yes |
x-jwt-assertion | <ID token> | With token authentication |
See Authentication for the headers to use with each authentication method.
Request Body#
curl --location --request POST 'https://api.{ENV}.dais.com/ioi/v3/generate/document' \
--header 'Authorization: Basic <Base64-encoded API key and secret>' \
--header 'Content-Type: application/json' \
--data-raw '{
"productId": "<UUID of the product ID>",
"formConfigId": "<UUID of the form configuration ID>",
"clientId": "<UUID of the client ID>",
"fileName": "<Document filename>"
}' \
--output policy-document.pdf
Replace the example UUIDs with identifiers from your environment.
| Property | Type | Required | Description |
|---|---|---|---|
productId | UUID | Yes | Product containing the form configuration. |
formConfigId | UUID | Yes | Form configuration to evaluate. |
clientId | UUID | Yes | Client whose data is used for the document. |
policyId | UUID | No | Policy context for generation. |
quoteId | UUID | No | Quote context for generation. |
fileName | string | No | Attachment filename. If omitted, the generated form's filename is used. |
productDate | string | No | Product configuration timestamp as an ISO 8601 date-time with offset, such as 2026-01-27T10:30:00Z. |
Response#
Returns 200 OK with a binary PDF body (application/pdf) and a Content-Disposition attachment filename. Save the response body directly to a file.