Search
K
Policy Transactions

EligibilityReason

object

Structured reason for a non-passing or indeterminate section.

codestring

Machine-readable reason code.

Example:INSUFFICIENT_PERMISSIONS

messagestring

Human-readable explanation.

Example:Caller does not hold the required permissions for this transaction

Example

RestrictedTransactionResult

object

A transaction affected by a restriction type, with its blocking status.

typestring

Transaction type code.

Example:FullSurrender

statusstring

How the transaction is blocked (e.g. Unavailable, CarrierApprovalNeeded).

Example:Unavailable

Example

EligibilityErrorResponse

object

Error envelope returned by eligibility endpoints on 4xx/5xx responses.

statusinteger

Example:401

errorstring

Example:Unauthorized

messagestring

Example:partyId claim could not be extracted

Example

IdentifierInstance

object

An object representing an identifier and its corresponding value.

identifierstring

The type of identifier.

Allowed values:eAppIdpolicyNumber

valuestring

The value of the identifier.

Example:ABC123349257367

Example

CreateCaseRequest

object
planCodestringrequired

Product code provided by the Zinnia system

Example:ABC001

policyNumberstring

In case of Post Issue Policy Number will be mandatory

Example:EVGL1234567

correlationIdstring

The correlationId associated with the case.

Example:218d8992-3783-42ac-b59a-66cbc36adaab

caseTypestringrequired

The type associated with the case.

Allowed values:ReinstatementNew Business

Example:Reinstatement

caseSubTypestringrequired

The type associated with the case.

Allowed values:ReinstatementLife Application

Example:Reinstatement

identifiersarray[object]required

An object representing an identifier and its corresponding value.

Show Child Parameters
Example