Search
K
Policy

BankAccount

object
startDatestring(date)

Date the Bank Account of the Party was added to the Policy. Date (with pattern “yyyy-mm-dd”)

Example:2023-01-01

endDatestring(date)

Date the Bank Account of the Party was terminated from the Policy. Date (with pattern “yyyy-mm-dd”)

Example:2023-01-01

nameOnAccountstring

Name of the Party on Bank Account

Example:abcdqwe

accountStatusstring

Allowed values:ACTIVEBANKACCOUNTTERMINATEDBANKACCOUNT

accountTypestring

Allowed values:CHECKINGSAVINGSCREDITCARDDEBITCARDBROKERAGEACCOUNTCERTIFICATEOFDEPOSITWIRE

bankAccountPurposestring

Allowed values:LOANINTERESTBILLINGDISBURSEMENTSLOANPRINCIPALBILLINGPREMIUMBILLINGONETIMEPREMIUMBILLINGPAYOUTONETIMEWIRE

accountNumberstring

The 7+ digit checking or savings account number

Example:34567777745678

routingNumberstring

The 9-digit routing transit number for the bank account/branch

Example:123456789

internationalBankAccountNumberstring

The bank account number for an international bank account (this field does not have check-digit validation)

Example:ibanNumber_66

branchNamestring

The name of the bank (such as Chase Manhattan)

Example:branch_66

branchPhoneNumberstring

Phone Number of the Bank Branch

Example:7766667777

branchAddressobject
Show Child Parameters
bankIdstring

In the context of ACORD standards (the global data standards body for insurance), Bank ID refers to a unique identifier used to specify a financial institution involved in a disbursement, premium collection, or electronic funds transfer (EFT). It is critical for ensuring correct routing of payments or deposits between insurers, policyholders, beneficiaries, and third parties

Example:1

appliesToPartyIdstring

This unique id ties to the Party Role that the bank details correspondes to.

Example:Party_PI_1

Example

Carrier

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:SB

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

The legal name of the Organization

Example:Security Benefit Life Insurance Company

doingBusinessAsstring

The name the organization is commonly known as

Example:Security Benefit Life

abbreviatedNamestring

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

Example:SBL

organizationCodestring

Code to Identify organization

Example:110

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
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

Example:SB

parentCompanyIdstring

Ultimate Parent Company ID refers to the unique identifier assigned to the top-most legal entity or corporate parent in an organizational hierarchy. In insurance and annuity systems, this ID is used to link a subsidiary, affiliate, or operational entity to its controlling parent company, ensuring clarity in ownership, regulatory reporting, and financial consolidation

Example:SBP

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:158

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

setIdstring

Carrier SET ID refers to a unique identifier used within insurance systems to represent a specific insurance carrier`s data set across policy administration, disbursement, and accounting platforms. It groups together all configuration, accounting rules, product definitions, and ledger mappings that apply to a particular carrier or legal entity

Example:SBCOC

bankCompanyIdstring

Bank Company ID is a unique identifier assigned to an insurance company or business entity by its bank for electronic funds transfers (EFT), such as ACH (Automated Clearing House) transactions. It is used primarily to identify the originator of payments in financial networks and helps receiving banks verify the legitimacy of transactions

Example:3480409770

accountsPayableBusinessUnitstring

AP Business Unit (Accounts Payable Business Unit) refers to the distinct organizational or legal entity within an insurance company responsible for processing, approving, and recording outgoing payments, such as claims, policy loans, commissions, refunds, or vendor invoices

Example:Everly/SBL

businessScheduleobject
Show Child Parameters
emailSendingDomainstring

The domain used for sending emails on behalf of the carrier

Example:securitybenefit.com

depositoryAccountobject
Show Child Parameters
depositoryAccountsarray[object]
Show Child Parameters
controlledDisbursementAccountobject
Show Child Parameters
controlledDisbursementAccountsarray[object]
Show Child Parameters
carrierCodestring

TBD

versioninteger(int32)
Example

ErrorResponse

object
timestampstring(date-time)

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

messagestring
Example

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