Search
K
Illustration

Policy State

Represents the state of a policy at an instant in time. Describes the payload Zahara transmits when requesting calculations for a single transaction.

attributesobjectrequired

A collection of uniquely named variables, must be camel-cased.

Show Child Parameters
accountValueobjectrequired

A description of the monetary value of an investment contract

Show Child Parameters
testValueobjectrequired

A simple object that only contains a collection of unique attributes and no further structure.

Show Child Parameters
deathBenefitobjectrequired

A simple object that only contains a collection of unique attributes and no further structure.

Show Child Parameters
coverageValueobjectrequired

A simple object that only contains a collection of unique attributes and no further structure.

Show Child Parameters
coveragesarray[object]required

A benefit conferred to a group of one or more participants

Show Child Parameters
partiesarray[object]requiredunique-items

A unique entity

Show Child Parameters
featuresobjectrequired

Well-known geatures associated with a policy

Show Child Parameters
fundAllocationsarray[object]required

A simple object that only contains a collection of unique attributes and no further structure.

Show Child Parameters
fundsarray[object]required

A source of money

Show Child Parameters
matchSegmentobjectrequired

A simple object that only contains a collection of unique attributes and no further structure.

Show Child Parameters
loanSegmentsarray[object]required

A simple object that only contains a collection of unique attributes and no further structure.

Show Child Parameters
arrangementsarray[object]required

Describes an arbitrary agreement

Show Child Parameters
Example
{
  "attributes": {
    "^[a-z][a-zA-Z0-9]+": {}
  },
  "accountValue": {
    "policyMetrics": {}
  },
  "coverages": [
    {
      "participants": [
        {
          "flatExtra": [
            {}
          ]
        }
      ],
      "fees": [
        {}
      ]
    }
  ],
  "parties": [
    {}
  ],
  "features": {},
  "fundAllocations": [
    {}
  ],
  "funds": [
    {
      "segments": [
        {}
      ]
    }
  ],
  "loanSegments": [
    {}
  ],
  "arrangements": [
    {
      "arrangementSources": [
        {
          "segments": [
            {
              "financialActivity": {}
            }
          ]
        }
      ],
      "type": "LOAN",
      "requestedAmount": "",
      "fees": [
        {}
      ],
      "loanSegments": [
        {}
      ],
      "matchSegment": {},
      "payments": [
        {}
      ],
      "taxWithholdings": [
        {}
      ]
    }
  ]
}

Result

array

The output from a cmputation, which may vary with time

Scenario-Results

object

A grouping of uniquely identifiable results, typically produced under a common set of assumptions

^[a-z][a-zA-Z0-9]+array[string]

The output from a cmputation, which may vary with time

Example
{
  "^[a-z][a-zA-Z0-9]+": [
    "[]"
  ]
}

Multiple-Scenario-Results

object

A grouping of uniquely identifiable scenarios containing their results

Message

object

A structured signal

codeintegerrequired
severitystring

Allowed values:INFOWARNINGERROR

textstringrequired
returnTostring
Example
{
  "code": 0,
  "severity": "INFO",
  "text": "text",
  "returnTo": "returnTo"
}