transactionTypestring
Optional transaction type filter
Allowed values:OneTimeWithdrawalSystematicWithdrawalAssetRebalancing
Example:OneTimeWithdrawal
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
Path Parameters
Query Parameters
application/json
Validation multi agent Transaction
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
Policy Number
Body
application/json
Body
application/json
AgentChangeDto
fromAORstring
From AOR
Example:744760
toAORstring
To AOR
Example:744760
fromAgentIdstring
From agent id
Example:744760
toAgentIdstring
To agent id
Example:744760
policyIdstring
Policy number
Example:FNWL0020303021
caseIdstring
Case id
Example:CA0004789
partyRolestring
Party role
Example:PRIMARYWRITINGAGENT
signaturesarray[object]
Signature details for the agent change
Show Child Parameters
partyUpdatesarray[object]
Party updates list
Show Child Parameters
Response
application/json
Response
application/json
Multi Agent Change Success Response.yaml
TransactionResponse
statusstring
Allowed values:successfailure
errorarray[object]
Show Child Parameters
quoteResponseobject
post/bpm/v1/policies/{planCode}/{policyNumber}/multi-agent/validation
Path Parameters
Body
{}
application/json
Delete TPD party for a policy
delete
Path Parameters
planCodestringrequired
policyNumberstringrequired
Policy Number
partyIdstringrequired
Party ID
Body
application/json
Body
application/json
ThirdPartyDeleteRequest
effectiveDatestring(date)required
Date when the transaction was originally scheduled or expected to happen. It can be a non-business day
Example:2023-01-01
signaturesarray[object]required
Signature details for the agent change
Show Child Parameters
partyobjectrequired
Show Child Parameters
Response
application/json
Response
application/json
Delete TPD Success Response.yaml
TransactionResponse
statusstring
Allowed values:successfailure
errorarray[object]
Show Child Parameters
quoteResponseobject
delete/bpm/v1/policies/{planCode}/{policyNumber}/parties/{partyId}/ThirdPartyDesignee
Path Parameters
Body
{
"effectiveDate": "2023-01-01",
"signatures": [
{}
],
"party": {}
}
application/json
Validation multi agent Transaction
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
Policy Number
Body
application/json
Body
application/json
AgentChangeDto
fromAORstring
From AOR
Example:744760
toAORstring
To AOR
Example:744760
fromAgentIdstring
From agent id
Example:744760
toAgentIdstring
To agent id
Example:744760
policyIdstring
Policy number
Example:FNWL0020303021
caseIdstring
Case id
Example:CA0004789
partyRolestring
Party role
Example:PRIMARYWRITINGAGENT
signaturesarray[object]
Signature details for the agent change
Show Child Parameters
partyUpdatesarray[object]
Party updates list
Show Child Parameters
Response
application/json
Response
application/json
Multi Agent Change Success Response.yaml
TransactionResponse
statusstring
Allowed values:successfailure
errorarray[object]
Show Child Parameters
quoteResponseobject
post/bpm/v1/policies/{planCode}/{policyNumber}/multi-agent/validation
Path Parameters
Body
{}
application/json
Delete TPD party for a policy
delete
Path Parameters
planCodestringrequired
policyNumberstringrequired
Policy Number
partyIdstringrequired
Party ID
Body
application/json
Body
application/json
ThirdPartyDeleteRequest
effectiveDatestring(date)required
Date when the transaction was originally scheduled or expected to happen. It can be a non-business day
Example:2023-01-01
signaturesarray[object]required
Signature details for the agent change
Show Child Parameters
partyobjectrequired
Show Child Parameters
Response
application/json
Response
application/json
Delete TPD Success Response.yaml
TransactionResponse
statusstring
Allowed values:successfailure
errorarray[object]
Show Child Parameters
quoteResponseobject
delete/bpm/v1/policies/{planCode}/{policyNumber}/parties/{partyId}/ThirdPartyDesignee
Path Parameters
Body
{
"effectiveDate": "2023-01-01",
"signatures": [
{}
],
"party": {}
}
application/json