Search
K
Policy Transactions

AuthorizationStatusRequest

object
recordIdstringrequired

Unique record ID (maps to transactionID)

Example:546bed32-a8b6-43dc-8772-cefb1d469b1d

correlationIdstringrequired

Correlation ID linking BPM - MPV transaction

Example:468cd184-fb43-4a20-aa8c-23df99c0a353

caseIdstringrequired

Case identifier within BPM

Example:CA0000487609

policyNumberstringrequired

Policy Number associated with the transaction

Example:FM00000001

authorizationStatusstringrequired

Policy Holder Authorization Status

Allowed values:APPROVEDDENIED

Example:APPROVED

actionTakenBystring

Name of Policy Holder

Example:Flora Anderson

actionTimestampstring(date-time)required

Generated at Time

Example:2025-06-02T10:45:00Z

sourcestring

Source system sending the callback

Default:MPV

Example:My Policy View

Example

AuthorizationStatusResponse

object
statusinteger

Example:200

Example

ErrorResponse

object
statusinteger

Example:404

messagestring

Example:Invalid or missing request field: correlationId

Example

PPFAIntegratedDataResponse

object
idstring

Unique identifier

Example:678f1a2b3c4d5e6f7890abcd

planNamestring

Name of the plan

Example:Variable Annuity Premier Growth Plan

policyProductTypeobject

Generic code/displayName object

Show Child Parameters
featureMappingobject

Generic code/displayName object

Show Child Parameters
featureCodestring

Feature code

Example:PARTIAL_WD_001

arrangementTypeobject

Generic code/displayName object

Show Child Parameters
arrangementSubTypeobject

Generic code/displayName object

Show Child Parameters
transactionTypearray[object]

Generic code/displayName object

Show Child Parameters
transactionSubtypesarray[object]

Complete transaction subtype with all arrangement and fund details, enriched with VI 21209 real-time amounts

Show Child Parameters
paymentModeobject

Generic code/displayName object

Show Child Parameters
paymentMethodarray[object]

Generic code/displayName object

Show Child Parameters
fundDisbursementTypearray[object]

Generic code/displayName object

Show Child Parameters
disbursementTypesarray[string]

Applicable disbursement types from VI

Example:Gross, Net

sourceTransferAmtTypearray[object]

Generic code/displayName object

Show Child Parameters
amountQualifierarray[object]

Generic code/displayName object

Show Child Parameters
taxRateBasedOnobject

Generic code/displayName object

Show Child Parameters
taxWithholdingCollectobject

Generic code/displayName object

Show Child Parameters
taxWithholdingPlaceobject

Generic code/displayName object

Show Child Parameters
withholdStateIfFederalIndobject

Generic code/displayName object

Show Child Parameters
taxJurisdictionobject

Generic code/displayName object

Show Child Parameters
taxMinPercentagestring

Minimum tax percentage

Example:0

taxMaxPercentagestring

Maximum tax percentage

Example:100

taxTransferAmtTypestring

Tax transfer amount type

Example:PERCENT

jurisdictionobject

Generic code/displayName object

Show Child Parameters
effectiveDateDurationobject

Effective date duration with min/max values in days

Show Child Parameters
featureMaxNumInstancesnumber

Maximum feature instances

Example:12

minContractAmtnumber

Minimum contract amount

Example:1000

maxNumSourceInvestProdnumber

Maximum source investment products

Example:10

minNumSourceInvestmentsnumber

Minimum source investments

Example:1

featureProductCodeobject

Generic code/displayName object

Show Child Parameters
featureProductInfoarray[object]

Feature product information

actionTypeAllowedarray[object]

Generic code/displayName object

Show Child Parameters
planCodestring

Plan code

Example:534222609

viAmountsobject

VI-derived amount values for withdrawal rule evaluation.
Contains real-time policy values from VI 21209 response.

Show Child Parameters
viFundsarray[object]

VI-derived fund information with withdrawal eligibility

Show Child Parameters
Example

TransactionSubtype

object

Complete transaction subtype with all arrangement and fund details, enriched with VI 21209 real-time amounts

transactionSubtypestring

Transaction subtype name

Example:Partial Withdrawal

transactionSubtypeCodestring

Transaction subtype code

Example:PARTIAL_WD

amountnumber(double)

Amount associated with this transaction subtype from VI 21209 response.
Maps transaction subtypes to their corresponding VI amounts:

  • INTEREST_ONLY → interestOnlyAmount
  • RMD → rmdAmount
  • RIDER_FREE → riderFreeAmount
  • FREE_AVAILABLE → freeAvailableAmount (surrenderValueWithoutMarketValueAdjustment)
  • SURRENDER_FREE_ATD → surrenderFreeAmountATD (freeWithdrawalAmount)
  • SURRENDER/PARTIAL → surrenderValue
    Null if VI data is not available or amount is zero.

Example:5000

minTransactionAmtstring

Minimum transaction amount

Example:100.00

maxTransactionAmtstring

Maximum transaction amount

Example:50000.00

minPercentagestring

Minimum percentage allowed

Example:1

maxPercentagestring

Maximum percentage allowed

Example:100

minRemainingBalanceAmtstring

Minimum remaining balance amount after transaction

Example:500.00

minContractAmtnumber

Minimum contract amount

Example:1000

fundDisbursementTypearray[object]

Generic code/displayName object

Example:{"code":"PRO_RATA","displayName":"Pro Rata"}{"code":"SPECIFIC_FUND","displayName":"Specific Fund"}

Show Child Parameters
sourceTransferAmtTypearray[object]

Generic code/displayName object

Example:{"code":"DOLLAR","displayName":"Dollar Amount"}{"code":"PERCENT","displayName":"Percentage"}{"code":"UNITS","displayName":"Units"}

Show Child Parameters
amountQualifierarray[object]

Generic code/displayName object

Example:{"code":"GROSS","displayName":"Gross"}{"code":"NET","displayName":"Net"}

Show Child Parameters
paymentModeobject

Generic code/displayName object

Show Child Parameters
paymentMethodarray[object]

Generic code/displayName object

Example:{"code":"CHECK","displayName":"Check"}{"code":"EFT","displayName":"Electronic Funds Transfer"}{"code":"WIRE","displayName":"Wire Transfer"}

Show Child Parameters
taxRateBasedOnobject

Generic code/displayName object

Show Child Parameters
taxWithholdingCollectobject

Generic code/displayName object

Show Child Parameters
taxWithholdingPlaceobject

Generic code/displayName object

Show Child Parameters
withholdStateIfFederalIndobject

Generic code/displayName object

Show Child Parameters
taxJurisdictionobject

Generic code/displayName object

Show Child Parameters
taxMinPercentagestring

Minimum tax withholding percentage

Example:0

taxMaxPercentagestring

Maximum tax withholding percentage

Example:100

taxTransferAmtTypestring

Tax transfer amount type

Example:PERCENT

availableCalendarDatestring

Available calendar date

Example:2024-01-01

minDurationnumber

Minimum duration value

Example:1

minDurationQualifierobject

Generic code/displayName object

Show Child Parameters
maxDurationnumber

Maximum duration value

Example:365

maxDurationQualifierobject

Generic code/displayName object

Show Child Parameters
effectiveDateDurationobject

Effective date duration with min/max values in days

Show Child Parameters
jurisdictionEffectiveDatestring

Jurisdiction effective date

Example:2024-01-01

saleEffectiveDatestring

Sale effective date

Example:2024-01-01

saleExpirationDatestring

Sale expiration date

Example:2025-12-31

featureCodestring

Feature code

Example:PARTIAL_WD_001

featureMaxNumInstancesnumber

Maximum number of feature instances

Example:12

featureProductCodeobject

Generic code/displayName object

Show Child Parameters
featureProductInfoarray[object]

Feature product information

maxNumSourceInvestProdnumber

Maximum number of source investment products

Example:10

minNumSourceInvestmentsnumber

Minimum number of source investments

Example:1

actionTypeAllowedarray[object]

Generic code/displayName object

Show Child Parameters
jurisdictionobject

Generic code/displayName object

Show Child Parameters
arrangementTypeobject

Generic code/displayName object

Show Child Parameters
arrangementSubTypeobject

Generic code/displayName object

Show Child Parameters
Example