transactionTypestring
Optional transaction type filter
Allowed values:OneTimeWithdrawalSystematicWithdrawalAssetRebalancing
Example:OneTimeWithdrawal
Ref-Data
Ref-Data
Get PPFA Reference Data by Policy
Fetches PPFA integrated reference data filtered by policy. Includes VI restriction filtering for transaction subtypes and disbursement types.
get
Query Parameters
Path Parameters
planCodestringrequired
Plan code
Example:534222609
policyNumberstringrequired
Policy number
Example:959343323
Response
application/json
Response
application/json
Successful response
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
get/bpm/v1/policies/{planCode}/{policyNumber}/refdata
Authentication
Path Parameters
Query Parameters
application/json
Get PPFA Reference Data by Policy
Fetches PPFA integrated reference data filtered by policy. Includes VI restriction filtering for transaction subtypes and disbursement types.
get
Query Parameters
transactionTypestring
Optional transaction type filter
Allowed values:OneTimeWithdrawalSystematicWithdrawalAssetRebalancing
Example:OneTimeWithdrawal
Path Parameters
planCodestringrequired
Plan code
Example:534222609
policyNumberstringrequired
Policy number
Example:959343323
Response
application/json
Response
application/json
Successful response
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
get/policy/v1/transactions/{planCode}/{policyNumber}/refdata
Authentication
Path Parameters
Query Parameters
application/json
Transactions Eligibility
Eligibility evaluation for different operations
Transaction eligibility
Evaluates whether the authenticated user may perform specific transactions on the
given policy. Runs three checks: product level eligibility, user permissions
, and policy restrictions restrictions.
If items is omitted or empty, all transactions configured for the plan are evaluated.
partyId is extracted from the Authorization bearer token — it is never a body field.
post
Path Parameters
planCodestringrequired
Plan code (exact, case-sensitive).
Example:ANN100
policyNumberstringrequired
Policy number (exact, case-sensitive).
Example:POL123456
Body
application/json
Body
application/json
EligibilityRequest
Optional request body shared by all four eligibility endpoints. planCode and policyNumber are supplied as path parameters, not in the body.
itemsarray[string]
Subject identifiers to evaluate. Semantics depend on the endpoint: transaction/cancellation — transaction type codes (e.g. FullSurrender); capabilities — capability codes (e.g. ViewPolicy); restrictions — restriction type codes (e.g. DIVORCE, OVERPAYMENT). When absent or empty, all subjects configured for the plan are evaluated.
Example:FullSurrender, PartialWithdrawalOneTime
Response
application/json
Response
application/json
Eligibility evaluation completed. One result entry per evaluated subject.
EligibilityResponse
Top-level eligibility response envelope. Shared by all four endpoints.
eligibilityTypestringrequired
Echoes the eligibility type evaluated by the endpoint.
Allowed values:transactioncapabilitiesrestrictionscancellationsendFormDocuments
Example:transaction
resultsarray[object]required
Composed eligibility result for a single evaluated subject. Null fields are omitted from the JSON response (@JsonInclude NON_NULL). Three shapes exist: evaluated (sections present), notAvailable (subject absent from product-transactions), or notConfigured (subject absent from transactions-params).
Show Child Parameters
post/policy/v2/transactions/{planCode}/{policyNumber}/eligibility/transaction
Authentication
Path Parameters
Body
{
"items": [
"FullSurrender",
"PartialWithdrawalOneTime"
]
}
application/json