planCodestringrequired
policyNumberstringrequired
partyIdstringrequired
Create new Phone Number based on request
post
Path Parameters
Body
application/json
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
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
Authentication
Path Parameters
Body
{
"effectiveDate": "effectiveDate",
"phone": {
"startDate": "startDate",
"phoneType": "MOBILE",
"countryCode": "011",
"areaCode": "973",
"dialNumber": "765789"
}
}
application/json
Phone Number 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
phoneIdstringrequired
Body
application/json
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
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}/phone/{phoneId}
Authentication
Path Parameters
Body
{
"effectiveDate": "effectiveDate",
"phone": {
"startDate": "startDate",
"phoneType": "MOBILE",
"countryCode": "011",
"areaCode": "973",
"dialNumber": "765789"
}
}
application/json
Multiple Phone Number 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
Body
application/json
MultiplePhoneChangeRequest
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
phonesarray[object]required
Show Child Parameters
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}/phones
Authentication
Path Parameters
Body
{
"effectiveDate": "2022-01-01",
"phones": [
{
"startDate": "2022-01-01",
"phoneType": "MOBILE",
"countryCode": "1",
"dialNumber": "32653, 9134561234",
"preferredPhoneIndicator": true
}
]
}
application/json
Identifier change Request
patch
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
Body
application/json
IdentifierChangeRequest
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
identifiers
Any Ofarrayrequired
Array of identifiers for this party
PassportIdentifierobject
Show Child Parameters
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
patch/policy/v1/transactions/{planCode}/{policyNumber}/parties/{partyId}/identifiers
Authentication
Path Parameters
Body
{
"effectiveDate": "2022-01-01",
"identifiers": [
{}
]
}
application/json
Add new Bank Account based on request
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
partyIdstringrequired
Body
application/json
Body
application/json
BankAccountChangeRequest
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})
bankAccountobjectrequired
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
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}/bankaccount
Authentication
Path Parameters
Body
{
"effectiveDate": "effectiveDate",
"bankAccount": {
"startDate": "startDate",
"nameOnAccount": "abcdqwe",
"accountStatus": "ACTIVEBANKACCOUNT",
"accountType": "CHECKING",
"accountNumber": "34567777745678",
"routingNumber": "Routing_Number",
"branchName": "branch_66"
}
}
application/json