Search
K
Policy Transactions

Eligibility Check Address Transaction

post

Path Parameters

planCodestringrequired
policyNumberstringrequired

Policy Number

Response

application/json

Email Address Success Response

TransactionResponse

statusstring

Allowed values:successfailure

errorarray[object]
Show Child Parameters
quoteResponseobject
post/policy/v1/transactions/{planCode}/{policyNumber}/address/eligibilitycheck
 
application/json

Create new address based on request

post

Path Parameters

planCodestringrequired
policyNumberstringrequired
partyIdstringrequired

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

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/policy/v1/transactions/{planCode}/{policyNumber}/parties/{partyId}/address

Body

{ "preferredAddressIndicator": "True", "effectiveDate": "effectiveDate", "address": { "startDate": "startDate", "addressType": "RESIDENCE", "addressLine1": "1112 Pickle Street", "city": "Houston", "state": "AL", "zipCode": "66636", "country": "US" } }
 
application/json

Add new Email Address based on request

Validates email address change requests for policy parties including ADD, UPDATE, and DELETE operations

post

Query Parameters

operationstringrequired

validate business rule for provided operation

Allowed values:ADDUPDATEDELETE

Example:ADD

bankIdstring

bank id

Example:1

Path Parameters

planCodestringrequired
policyNumberstringrequired
partyIdstringrequired

Body

application/json

EmailChangeRequest

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

emailobjectrequired
Show Child Parameters
caseIdstring

Zinnia Live Case ID

Example:CA00000022023

deleteRequestboolean

Flag for delete or update request. If flag==true then Delete Request else Update Request

Default:false

Response

application/json

Request accepted successfully and is being processed.

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/policy/v1/transactions/{planCode}/{policyNumber}/emailaddress/{partyId}/validation

Body

{ "effectiveDate": "effectiveDate", "email": { "startDate": "startDate", "emailType": "PERSONAL", "emailAddress": "will.smith@gmail.com" } }
 
application/json

Validate Address based on request

Validates address change requests for policy parties including ADD, UPDATE, and DELETE operations

post

Query Parameters

operationstringrequired

validate business rule for provided operation

Allowed values:ADDUPDATEDELETE

Example:ADD

addressIdstring

address Id

Example:1

Path Parameters

planCodestringrequired
policyNumberstringrequired
partyIdstringrequired

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

Request accepted successfully and is being processed.

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/policy/v1/transactions/{planCode}/{policyNumber}/address/{partyId}/validation

Body

{ "preferredAddressIndicator": "True", "effectiveDate": "effectiveDate", "address": { "startDate": "startDate", "addressType": "RESIDENCE", "addressLine1": "1112 Pickle Street", "city": "Houston", "state": "AL", "zipCode": "66636", "country": "US" } }
 
application/json

Create new Emailaddress based on request

post

Path Parameters

planCodestringrequired
policyNumberstringrequired
partyIdstringrequired

Body

application/json

EmailChangeRequest

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

emailobjectrequired
Show Child Parameters
caseIdstring

Zinnia Live Case ID

Example:CA00000022023

deleteRequestboolean

Flag for delete or update request. If flag==true then Delete Request else Update Request

Default:false

Response

application/json

Request accepted successfully and is being processed.

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/policy/v1/transactions/{planCode}/{policyNumber}/parties/{partyId}/emailaddress

Body

{ "effectiveDate": "effectiveDate", "email": { "startDate": "startDate", "emailType": "PERSONAL", "emailAddress": "will.smith@gmail.com" } }
 
application/json