Search
K
Policy Transactions

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:YESNO

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": "YES",
  "effectiveDate": "effectiveDate",
  "address": {
    "startDate": "startDate",
    "addressType": "RESIDENCE",
    "addressLine1": "1112 Pickle Street",
    "city": "Houston",
    "state": "AL",
    "zipCode": "66636",
    "country": "US"
  }
}
{ "preferredAddressIndicator": "YES", "effectiveDate": "effectiveDate", "address": { "startDate": "startDate", "addressType": "RESIDENCE", "addressLine1": "1112 Pickle Street", "city": "Houston", "state": "AL", "zipCode": "66636", "country": "US" } }
  
curl --request POST \
  --url https://dev.api.zinnia.io/policy/v1/transactions///parties//address \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "preferredAddressIndicator": "YES",
  "effectiveDate": "effectiveDate",
  "address": {
    "startDate": "startDate",
    "addressType": "RESIDENCE",
    "addressLine1": "1112 Pickle Street",
    "city": "Houston",
    "state": "AL",
    "zipCode": "66636",
    "country": "US"
  }
}'
application/json
{
  "correlationId": "3a2a3435-2089-4b81-9959-e0d569ccf4f0",
  "caseId": "CA0000369469",
  "caseStatus": "IN_PROGRESS"
}

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"
  }
}
{ "effectiveDate": "effectiveDate", "email": { "startDate": "startDate", "emailType": "PERSONAL", "emailAddress": "will.smith@gmail.com" } }
  
curl --request POST \
  --url https://dev.api.zinnia.io/policy/v1/transactions///parties//emailaddress \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "effectiveDate": "effectiveDate",
  "email": {
    "startDate": "startDate",
    "emailType": "PERSONAL",
    "emailAddress": "will.smith@gmail.com"
  }
}'
application/json
{
  "correlationId": "3a2a3435-2089-4b81-9959-e0d569ccf4f0",
  "caseId": "CA0000369469",
  "caseStatus": "IN_PROGRESS"
}

Email 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

emailIdstringrequired

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

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}/emailaddress/{emailId}

Body

{
  "effectiveDate": "effectiveDate",
  "email": {
    "startDate": "startDate",
    "emailType": "PERSONAL",
    "emailAddress": "will.smith@gmail.com"
  }
}
{ "effectiveDate": "effectiveDate", "email": { "startDate": "startDate", "emailType": "PERSONAL", "emailAddress": "will.smith@gmail.com" } }
  
curl --request PUT \
  --url https://dev.api.zinnia.io/policy/v1/transactions///parties//emailaddress/ \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "effectiveDate": "effectiveDate",
  "email": {
    "startDate": "startDate",
    "emailType": "PERSONAL",
    "emailAddress": "will.smith@gmail.com"
  }
}'
application/json
{
  "correlationId": "3a2a3435-2089-4b81-9959-e0d569ccf4f0",
  "caseId": "CA0000369469",
  "caseStatus": "IN_PROGRESS"
}

Multiple Email 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

Body

application/json

MultipleEmailChangeRequest

correlationIdstring

The unique ID to track transaction request across all systems

Example:91f72a12-db2d-4254-93a8-e4c9c6c98588

caseIdstring

Zinnia Live Case ID

Example:CA0000007389

effectiveDatestring(date)required

Date (with pattern “yyyy-mm-dd”)

Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})

Example:2022-01-01

emailsarray[object]required
Show Child Parameters

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}/emailaddresses

Body

{
  "effectiveDate": "2022-01-01",
  "emails": [
    {
      "startDate": "2022-01-01",
      "emailType": "PERSONAL",
      "emailAddress": "will.smith@gmail.com",
      "preferredEmailIndicator": true
    }
  ]
}
{ "effectiveDate": "2022-01-01", "emails": [ { "startDate": "2022-01-01", "emailType": "PERSONAL", "emailAddress": "will.smith@gmail.com", "preferredEmailIndicator": true } ] }
  
curl --request PUT \
  --url https://dev.api.zinnia.io/policy/v1/transactions///parties//emailaddresses \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "effectiveDate": "2022-01-01",
  "emails": [
    {
      "startDate": "2022-01-01",
      "emailType": "PERSONAL",
      "emailAddress": "will.smith@gmail.com",
      "preferredEmailIndicator": true
    }
  ]
}'
application/json
{
  "correlationId": "3a2a3435-2089-4b81-9959-e0d569ccf4f0",
  "caseId": "CA0000369469",
  "caseStatus": "IN_PROGRESS"
}

Create new Phone Number based on request

post

Path Parameters

planCodestringrequired
policyNumberstringrequired
partyIdstringrequired

Body

application/json

PhoneChangeRequest

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

phoneobjectrequired
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}/parties/{partyId}/phone

Body

{
  "effectiveDate": "effectiveDate",
  "phone": {
    "startDate": "startDate",
    "phoneType": "MOBILE",
    "countryCode": "011",
    "areaCode": "973",
    "dialNumber": "765789"
  }
}
{ "effectiveDate": "effectiveDate", "phone": { "startDate": "startDate", "phoneType": "MOBILE", "countryCode": "011", "areaCode": "973", "dialNumber": "765789" } }
  
curl --request POST \
  --url https://dev.api.zinnia.io/policy/v1/transactions///parties//phone \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "effectiveDate": "effectiveDate",
  "phone": {
    "startDate": "startDate",
    "phoneType": "MOBILE",
    "countryCode": "011",
    "areaCode": "973",
    "dialNumber": "765789"
  }
}'
application/json
{
  "correlationId": "3a2a3435-2089-4b81-9959-e0d569ccf4f0",
  "caseId": "CA0000369469",
  "caseStatus": "IN_PROGRESS"
}