planCodestringrequired
policyNumberstringrequired
Policy Number
Freelook cancellation request
If freelook endDate is less than or equal to policy effective Date, cancel the policy based on the request
post
Path Parameters
Body
application/json
Body
application/json
FreeLookCancellationRequest
correlationIdstring
The unique ID to track transaction request across all systems
Example:657b717b7dcf554abf9ef067
effectiveDatestring(date)required
Date (with pattern “yyyy-mm-dd”)
Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})
transactionAmountsobjectrequired
Show Child Parameters
payeeOrBeneficiaryobject
Show Child Parameters
partiesarray[object]required
Show Child Parameters
reverseInitiatorboolean
Property to isolate source transaction(s) that initiated the reversal
caseIdstring
Zinnia Live Case ID
Example:CA0000007389
Response
application/json
Response
application/json
Success
TransactionAcceptedResponse
correlationIdstring
Unique identifier which used by every system to trace the request
Example:3a2a3435-2089-4b81-9959-e0d569ccf4f0
caseIdstring
Zinnia Live Case ID
Example:CA0000369469
caseStatusstring
Zinnia Live Case Status
Example:IN_PROGRESS
post/bpm/v1/policies/{planCode}/{policyNumber}/freelookcancellation
Path Parameters
Body
{
"effectiveDate": "effectiveDate",
"transactionAmounts": {
"disbursementType": "GROSS",
"disbursementPaymentForm": "DTCC"
},
"parties": [
{
"partyId": "Party_PI_1",
"paymentForm": "DTCC",
"allocationPercentage": 100
}
]
}
application/json
Eligibility Check to Set Delivery Date
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
Body
application/json
Body
application/json
SetDeliveryDateEligibilityRequest
correlationIdstring
Example:864e43a0-2c2f-4a11-9d7f-69ed40115066
taxIdstring
Example:666911019
documentTypestring
Example:POLPG
Response
application/json
Response
application/json
Success
TransactionResponse
statusstring
Allowed values:successfailure
errorarray[object]
Show Child Parameters
quoteResponseobject
post/bpm/v1/policies/{planCode}/{policyNumber}/deliverydatesetup/eligibilitycheck
Path Parameters
Body
{}
application/json
Set Delivery Date Transaction
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
Body
application/json
Body
application/json
SetDeliveryDateRequest
correlationIdstring
Example:864e43a0-2c2f-4a11-9d7f-69ed40115066
taxIdstring
Example:666911019
documentTypestring
Example:POLPG
acknowledgementDatestring(date-time)
reverseInitiatorboolean
Property to isolate source transaction(s) that initiated the reversal
Response
application/json
Response
application/json
Success
TransactionAcceptedResponse
correlationIdstring
Unique identifier which used by every system to trace the request
Example:3a2a3435-2089-4b81-9959-e0d569ccf4f0
caseIdstring
Zinnia Live Case ID
Example:CA0000369469
caseStatusstring
Zinnia Live Case Status
Example:IN_PROGRESS
post/bpm/v1/policies/{planCode}/{policyNumber}/deliverydatesetup
Path Parameters
Body
{}
application/json
EDelivery Enrollment
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
Body
application/json
Body
application/json
idstring
preferenceId (should be null for preference creation)
Example:e22cd4aee27d34c9b7c748d50e558b41
carrierIdstringrequired
carrier id for policy
Example:CARRIERID_1
deliveryOptionstringrequired
Delivery Options - Applicable values EMAIL/FAX/MAIL
Allowed values:EMAILFAXMAIL
Example:EMAIL
emailstring
User’s email
Example:abc.def@gmail.com
effectiveFromstring(date-time)required
Date (with pattern “yyyy-MM-dd’T’HH:mm:ss’Z’”) when the preference will be effective, default value is ‘2999-12-31T00:00:00.000Z’
effectiveTostring(date-time)
Date (with pattern “yyyy-MM-dd’T’HH:mm:ss’Z’”) when the preference will stop being effective
documentTypestringrequired
Type of document
Allowed values:NWBANSTCONFTAXAGNTPOLPG
Example:AGNT
partyIdstringrequired
Unique reference id of the party
Example:f22de4bff27e45d9a7c859e61f668c50
acknowledgedByPartyIdstringrequired
Party that initiated the acknowledgment (i.e. an agent, if not the party referred to by partyId)
Example:f22de4bff27e45d9a7c859e61f668c50
Response
application/json
Response
application/json
Success
TransactionAcceptedResponse
correlationIdstring
Unique identifier which used by every system to trace the request
Example:3a2a3435-2089-4b81-9959-e0d569ccf4f0
caseIdstring
Zinnia Live Case ID
Example:CA0000369469
caseStatusstring
Zinnia Live Case Status
Example:IN_PROGRESS
post/bpm/v1/policies/{planCode}/{policyNumber}/edeliveryenrollment
Path Parameters
Body
{
"carrierId": "CARRIERID_1",
"deliveryOption": "EMAIL",
"effectiveFrom": "effectiveFrom",
"documentType": "AGNT",
"partyId": "f22de4bff27e45d9a7c859e61f668c50",
"acknowledgedByPartyId": "f22de4bff27e45d9a7c859e61f668c50"
}
application/json
Address Change Request
put
Path Parameters
planCodestringrequired
policyNumberstringrequired
Policy Number
partyIdstringrequired
PartyId for which address need to be updated it be avaible under SOR Policy Details
addressIdinteger(int32)required
AddressId for which address need to be updated it be avaible under SOR Policy Details
Body
application/json
Body
application/json
AddressChangeRequest
correlationIdstring
The unique ID to track transaction request across all systems
Example:657b717b7dcf554abf9ef067
preferredAddressIndicatorstringrequired
Indicates whether the address being added should be set as default or not.
Allowed values:TrueFalse
reverseInitiatorboolean
Property to isolate source transaction(s) that initiated the reversal
Default:false
effectiveDatestring(date)required
Date (with pattern “yyyy-mm-dd”)
Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})
addressobjectrequired
Show Child Parameters
caseIdstring
Zinnia Live Case ID
Example:CA0000007389
deleteRequestboolean
Flag for delete or update request. If flag==true then Delete Request else Update Request
Default:false
Response
application/json
Response
application/json
Success
TransactionAcceptedResponse
correlationIdstring
Unique identifier which used by every system to trace the request
Example:3a2a3435-2089-4b81-9959-e0d569ccf4f0
caseIdstring
Zinnia Live Case ID
Example:CA0000369469
caseStatusstring
Zinnia Live Case Status
Example:IN_PROGRESS
put/policy/v1/transactions/{planCode}/{policyNumber}/parties/{partyId}/address/{addressId}
Path Parameters
Body
{
"preferredAddressIndicator": "True",
"effectiveDate": "effectiveDate",
"address": {
"startDate": "startDate",
"addressType": "RESIDENCE",
"addressLine1": "1112 Pickle Street",
"city": "Houston",
"state": "AL",
"zipCode": "66636",
"country": "US"
}
}
application/json