Skip to content

Product Configs

Retrieve configuration records for a product. Records are grouped by configuration type under the response's config property.

Retrieve Configurations#

HTTPPOST
POST https://api.{ENV}.dais.com/ioi/v3/product/config/all
cURL
curl --location --request POST 'https://api.{ENV}.dais.com/ioi/v3/product/config/all' \
--header 'Authorization: Basic <Base64-encoded API key and secret>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "productId": "<UUID of the product ID>"
}'
PropertyTypeRequiredDescription
productIdUUIDYesProduct whose configurations are requested.
organizationIdUUIDNoOrganization selector, subject to service access checks.
requestSourcestringNoContext for the configuration request.

requestSource values are PRE_POLICY_QUOTING, PRE_ISSUANCE, ISSUANCE, ENDORSEMENT, CANCELLATION, RENEWAL, WORKFLOW, PACKAGE_RATER, TRUE_UP, and TRUE_UP_SUMMARY.

Response Structure#

The response contains organizationId and a config object. Each key inside config is a configuration type, and its value is an array of records.

JSON
{
  "organizationId": "<UUID of the organization ID>",
  "config": {
    "POLICY_FORM": [
      {
        "id": "<UUID of the form configuration ID>",
        "configIdentity": "POLICY_FORM",
        "organizationId": "<UUID of the organization ID>",
        "productId": "<UUID of the product ID>",
        "spec": {
          "name": "<Name>",
          "formType": "POLICY",
          "productId": "<UUID of the product ID>",
          "documentMappings": {},
          "compositeType": false
        },
        "updatedTimestamp": "2026-01-27T10:30:00Z",
        "revision": 0,
        "lastUpdatedBy": null
      }
    ]
  }
}

Configuration Record Fields#

PropertyTypeDescription
idUUIDConfiguration identifier, used as configId by operations that request it.
configIdentitystringConfiguration type.
organizationIdUUIDOrganization owning the record.
productIdUUIDProduct owning the record.
specobjectType-specific configuration data.
updatedTimestampISO 8601 timestampLast update time.
revisionintegerConfiguration revision. The field is named revision, not version.
lastUpdatedByobjectUser details for the last update, when supplied.
forkTrackerobjectFork tracking information, when supplied.

The sections below describe selected configuration types. Other configured types can also be returned. The spec property is a map; fields depend on the configuration type and stored product configuration.

POLICY_FORM#

Form configurations are in config.POLICY_FORM. This is an example spec object:

JSON
{
  "name": "<Name>",
  "formType": "POLICY",
  "productId": "<UUID of the product ID>",
  "documentMappings": {},
  "compositeType": false
}
PropertyDescription
nameForm name.
formTypeForm purpose, such as POLICY, QUOTE, ENDORSEMENT, or CANCELLATION.
productIdAssociated form product identifier.
documentMappingsDocument mapping definitions keyed by product UUID.
compositeTypeWhether this is a composite form.
compositeFormComponentsComponent form definitions for a composite form, when configured.

ENDORSEMENTS#

Endorsement configurations are in config.ENDORSEMENTS. Example spec:

JSON
{
  "title": "<Title>",
  "description": "<Description>",
  "endorsementProductId": "<UUID of the endorsement product ID>",
  "nonRatingEndorsement": false,
  "enableEndorsementRules": false,
  "allowEndorsementsInThePast": false,
  "generateAndIncludePolicyDeck": true,
  "exposeToClient": false
}
PropertyDescription
title, descriptionEndorsement name and description.
endorsementConfigIdOptional associated form configuration UUID.
endorsementProductIdExposure product UUID.
nonRatingEndorsementWhether the endorsement avoids rating recalculation.
enableEndorsementRulesWhether endorsement eligibility rules are enabled.
allowEndorsementsInThePastWhether backdating is enabled.
generateAndIncludePolicyDeckWhether to generate and include the policy document.
exposeToClient, clientFacingDescriptionClient-facing availability and description.
calculationConfigPremium calculation configuration, when supplied.

CANCELLATIONS#

Cancellation reason configurations are in config.CANCELLATIONS. Example spec:

JSON
{
  "title": "<Title>",
  "description": "<Description>",
  "cancellationConfigId": "<UUID of the cancellation configuration ID>",
  "cancellationProductId": "<UUID of the cancellation product ID>",
  "enableCancellationRules": false,
  "enableCancellationProduct": true,
  "cancellationType": "PRO_RATA"
}
PropertyDescription
title, descriptionCancellation reason name and description.
cancellationConfigIdAssociated form configuration UUID.
cancellationProductIdAssociated cancellation product UUID.
enableCancellationRulesWhether cancellation rules are enabled.
enableCancellationProductWhether the associated cancellation product is enabled.
cancellationTypeCancellation calculation type, for example PRO_RATA.
shortRateSpecShort-rate configuration, when supplied.
exposeToClient, clientFacingDescriptionClient-facing availability and description.