Policy Transactions
PolicyCoverageChangesPartyIdentifier
objecttypestring
Type of government or legal identification document
Allowed values:PASSPORTSSNDRIVERSLICENSENATIONALID
Example:PASSPORT
valuestring
Value/number of the identifier
Example:123456789
descriptionstring
Free-text description of the identifier
Example:Passport number
sourcestring
Issuing authority or source
Example:State of California
issueDatestring(date)
Date issued
Example:2015-08-15
expirationDatestring(date)
Date of expiration
Example:2025-08-15
statusstring
Current status of the identifier
Allowed values:ACTIVEEXPIREDINACTIVE
Example:ACTIVE
countryOfIssuestring
Country that issued the identifier (ISO-3166 alpha-2)
Example:US
Example
PolicyCoverageChangesPhoneNumber
objectidstring
Unique identifier of this phone record
Example:2ad51ecf-9923-437f-a6f0-70968e464cdb
typestring
Classification of the phone number
Allowed values:MOBILEHOMEWORK
Example:MOBILE
countryCodestring
Country calling code
Example:1
areaCodestring
Area code
Example:973
dialNumberstringrequired
Local dial number; mandatory if phone supplied
Example:7657890
extensionstring
Extension number, if applicable; send JSON null when not applicable
bestTimestring
Best time of day to reach the party
timezonestring
Timezone associated with the phone number
Example
PolicyCoverageChangesEmail
objectidstring
Unique identifier of this email record
Example:2ad51ecf-9923-437f-a6f0-70968e464cdb
typestring
Classification of the email address
Allowed values:PERSONALBUSINESS
Example:PERSONAL
addressstring(email)required
The email address; mandatory if email supplied
Example:user@example.com
Example
PolicyCoverageChangesSignature
objectdatestring(date)
Date the signature was captured
Example:2021-01-12
citystring
City where the signature was captured
Example:Quincy
statestring
State where the signature was captured
Example:CA
Example
PolicyCoverageChangesUnderwriting
objectUnderwriting decision evaluated for this policy update, present when an underwriting case was evaluated
underwritingCaseIdstringrequired
Identifier of the underwriting case evaluated for this policy update
Example:CA1234567890
decisionstringrequired
Underwriting decision rendered for the requested change
Allowed values:APPROVEDDECLINEDPOSTPONED
Example:APPROVED
statusstringrequired
Case-level underwriting status classification
Allowed values:CLEAN_CASEFLAGGED_CASE
Example:CLEAN_CASE
underwritingSourceNamestring
Name of the underwriting engine/source
Example:Source Details
underwritingRiskClassstring
Risk classification assessed by underwriting
Allowed values:ULTRANONTOBACCOELITENONTOBACCOPREFERREDNONTOBACCOSTANDARDNONTOBACCOSTANDARDTOBACCOSTANDARDAGGREGATESUBSTANDARDNONTOBACCOSUBSTANDARDTOBACCOSTANDARDPLUSNONTOBACCOPREFERREDTOBACCOSTANDARDCONVERSIONNONTOBACCOSTANDARDCONVERSIONTOBACCO
Example:ULTRANONTOBACCO
decisionRiskClassstring
Risk classification assessed by underwriting
Allowed values:ULTRANONTOBACCOELITENONTOBACCOPREFERREDNONTOBACCOSTANDARDNONTOBACCOSTANDARDTOBACCOSTANDARDAGGREGATESUBSTANDARDNONTOBACCOSUBSTANDARDTOBACCOSTANDARDPLUSNONTOBACCOPREFERREDTOBACCOSTANDARDCONVERSIONNONTOBACCOSTANDARDCONVERSIONTOBACCO
Example:ULTRANONTOBACCO
underwritingMethodstring
Underwriting method applied
Allowed values:FULLUNDERWRITINGSIMPLIFIEDISSUEGUARANTEEDISSUEACCELERATEDUNDERWRITING
Example:FULLUNDERWRITING
tobaccoPremiumBasisstring
Tobacco/nicotine rating basis
Allowed values:SMOKERNONSMOKER
Example:SMOKER
approvedFaceAmountnumber(double)
Face amount approved by underwriting; required when a policyUpdateRequest item affects face amount (BASECOVERAGEUPDATE, RIDERADD)
Example:250000
approvedFaceAmountMaximumnumber(double)
Maximum face amount underwriting will allow; required when a policyUpdateRequest item affects face amount (BASECOVERAGEUPDATE, RIDERADD)
Example:250000
ridersarray[object]
Show Child Parameters
exclusionReviewarray[object]
Show Child Parameters
Example