Search
K
Policy

Metadata

object
isTobaccoUseboolean

Indicates the tobacco usage status, used to differentiate mappings for risk classes that depend on smoking status. (i.e if smoker or non-smoker)

Example

TranslationBase

object
systemOfRecordValuestring

The value from the Source of Record (e.g., Zahara) that needs to be translated to the corresponding carrier value

carrierValuestring

The equivalent value used by the carrier system that corresponds to the given sorValue

metadataobject
Show Child Parameters
Example

TranslationCategory

object
categoryNamestring

The group or classification of values for which translation is being requested

Allowed values:RISKCLASSTABLERATINGCOVERAGEBANDPAYMENTMETHOD

translationsarray[object]
Show Child Parameters
Example

Translations

object
carrierIdstring

The Carrier ID is a unique identifier assigned to an insurance company (carrier) that issues and underwrites a policy. It helps track, manage, and differentiate insurance providers within industry databases, regulatory systems, and digital platforms

planCodestring

The Plan Code is a carrier-assigned unique identifier used to distinguish a specific product, rate structure, and version of a life insurance or annuity policy. It ensures accurate policy tracking, pricing, and administration

categoriesarray[object]
Show Child Parameters
Example

ThirdPartyAdministrator

object
timestampstring(date-time)

TBD

Example:2023-01-01T12:00:00.000Z

partyIdstring

Party ID is a unique identifier assigned to a party (individual or entity) involved in an insurance or annuity contract. This identifier helps ensure accurate data exchange and tracking across insurance transactions

Example:Zinnia90210

customerIdstring

Assigned by Sales Force and used by all platforms

Example:TBD

partyTypestring

Defines Party type example individual or Organization or Trust. For Insured and Annuitant this should always be Individual

Example:Organization

urlobject
Show Child Parameters
namestring

TBD

Example:Zinnia

doingBusinessAsstring

The name the organization is commonly known as

Example:TBD

abbreviatedNamestring

The shortened/abbreviated version of the organization`s name that is unique to the organization

Example:SBL

organizationCodestring

Code to Identify organization

Example:4874428631

entityTypestring

Allowed values:SOLEPROPRIETORSHIPGENERALPARTNERSHIPLIMITEDPARTNERSHIPCCORPORATIONSCORPORATIONLIMITEDLIABILITYCOMPANYCHARITABLEORGANIZATIONESTATETRUSTCORPORATIONUNKNOWN

preferredCommunicationTypestring

Allowed values:EMAILREGULARMAILPHONEFAXTEXTNOPREFERENCESPECIFIEDPOSTALOTHER

preferredAddressIndicatorstring

Deprecated - kept for backward compatibility; instead use preferredAddressIndicator under Address section

Example:1

formerNameobject
Show Child Parameters
identificationsarray[object]
Show Child Parameters
addressesarray[object]
Show Child Parameters
phonesarray[object]
Show Child Parameters
emailsarray[object]
Show Child Parameters
organizationPurposeSystemOfRecordstring

In the context of a System of Record (SOR) in insurance and annuity systems, Organization Purpose refers to the role the organization plays in relation to the policy or contract. Specifically, terms like Processing and Holding define how the organization interacts with the policy data, assets, or transactions

Example:PROCESSING

generalAccountBusinessUnitstring

General Account Business Unit refers to the organizational or legal entity within an insurance company responsible for managing assets and liabilities held in the general account. This unit is accountable for all financial activities related to non-segregated (non-variable) insurance products where the carrier assumes investment risk

Example:TBD

separateAccountBusinessUnitstring

Separate Account Business Unit refers to the organizational or legal entity within an insurance company responsible for managing products and assets that are legally segregated from the general account. This unit specifically handles variable or investment-linked products, where the policyholder assumes the investment risk, and assets are maintained in separate investment pools

Example:TBD

versioninteger(int32)

TBD

Example