Policy Retrieval

Retrieve policies by client or policy ID. The client endpoint returns policy records; the policy ID endpoints return a full-policy object that groups the policy, quote, answers, and related data.

Get Policies by Client#

Returns policies associated with a client, scoped to the requesting organization.

GET https://api.{ENV}.dais.com/ioi/v3/policy/client/{clientId}

Parameter	Type	Required	Description
`clientId`	UUID	Yes	Client identifier.

curl --location --request GET 'https://api.{ENV}.dais.com/ioi/v3/policy/client/<UUID of the client ID>' \
--header 'Authorization: Basic <Base64-encoded API key and secret>'

The response is an array of Policy Objects. This example shows selected fields:

[
  {
    "id": "<UUID of the policy ID>",
    "policyNumber": "<Policy number>",
    "productId": "<UUID of the product ID>",
    "clientId": "<UUID of the client ID>",
    "status": "PAID",
    "policyState": "ACTIVE",
    "effectiveDate": "2026-01-01",
    "expirationDate": "2027-01-01",
    "premium": 5250.0
  }
]

Get Full Policy by ID#

GET https://api.{ENV}.dais.com/ioi/v3/policy/{policyId}

Parameter	Type	Required	Description
`policyId`	UUID	Yes	Policy identifier.

curl --location --request GET 'https://api.{ENV}.dais.com/ioi/v3/policy/<UUID of the policy ID>' \
--header 'Authorization: Basic <Base64-encoded API key and secret>'

Returns a Full Policy Object. Policy fields are nested under policy; for example, read policy.policyNumber and policy.premium.

Get Policy with Selective Fields#

Choose which groups of related data to include using boolean flags.

POST https://api.{ENV}.dais.com/ioi/v3/policy/{policyId}

curl --location --request POST 'https://api.{ENV}.dais.com/ioi/v3/policy/<UUID of the policy ID>' \
--header 'Authorization: Basic <Base64-encoded API key and secret>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "includePolicy": true,
  "includeAnswers": true,
  "intakeFormat": "KEY_VALUE"
}'

Request Fields#

All fields are optional. An empty object uses the defaults below.

Property	Type	Default	Description
`includePolicy`	boolean	`false`	Include the policy record.
`includeQuote`	boolean	`false`	Include the associated quote.
`includeAnswers`	boolean	`false`	Include intake answers.
`intakeFormat`	string	`DAIS`	Answer format: `DAIS`, `PRODUCT_TREE`, or `KEY_VALUE`.
`includeFinanceState`	boolean	`false`	Include financial status.
`includePolicyEvents`	boolean	`false`	Include policy events.
`includeClientIndustryInfo`	boolean	`false`	Include client industry information.
`includeAgencyInfo`	boolean	`false`	Include agency address information.
`includeStatements`	boolean	`false`	Include statements.
`includeLastStatements`	boolean	`false`	Include the last statement.
`includeClientSummary`	boolean	`false`	Include the client summary.
`includeCommentsStats`	boolean	`true`	Request comment statistics where supported by the policy service.

Returns a Full Policy Object populated with the requested sections. Unrequested sections may be null or empty. Selection operates on these sections; individual property names cannot be requested through a fields array.

Full Policy Object#

Field	Type	Description
`policy`	object	Policy Object.
`quote`	object	Associated quote.
`clientIndustryInfo`	object	Map of client industry information.
`agencyAddressInfo`	object	Map of agency address information.
`intakeAnswers`	object	Intake answers in the requested format.
`events`	array	Policy events.
`lastStatement`	object	Last statement.
`collectsSecurityDeposit`	boolean	Whether the policy collects a security deposit.
`financeState`	object	Policy financial status.
`statements`	array	Policy statements.
`clientSummary`	object	Client summary.

For example, an abridged response containing policy data is:

{
  "policy": {
    "id": "<UUID of the policy ID>",
    "policyNumber": "<Policy number>",
    "productId": "<UUID of the product ID>",
    "clientId": "<UUID of the client ID>",
    "effectiveDate": "2026-01-01",
    "expirationDate": "2027-01-01",
    "premium": 5250.0,
    "status": "PAID",
    "policyState": "ACTIVE"
  },
  "collectsSecurityDeposit": false
}

Policy Object#

The following are commonly used fields on a policy record. The same object is returned in the client-policy array and under policy in a full-policy response.

Field	Type	Description
`id`	UUID	Policy identifier.
`policyNumber`	string	Human-readable policy number.
`productId`	UUID	Product identifier.
`productName`	string	Product name.
`clientId`	UUID	Client identifier.
`quoteId`	UUID	Associated quote identifier.
`actionId`	UUID	Associated action identifier.
`issuingOrganizationId`	UUID	Issuing organization.
`issuingOrganizationName`	string	Issuing organization name.
`sellerOrganizationId`	UUID	Selling organization.
`sellerOrganizationName`	string	Selling organization name.
`underwritingOrgId`	UUID	Underwriting organization.
`producerId`	UUID	Producer identifier.
`status`	string	Statement payment status: `NOT_PAID`, `PAID`, `OVERPAID`, or `UNDERPAID`.
`policyState`	string	Policy state: `PENDING_FINANCE_CONFIRMATION`, `ACTIVE`, `INACTIVE_UNSETTLED`, `SETTLED`, or `CLOSED`.
`effectiveDate`	string (date)	Coverage start, `YYYY-MM-DD`.
`expirationDate`	string (date)	Coverage expiration, `YYYY-MM-DD`.
`lastDayWithCoverage`	string (date)	Last covered day, `YYYY-MM-DD`.
`premium`	number	Premium amount.
`premiumTerm`	string	Premium term.
`paymentPlan`	string	Payment plan.
`policyMeta`	object	Insured, agency, producer, and carrier details.
`policyContract`	object	Policy document details.
`clientIntegrationData`	object	Client integration data.
`quoteIntegrationData`	object	Quote integration data.
`policyIntegrationData`	object	Policy integration data.
`createdTimestamp`	string (date-time)	Creation timestamp.

Policy search returns a smaller summary object. See Policy Search for that response shape.