Search
K
Policy

IriIssueType

string

Underwriting/issue type.

Allowed values:FULLUNDERWRITINGSIMPLIFIEDGUARANTEED

IriPolicySummary

object
effectiveDatestring(date)required

Policy effective date (yyyy-mm-dd).

Example:2021-01-15

cusipstring

CUSIP identifier for the product.

Match pattern:^[0-9]{3}[A-Z0-9]{5}[0-9]$

>= 9 characters<= 9 characters

Example:78462F103

carrierIdstringrequired

Carrier identifier.

<= 10 characters

Example:CARR123

carrierNamestring

Carrier display name.

<= 200 characters

Example:Contoso Life & Annuity

policyLastRefreshDateTimestring(date-time)required

Timestamp the policy data was last refreshed.

Example:2026-03-06T16:30:00Z

productobjectrequired
Show Child Parameters
qualificationTypestring

Tax qualification type.

Allowed values:Non-QualifiedSolo 401k401k403b457 Deferred CompensationInherited IRAIRA SpousalEducational IRAIRAIRA RolloverIRA TransferRoth IRARoth IRA - InheritedSEP IRASIMPLE IRAPension PlanCash Balance Plan-Defined ContributionsSolo Defined BenefitCash Balance Plan-Defined BenefitProfit Sharing PlanMoney Purchase PlanSAREP401gHR10Welfare Benefit PlanRoth 401KRoth 403bRoth 457

policyStatusstringrequired

Policy status.

Allowed values:PENDINGISSUEDACTIVELAPSEDSURRENDEREDTERMINATED

hasRestrictionboolean

Whether the policy has one or more active restrictions.

Example:true

restrictionsarray[object]

Active restrictions. Required when hasRestriction is true.

Show Child Parameters
issueTypestringrequired

Underwriting/issue type.

Allowed values:FULLUNDERWRITINGSIMPLIFIEDGUARANTEED

issueStatestring

Two-letter issue state code.

Match pattern:^[A-Z]{2}$

Example:NC

currencystringrequired

ISO 4217 three-letter currency code.

Match pattern:^[A-Z]{3}$

Example:USD

Example

IriValidationError

object
codestringrequired

Structured error code classifying the business rule or decision failure.

Match pattern:^[a-zA-Z]+\.[a-zA-Z]+\.[a-zA-Z]+$

Example:policy.inquiry.notFound

messagestringrequired

Why the error occurred / specific business rule violation.

Example

IriError

object
codestringrequired

A structured error code ...

Match pattern:^[a-zA-Z]+\.[a-zA-Z]+\.[a-zA-Z]+$

Example:policy.inquiry.notFound

timestampstring(date-time)

Timestamp the error occurred.

messagestringrequired

Message with specific error details.

validationErrorsarray[object]

Logical rule violations related to business logic or rules.

Show Child Parameters
Example

IriAccountDesignation

string

Account designation / role type.

Allowed values:INDIVIDUALJOINTTRUSTCUSTODIALOTHER